Skip to content

A bunch of improvements to the build init plugin #6489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 51 commits into from
Aug 23, 2018
Merged

A bunch of improvements to the build init plugin #6489

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
2875f4e
Add a kotlin library build init plugin type.
adammurdoch Aug 10, 2018
88c7f63
Flesh out the build init plugin test coverage a little.
adammurdoch Aug 10, 2018
6d25fb4
Add a kotlin application build init plugin type.
adammurdoch Aug 10, 2018
2f618e5
Update release notes and user guide to mention new build init types.
adammurdoch Aug 10, 2018
e2936b8
Move responsibility for generation of the settings script out of each…
adammurdoch Aug 10, 2018
ef4131c
Improve the error messages reported by the build init plugin for unkn…
adammurdoch Aug 11, 2018
50f7ab5
Change build init plugin to generate empty resource directories for J…
adammurdoch Aug 11, 2018
231a070
Remove incubating notice from the build init plugin chapter.
adammurdoch Aug 11, 2018
ed96268
Add a `--project-name` command line option to the `init` task to allo…
adammurdoch Aug 11, 2018
83e2ace
Some tweaks to javadocs and command line option description in the bu…
adammurdoch Aug 11, 2018
d6c8929
Add a `--package` command line option to the `init` task to allow the…
adammurdoch Aug 12, 2018
503d435
Change the `init` task to prompt the user for any build init settings…
adammurdoch Aug 12, 2018
d5fc8b2
Change the user prompt infrastructure to give the user some feedback …
adammurdoch Aug 16, 2018
0f7b9de
Fix merge issue.
adammurdoch Aug 17, 2018
4e77286
Change test class so that it doesn't run each test case using both da…
adammurdoch Aug 17, 2018
8148d3c
Tweak the prompts used by the `init` task.
adammurdoch Aug 17, 2018
c45d93a
Remove unused class.
adammurdoch Aug 17, 2018
ced3c95
Move the 'interactive' flag that is passed from the client to daemon …
adammurdoch Aug 17, 2018
8ef0cdd
Remove usages of `StartParameter.interactive` and deprecate the gette…
adammurdoch Aug 17, 2018
624e2e3
Update release notes to mention new features and deprecation.
adammurdoch Aug 17, 2018
fba12bd
Accept breaking change on `InitBuild` task type.
adammurdoch Aug 18, 2018
c317b11
Do not include a dependency on both kotlin stdlib and kotlin jdk 8 st…
adammurdoch Aug 18, 2018
ce854f7
Tweak prompts and messages for the `init` task.
adammurdoch Aug 18, 2018
ed68485
Some work-arounds to improve the behaviour of the interactive prompts…
adammurdoch Aug 18, 2018
0659c20
Fix running kotlin init tests on Java 7.
adammurdoch Aug 19, 2018
cdff5d9
Fix debug output scraping when a prompt is present.
adammurdoch Aug 19, 2018
8343feb
Change the `init` task to improve the interactive experience when con…
adammurdoch Aug 19, 2018
feca5a1
Do not use an isolated user home dir for build init tests, to avoid d…
adammurdoch Aug 20, 2018
d6979e8
Change the `init` task to default to Kotlin DSL when generating Kotli…
adammurdoch Aug 20, 2018
a6f24e6
Allow the user to be prompted with a yes/no question that has a defau…
adammurdoch Aug 20, 2018
9907165
Improve the `init` task when in interactive mode when a Maven build i…
adammurdoch Aug 20, 2018
b3f888d
Mark test as leaking files.
adammurdoch Aug 20, 2018
2e42305
Refactor the build init infrastructure to distinguish between initial…
adammurdoch Aug 20, 2018
221cf3c
Change the `init` task to generate a simple `.gitignore` file in the …
adammurdoch Aug 20, 2018
2ad5195
Change `init` task so that it uses a default source package name that…
adammurdoch Aug 20, 2018
a30084c
Minor tweak to layout of prompt used to ask user to select an option …
adammurdoch Aug 20, 2018
4e5d574
Change the `init` task to reuse the build script generator infrastruc…
adammurdoch Aug 20, 2018
94cb026
Move some classes around in "build-init" to break package cycle.
adammurdoch Aug 20, 2018
23e7cbc
Change the `init` task to reuse the build script generation infrastru…
adammurdoch Aug 20, 2018
185afb8
Reuse the build script generation infrastructure to generate more of …
adammurdoch Aug 20, 2018
e49a318
Reuse the build script generation infrastructure to generate more of …
adammurdoch Aug 20, 2018
f9f4431
Reuse the build script generation infrastructure to generate more of …
adammurdoch Aug 21, 2018
068cee5
Reuse the build script generation infrastructure to generate more of …
adammurdoch Aug 21, 2018
ba9674a
Reuse the build script generation infrastructure to generate more of …
adammurdoch Aug 21, 2018
ed7080b
Reuse the build script generation infrastructure to generate the depe…
adammurdoch Aug 22, 2018
ac842a0
Fine tune the formatting of the scripts generated by the `init` plugi…
adammurdoch Aug 22, 2018
ece6fc0
The `init` task now uses the build script generation infrastructure t…
adammurdoch Aug 22, 2018
34091a8
Fine tune the `.gitignore` file that the `init` task generates.
adammurdoch Aug 22, 2018
548474b
Update release notes and user guide for changes to the build init plu…
adammurdoch Aug 22, 2018
e657837
Fix integration test on Windows.
adammurdoch Aug 23, 2018
1fa60a0
Fix `@since` Javadoc tags.
adammurdoch Aug 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Flesh out the build init plugin test coverage a little.
  • Loading branch information
@adammurdoch
adammurdoch committed Aug 23, 2018
commit 88c7f63a5cf1c79c163ecfa8f4254d3ed6a1d901
18 changes: 12 additions & 6 deletions ...integTest/groovy/org/gradle/buildinit/plugins/GroovyApplicationInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ class GroovyApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'groovy-application', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-application', '--dsl', scriptDsl.id)

then:
file(SAMPLE_APP_CLASS).exists()
file(SAMPLE_APP_SPOCK_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
assertTestPassed("application has a greeting")

when:
succeeds("run")
run("run")

then:
outputContains("Hello world")
Expand All @@ -54,15 +54,15 @@ class GroovyApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source using spock instead of junit with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'groovy-application', '--test-framework', 'spock', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-application', '--test-framework', 'spock', '--dsl', scriptDsl.id)

then:
file(SAMPLE_APP_CLASS).exists()
file(SAMPLE_APP_SPOCK_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
assertTestPassed("application has a greeting")
Expand Down Expand Up @@ -99,13 +99,19 @@ class GroovyApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
}
"""
when:
succeeds('init', '--type', 'groovy-application', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-application', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_APP_CLASS).exists()
!file(SAMPLE_APP_SPOCK_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down
22 changes: 18 additions & 4 deletions ...src/integTest/groovy/org/gradle/buildinit/plugins/GroovyLibraryInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ class GroovyLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'groovy-library', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-library', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
TestExecutionResult testResult = new DefaultTestExecutionResult(testDirectory)
Expand All @@ -51,13 +51,21 @@ class GroovyLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "supports the Spock test framework with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'groovy-library', '--test-framework', 'spock', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-library', '--test-framework', 'spock', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
TestExecutionResult testResult = new DefaultTestExecutionResult(testDirectory)
testResult.assertTestClassesExecuted("LibraryTest")
testResult.testClass("LibraryTest").assertTestPassed("someLibraryMethod returns true")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand All @@ -78,13 +86,19 @@ class GroovyLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
}
"""
when:
succeeds('init', '--type', 'groovy-library', '--dsl', scriptDsl.id)
run('init', '--type', 'groovy-library', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_LIBRARY_CLASS).exists()
!file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down
24 changes: 15 additions & 9 deletions ...c/integTest/groovy/org/gradle/buildinit/plugins/JavaApplicationInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@ class JavaApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-application', '--dsl', scriptDsl.id)
run('init', '--type', 'java-application', '--dsl', scriptDsl.id)

then:
file(SAMPLE_APP_CLASS).exists()
file(SAMPLE_APP_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
assertTestPassed("testAppHasAGreeting")

when:
succeeds("run")
run("run")

then:
outputContains("Hello world")
Expand All @@ -66,15 +66,15 @@ class JavaApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source using spock instead of junit with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-application', '--test-framework', 'spock', '--dsl', scriptDsl.id)
run('init', '--type', 'java-application', '--test-framework', 'spock', '--dsl', scriptDsl.id)

then:
file(SAMPLE_APP_CLASS).exists()
file(SAMPLE_APP_SPOCK_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
assertTestPassed("application has a greeting")
Expand All @@ -86,15 +86,15 @@ class JavaApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source using testng instead of junit with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-application', '--test-framework', 'testng', '--dsl', scriptDsl.id)
run('init', '--type', 'java-application', '--test-framework', 'testng', '--dsl', scriptDsl.id)

then:
file(SAMPLE_APP_CLASS).exists()
file(SAMPLE_APP_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
assertTestPassed("appHasAGreeting")
Expand All @@ -115,17 +115,23 @@ class JavaApplicationInitIntegrationTest extends AbstractInitIntegrationSpec {
file("src/test/java/org/acme/SampleMainTest.java") << """
package org.acme;

public class SampleMain{
public class SampleMainTest {
}
"""
when:
succeeds('init', '--type', 'java-application', '--dsl', scriptDsl.id)
run('init', '--type', 'java-application', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_APP_CLASS).exists()
!file(SAMPLE_APP_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down
22 changes: 14 additions & 8 deletions ...t/src/integTest/groovy/org/gradle/buildinit/plugins/JavaLibraryInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-library', '--dsl', scriptDsl.id)
run('init', '--type', 'java-library', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
Expand All @@ -43,7 +43,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
buildFileSeparatesImplementationAndApi(dslFixture)

when:
succeeds("build")
run("build")

then:
assertTestPassed("testSomeLibraryMethod")
Expand All @@ -55,7 +55,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source using spock instead of junit with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-library', '--test-framework', 'spock', '--dsl', scriptDsl.id)
run('init', '--type', 'java-library', '--test-framework', 'spock', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
Expand All @@ -67,7 +67,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
buildFileSeparatesImplementationAndApi(dslFixture, 'org.spockframework')

when:
succeeds("build")
run("build")

then:
assertTestPassed("someLibraryMethod returns true")
Expand All @@ -79,7 +79,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source using testng instead of junit with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'java-library', '--test-framework', 'testng', '--dsl', scriptDsl.id)
run('init', '--type', 'java-library', '--test-framework', 'testng', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
Expand All @@ -91,7 +91,7 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
buildFileSeparatesImplementationAndApi(dslFixture, 'org.testng')

when:
succeeds("build")
run("build")

then:
assertTestPassed("someLibraryMethodReturnsTrue")
Expand All @@ -112,11 +112,11 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
file("src/test/java/org/acme/SampleMainTest.java") << """
package org.acme;

public class SampleMain{
public class SampleMainTest {
}
"""
when:
succeeds('init', '--type', 'java-library', '--dsl', scriptDsl.id)
run('init', '--type', 'java-library', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_LIBRARY_CLASS).exists()
Expand All @@ -127,6 +127,12 @@ class JavaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
dslFixture.assertGradleFilesGenerated()
buildFileSeparatesImplementationAndApi(dslFixture)

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down
12 changes: 9 additions & 3 deletions ...src/integTest/groovy/org/gradle/buildinit/plugins/KotlinLibraryInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ class KotlinLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'kotlin-library', '--dsl', scriptDsl.id)
run('init', '--type', 'kotlin-library', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
succeeds("build")
run("build")

then:
TestExecutionResult testResult = new DefaultTestExecutionResult(testDirectory)
Expand All @@ -64,13 +64,19 @@ class KotlinLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
}
"""
when:
succeeds('init', '--type', 'kotlin-library', '--dsl', scriptDsl.id)
run('init', '--type', 'kotlin-library', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_LIBRARY_CLASS).exists()
!file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down
10 changes: 8 additions & 2 deletions .../src/integTest/groovy/org/gradle/buildinit/plugins/ScalaLibraryInitIntegrationTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ScalaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
@Unroll
def "creates sample source if no source present with #scriptDsl build scripts"() {
when:
succeeds('init', '--type', 'scala-library', '--dsl', scriptDsl.id)
run('init', '--type', 'scala-library', '--dsl', scriptDsl.id)

then:
file(SAMPLE_LIBRARY_CLASS).exists()
Expand Down Expand Up @@ -62,13 +62,19 @@ class ScalaLibraryInitIntegrationTest extends AbstractInitIntegrationSpec {
"""

when:
succeeds('init', '--type', 'scala-library', '--dsl', scriptDsl.id)
run('init', '--type', 'scala-library', '--dsl', scriptDsl.id)

then:
!file(SAMPLE_LIBRARY_CLASS).exists()
!file(SAMPLE_LIBRARY_TEST_CLASS).exists()
dslFixtureFor(scriptDsl).assertGradleFilesGenerated()

when:
run("build")

then:
executed(":test")

where:
scriptDsl << ScriptDslFixture.SCRIPT_DSLS
}
Expand Down