Merge pull request gradle#1345 from gradle/eskatos/repo/cleanup

Cleanup repository keeping samples and samples-tests

Author: eskatos

.github/CONTRIBUTING.md

@@ -1,14 +1,35 @@
 # Contributing to Gradle Kotlin DSL
+
 Thank you for considering making a contribution to Gradle Kotlin DSL! This guide explains how to setup your environment for Gradle Kotlin DSL development and where to get help if you encounter trouble.
 
-## Development Setup
-In order to make changes to Gradle, you'll need:
+## Where is the code?
+
+This repository (`gradle/kotlin-dsl`) contains extra samples for the Gradle Kotlin DSL only. If you intend to contribute an extra sample keep reading.
+
+The Gradle Kotlin DSL code can be found in the [gradle/gradle](https://github.com/gradle/gradle) git repository in the `:kotlinDsl*` sub-projects.
+Please direct your contributions to that repository and see [how to contribute to Gradle](https://github.com/gradle/gradle/blob/master/CONTRIBUTING.md).
+
+## Accept Developer Certificate of Origin
+
+In order for your contributions to be accepted, you must [sign off](https://git-scm.com/docs/git-commit#git-commit---signoff) your Git commits to indicate that you agree to the terms of [Developer Certificate of Origin](https://developercertificate.org/).
+
+## Follow the Code of Conduct
+
+In order to foster a more inclusive community, Gradle has adopted the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
+
+Contributors must follow the Code of Conduct outlined at [https://gradle.org/conduct/](https://gradle.org/conduct/).
+
+## Making Changes
+
+### Development Setup
+
+In order to make changes to the Gradle Kotlin DSL Samples, you'll need:
 
 * A text editor or IDE. We use and recommend the very latest [IntelliJ IDEA CE](http://www.jetbrains.com/idea/).
 * A [Java Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (JDK) version 1.8 or higher
 * [git](https://git-scm.com/) and a [GitHub account](https://github.com/join)
 
-Gradle Kotlin DSL uses a pull request model for contributions. Fork [gradle/kotlin-dsl](https://github.com/gradle/kotlin-dsl) and clone your fork. Active development happens in the `develop` branch, so make sure you check out this branch after cloning the repository. 
+Gradle Kotlin DSL uses a pull request model for contributions. Fork [gradle/kotlin-dsl](https://github.com/gradle/kotlin-dsl) and clone your fork. 
 
 Configure your Git username and email with
 ```
@@ -18,25 +39,19 @@ git config user.email user@example.com
 
 Before importing the project into IntelliJ IDEA make sure to run `./gradlew check` at least once so all required files are generated.
 
-## Making Changes
-
 ### Development Workflow
 
-After making changes, you can test them by running `./gradlew check`.
+Samples are located in the `samples/` directory of this repository.
 
-To try out a change in behavior manually, use the Gradle distribution from `./build/custom`, just make sure to stop all Gradle daemons before using it (`./gradlew --stop`).
+To add a new sample, simply create a new directory under `samples/`. That directory must include a [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html), please copy it from another sample directory.
 
-You can debug Gradle by adding `-Dorg.gradle.debug=true` when executing. Gradle will wait for you to attach at debugger at `localhost:5005` by default.
+A test runs `tasks` on each sample, so your new sample will automatically be smoke-tested. Please consider adding a more precise test.
 
-### Getting Help
+Samples are tested using [gradle/exemplar](https://github.com/gradle/exemplar). If your test can be expressed using [exemplar external samples](https://github.com/gradle/exemplar#configuring-external-samples), add the configuration files to `subprojects/samples-tests/src/exemplar/samples/$yourSampleDir`. Otherwise please add a JUnit based test in `subprojects/samples-tests/src/test/kotlin` extending from `AbstractSampleTest`.
 
-If you run into any trouble, please reach out to us in the #kotlin-dsl channel of the [Gradle Community Slack](https://join.slack.com/t/gradle-community/shared_invite/enQtNDE3MzAwNjkxMzY0LTYwMTk0MWUwN2FiMzIzOWM3MzBjYjMxNWYzMDE1NGIwOTJkMTQ2NDEzOGM2OWIzNmU1ZTk5MjVhYjFhMTI3MmE).
+After making changes, you can test them by running `./gradlew check`.
 
-### Resources
-
-* The [Gradle Kotlin DSL Primer](https://docs.gradle.org/current/userguide/kotlin_dsl.html) is a must read.
-* The Gradle [user manual](https://docs.gradle.org/current/userguide/userguide.html) and [guides](https://gradle.org/guides/) contain Kotlin DSL build script samples that demonstrate how to use all Gradle features.
-* Some [diagrams](../doc/c4) provide a good overview of how the Kotlin DSL is structured and interacts with Gradle, Gradle plugins, IDEs.
+You can debug Gradle by adding `-Dorg.gradle.debug=true` when executing. Gradle will wait for you to attach a debugger at `localhost:5005` by default.
 
 ### Creating Commits And Writing Commit Messages
 
@@ -48,11 +63,21 @@ Please consider reading [How to Write a Git Commit Message](http://chris.beams.i
 * If your commit pertains to a GitHub issue, include (`See #123`) in the commit message on a separate line
 * [Sign off](https://git-scm.com/docs/git-commit#git-commit---signoff) your Git commits to indicate that you agree to the terms of [Developer Certificate of Origin](https://developercertificate.org/).
 
-### Submitting Your Change
+## Submitting Your Change
 
 All code contributions should be submitted via a [pull request](https://help.github.com/articles/using-pull-requests) from a [forked GitHub repository](https://help.github.com/articles/fork-a-repo).
 
 Once received, the pull request will be reviewed by a Gradle Kotlin DSL developer.
 
+## Getting Help
+
+If you run into any trouble, please reach out to us in the #kotlin-dsl channel of the [Gradle Community Slack](https://join.slack.com/t/gradle-community/shared_invite/enQtNDE3MzAwNjkxMzY0LTYwMTk0MWUwN2FiMzIzOWM3MzBjYjMxNWYzMDE1NGIwOTJkMTQ2NDEzOGM2OWIzNmU1ZTk5MjVhYjFhMTI3MmE).
+
+## Resources
+
+* The [Gradle Kotlin DSL Primer](https://docs.gradle.org/current/userguide/kotlin_dsl.html) is a must read.
+* The Gradle [user manual](https://docs.gradle.org/current/userguide/userguide.html) and [guides](https://gradle.org/guides/) contain Kotlin DSL build script samples that demonstrate how to use all Gradle features.
+* Some [diagrams](../doc/c4) provide a good overview of how the Kotlin DSL is structured and interacts with Gradle, Gradle plugins, IDEs.
+
 ## Our Thanks
 We deeply appreciate your effort toward improving Gradle. If you enjoyed this process, perhaps you should consider getting [paid to develop Gradle](https://gradle.com/careers)? 

.gitignore

@@ -1,6 +1,6 @@
 # gradle
 .gradle
-/build
+build
 
 # idea
 .idea

.mrconfig

@@ -7,12 +7,9 @@ matrix:
       jdk: oraclejdk8
     - os: linux
       sudo: required
-      jdk: openjdk8
-    - os: linux
-      sudo: required
-      jdk: oraclejdk9
+      jdk: openjdk11
 
-script: ./gradlew :provider:check --info --stacktrace --console=plain --max-workers=1 --no-daemon -Dkotlin.compiler.execution.strategy="in-process" -Dkotlin.colors.enabled=false
+script: ./gradlew check --info --stacktrace --console=plain --max-workers=1 --no-daemon --build-cache -Dkotlin.colors.enabled=false
 
 before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock

.travis.yml

@@ -1,7 +1,6 @@
 Gradle Kotlin DSL
 =================
 
-[![TeamCity Build](https://builds.gradle.org/app/rest/builds/buildType:GradleKotlinDSL_Develop/statusIcon.svg)](https://builds.gradle.org/viewType.html?buildTypeId=GradleKotlinDSL_Develop)
 [![TravisCI Build](https://img.shields.io/travis/gradle/kotlin-dsl/develop.svg)](https://travis-ci.org/gradle/kotlin-dsl)
 [![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
 

README.md

@@ -1,146 +1,30 @@
-import org.jetbrains.gradle.ext.CopyrightConfiguration
-import org.jetbrains.gradle.ext.ProjectSettings
-import org.jetbrains.gradle.ext.TaskTriggersConfig
-
-import java.time.LocalDate
-
-
-buildscript {
-
-    build.loadExtraPropertiesOf(project)
-
-}
+import org.gradle.internal.hash.HashUtil
 
 plugins {
     base
-    kotlin("jvm") apply false
-    id("org.jetbrains.gradle.plugin.idea-ext") version "0.4.2"
-}
-
-allprojects {
-    group = "org.gradle"
-    version = "1.2.0-SNAPSHOT"
-}
-
-val publishedPluginsVersion by extra { "1.1.3" }
-val futurePluginsVersion = "1.1.4"
-project(":plugins") {
-    group = "org.gradle.kotlin"
-    version = futurePluginsVersion
-}
-
-// --- Configure publications ------------------------------------------
-val distributionProjects =
-    listOf(
-        project(":provider"),
-        project(":provider-plugins"),
-        project(":tooling-models"),
-        project(":tooling-builders"))
-
-// For documentation and meaningful `./gradlew dependencies` output
-val distribution by configurations.creating
-dependencies {
-    distributionProjects.forEach {
-        distribution(it)
-    }
-}
-
-allprojects {
-    repositories {
-        gradlePluginPortal()
-        repositories {
-            maven {
-                name = "kotlinx"
-                url = uri("https://kotlin.bintray.com/kotlinx/")
-            }
-        }
-    }
-}
-
-
-// -- Integration testing ----------------------------------------------
-val prepareIntegrationTestFixtures by tasks.registering(GradleBuild::class) {
-    dir = file("fixtures")
-}
-
-val customInstallationDir = file("$buildDir/custom/gradle-${gradle.gradleVersion}")
-
-val copyCurrentDistro by tasks.registering(Copy::class) {
-    description = "Copies the current Gradle distro into '$customInstallationDir'."
-
-    from(gradle.gradleHomeDir)
-    into(customInstallationDir)
-    exclude("**/*kotlin*")
-
-    // preserve last modified date on each file to make it easier
-    // to check which files were patched by next step
-    val copyDetails = mutableListOf<FileCopyDetails>()
-    eachFile { copyDetails.add(this) }
-    doLast {
-        copyDetails.forEach { details ->
-            File(customInstallationDir, details.path).setLastModified(details.lastModified)
-        }
-    }
-
-    // don't bother recreating it
-    onlyIf { !customInstallationDir.exists() }
-}
-
-val customInstallation by tasks.registering(Copy::class) {
-    description = "Copies latest gradle-kotlin-dsl snapshot over the custom installation."
-    dependsOn(copyCurrentDistro)
-    from(distribution)
-    into("$customInstallationDir/lib")
-}
-
-
-// -- Performance testing ----------------------------------------------
-val benchmark by tasks.registering(integration.Benchmark::class) {
-    excludingSamplesMatching(
-        "android",
-        "source-control"
-    )
-    latestInstallation = customInstallationDir
-    dependsOn(customInstallation)
 }
 
+tasks {
 
-// -- IntelliJ IDEA configuration --------------------------------------
-idea {
-    project {
-        this as ExtensionAware
-        configure<ProjectSettings> {
-            this as ExtensionAware
-            doNotDetectFrameworks("android", "web")
-            configure<TaskTriggersConfig> {
-                // Build the `customInstallation` after the initial import to:
-                // 1. ensure generated code is available to the IDE
-                // 2. allow integration tests to be executed
-                afterSync(customInstallation.get())
+    val samplesWrappers by registering {
+        doLast {
+            val wrapperFiles = wrapper.get().run {
+                listOf(scriptFile, batchScript, jarFile, propertiesFile).associateBy { it.name }
             }
-            configure<CopyrightConfiguration> {
-                useDefault = "ASL2"
-                profiles {
-                    create("ASL2") {
-                        keyword = "Copyright"
-                        notice = """
-                            Copyright ${LocalDate.now().year} the original author or authors.
-
-                            Licensed under the Apache License, Version 2.0 (the "License");
-                            you may not use this file except in compliance with the License.
-                            You may obtain a copy of the License at
-
-                                 http://www.apache.org/licenses/LICENSE-2.0
-
-                            Unless required by applicable law or agreed to in writing, software
-                            distributed under the License is distributed on an "AS IS" BASIS,
-                            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-                            See the License for the specific language governing permissions and
-                            limitations under the License.
-                        """.trimIndent()
+            val hashes = wrapperFiles.mapValues { HashUtil.sha256(it.value) }
+            file("samples").walk().filter { it.isFile && it.name in wrapperFiles }.forEach { sampleWrapperFile ->
+                wrapperFiles.getValue(sampleWrapperFile.name).let { wrapperFile ->
+                    if (HashUtil.sha256(sampleWrapperFile) != hashes.getValue(sampleWrapperFile.name)) {
+                        logger.lifecycle("Updating ${sampleWrapperFile.relativeTo(rootDir)}")
+                        wrapperFile.copyTo(sampleWrapperFile, overwrite = true)
                     }
                 }
             }
         }
     }
+
+    wrapper {
+        distributionType = Wrapper.DistributionType.ALL
+        finalizedBy(samplesWrappers)
+    }
 }