gradle.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Tue, 14 Feb 2017 13:07:46 +0200
changeset 2086 c07317dca036
parent 2083 75ae6a4ad500
child 2094 33c10259cb4d
permissions -rw-r--r--
Run tests.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2078
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
========
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
 Gradle
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
========
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
.. contents::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
   :local:
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
Getting help
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
============
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
  $ gradle --help
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    14
Getting list of subprojects
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    15
===========================
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    16
::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    17
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    18
  $ gradle projects
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    19
2078
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    20
Getting list of supported tasks
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    21
===============================
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    22
::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    23
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    24
  $ gradle tasks
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    25
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    26
Getting list of supported tasks in each subproject::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    27
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    28
  $ gradle tasks --all
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    29
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    30
Getting help on task::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    31
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    32
  $ gradle -q help --task build
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    33
2086
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    34
Similar but to each task::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    35
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    36
  $ gradle model
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    37
2078
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
Build sources
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
=============
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
  $ gradle compileJava
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
  $ gradle compileTestJava
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
Run main class
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
==============
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    49
  $ gradle run
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    50
2086
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    51
Run tests
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    52
=========
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    53
::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    54
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    55
  $ gradle test
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    56
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    57
To run tests with additional registered checks::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    58
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    59
  $ gradle check
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    60
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    61
.. note::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    62
   ``--rerun-tasks`` option *specifies that any task optimization is ignored*.
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    63
   In that way you may rerun tests even if there are no changed files::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    64
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    65
     $ gradle test --rerun-tasks
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    66
2078
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    67
Stopping server
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    68
===============
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    69
::
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    70
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    71
  $ gradle --stop
e7fe6c24cf5f About Gradle.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    72
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    73
List project dependencies
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    74
=========================
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    75
2086
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    76
List of project execution dependencies (it also download dependencies)::
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    77
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    78
  $ gradle dependencies
2086
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    79
  $ gradle dependencies --configuration compile
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    80
  $ gradle dependencies -p $SUBPROJ
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    81
  $ gradle :$SUBPROJ:dependencies
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    82
  $ gradle :$SUBPROJ:dependencies --configuration testCompile
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    83
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    84
List of project plugin dependencies::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    85
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    86
  $ gradle buildEnvironment
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    87
  $ gradle buildEnvironment -p $SUBPROJ
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    88
  $ gradle :$SUBPROJ:buildEnvironment
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
    89
2086
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    90
Paths to dependencies can be printed via task::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    91
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    92
  task printDepPaths {
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    93
    doLast { configurations.runtime.each { println it } }
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    94
  }
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    95
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    96
All dependencies can be copied to single directory via task::
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    97
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    98
  task copyRuntimeLibs(type: Copy) {
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
    99
    into "lib"
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
   100
    from configurations.runtime
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
   101
    // from configurations.testRuntime - configurations.runtime
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
   102
  }
c07317dca036 Run tests.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2083
diff changeset
   103
2083
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   104
List project properties
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   105
=======================
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   106
::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   107
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   108
  $ gradle properties
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   109
  $ gradle :$SUBPROJ:properties
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   110
  $ gradle properties -p $SUBPROJ
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   111
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   112
Dry tun
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   113
=======
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   114
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   115
``-m`` option allow parsing build scripts without actually executing them::
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   116
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   117
  $ gradle -m clean compile
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   118
75ae6a4ad500 Getting list of supported tasks. List project dependencies. List project properties.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 2078
diff changeset
   119