// Copyright (C) 2024 Gradle, Inc.
//
// Licensed under the Creative Commons Attribution-Noncommercial-ShareAlike 4.0 International License.;
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://creativecommons.org/licenses/by-nc-sa/4.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.

[[part1_gradle_init]]
= Part 1: Initializing the Project

Learn the basics of authoring Gradle by first creating a Java app using Gradle init.

****
**In this section, you will:**

- Initialize a Java project
- Review the directory layout
- Run a Java application
- Produce a Build Scan
- Bundle the application in an archive
****

[[part1_begin]]
== Step 0. Before you Begin

1. Make sure you have <<installation.adoc#installation,Gradle installed>>.

2. Install link:https://www.jetbrains.com/idea/download/[IntelliJ IDEA].
The Community Edition is a free version of IntelliJ IDEA.

[[ab_part1_step1]]
== Step 1. Initializing the Project

Create a new directory called `authoring-tutorial` and `cd` into it:

[source,bash]
----
$ mkdir authoring-tutorial
----
[source,bash]
----
$ cd authoring-tutorial
----

Run `gradle init` with parameters to generate a Java application:

[.multi-language-sample]
=====
[source, kotlin]
----
$ gradle init --type java-application  --dsl kotlin
----
=====
[.multi-language-sample]
=====
[source, groovy]
----
$ gradle init --type java-application  --dsl groovy
----
=====

Select defaults for any additional prompts.

NOTE: In this tutorial, all examples are macOS based.

[[ab_part1_step2]]
== Step 2. Understanding the Directory layout

The *project root directory* contains all source files from your project.

When you are done with Gradle `init`, the directory should look as follows:

[.multi-language-sample]
=====
[source, kotlin]
----
.
├── gradle                              // <1>
    ├── libs.versions.toml              // <2>
│   └── wrapper
├── gradlew                             // <3>
├── gradlew.bat                         // <3>
├── settings.gradle.kts                 // <4>
└── app
    ├── build.gradle.kts                // <5>
    └── src
        ├── main
        │   └── java                    // <6>
        │       └── demo
        │           └── App.java
        └── test
            └── java                    // <7>
                └── demo
                    └── AppTest.java
----
<1> Generated folder for wrapper files
<2> Version catalog for dependencies
<3> Gradle wrapper start scripts
<4> Settings file to define build name and subprojects
<5> Build script for `app` subproject
<6> Default Java source folder for `app` subproject
<7> Default Java test source folder for `app` subproject
=====
[.multi-language-sample]
=====
[source, groovy]
----
.
├── gradle                              // <1>
    ├── libs.versions.toml              // <2>
│   └── wrapper
├── gradlew                             // <3>
├── gradlew.bat                         // <3>
├── settings.gradle                     // <4>
└── app
    ├── build.gradle                    // <5>
    └── src
        ├── main
        │   └── java                    // <6>
        │       └── demo
        │           └── App.java
        └── test
            └── java                    // <7>
                └── demo
                    └── AppTest.java
----
<1> Generated folder for wrapper files
<2> Version catalog for dependencies
<3> Gradle wrapper start scripts
<4> Settings file to define build name and subprojects
<5> Build script for `app` subproject
<6> Default Java source folder for `app` subproject
<7> Default Java test source folder for `app` subproject
=====

The `authoring-tutorial` folder is the *root project directory*.
Inside the root project directory are one or more subprojects, build scripts, and the Gradle wrapper.

While the Gradle Wrapper is local to the root project, the Gradle executable is found in the `GRADLE_USER_HOME`.

The `GRADLE_USER_HOME`, which defaults to `USER_HOME/.gradle`, is also where Gradle stores its global configuration properties, initialization scripts, caches, log files and more.

[[ab_part1_step3]]
== Step 3. Review the Gradle Files

The `settings.gradle(.kts)` file has two interesting lines:

[.multi-language-sample]
=====
.settings.gradle.kts
[source, kotlin]
----
rootProject.name = "authoring-tutorial"
include("app")
----
=====
[.multi-language-sample]
=====
.settings.gradle
[source, groovy]
----
rootProject.name = 'authoring-tutorial'
include('app')
----
=====

- `rootProject.name` assigns a name to the build, overriding the default behavior of naming the build after its directory name.
- `include("app")` defines that the build consists of one subproject called `app` that contains its own source code and build logic.

More subprojects can be added by additional `include()` statements.

Our build contains one subproject called `app` representing the Java application we are building.
It is configured in the `app/build.gradle(.kts)` file:

[.multi-language-sample]
=====
.build.gradle.kts
[source, kotlin]
----
plugins {
    id("application")                                               // <1>
}

repositories {
    mavenCentral()                                                  // <2>
}

dependencies {
    testImplementation(libs.junit.jupiter)                          // <3>
    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
    implementation(libs.guava)                                      // <4>
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(11)                // <5>
    }
}

application {
    mainClass = "org.example.App"                                   // <6>
}

tasks.named<Test>("test") {
    useJUnitPlatform()                                              // <7>
}
----
<1> Apply the application plugin to add support for building a CLI application in Java.
<2> Use Maven Central for resolving dependencies.
<3> Use JUnit Jupiter for testing (using the version catalog).
<4> This dependency is used by the application (referred using the version catalog).
<5> Define the toolchain version.
<6> Define the main class for the application.
<7> Use JUnit Platform for unit tests.
=====
[.multi-language-sample]
=====
[source, groovy]
----
plugins {
    id 'application'                                                // <1>
}

repositories {
    mavenCentral()                                                  // <2>
}

dependencies {
    testImplementation libs.junit.jupiter                           // <3>
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
    implementation libs.guava                                       // <4>
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(11)                // <5>
    }
}

application {
    mainClass = 'org.example.App'                                   // <6>
}

tasks.named('test') {
    useJUnitPlatform()                                              // <7>
}
----
<1> Apply the application plugin to add support for building a CLI application in Java.
<2> Use Maven Central for resolving dependencies.
<3> Use JUnit Jupiter for testing (using the version catalog).
<4> This dependency is used by the application (referred using the version catalog).
<5> Define the toolchain version.
<6> Define the main class for the application.
<7> Use JUnit Platform for unit tests.
=====

The build script in the `app` subproject directory declares the dependencies the `app` code will need to be assembled and tested.

[[ab_part1_step4]]
== Step 4. Review the Code

The file `app/src/main/java/authoring/tutorial/App.java` contains the main class of the project:

.App.java
[source, java]
----
package authoring.tutorial;

public class App {
    public String getGreeting() {
        return "Hello World!";
    }

    public static void main(String[] args) {
        System.out.println(new App().getGreeting());
    }
}
----

The code prints out a simple "Hello World" greeting to the screen.

A test class is available at `app/src/test/java/authoring/tutorial/AppTest.java`:

.AppTest.java
[source, java]
----
package authoring.tutorial;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

class AppTest {
    @Test void appHasAGreeting() {
        App classUnderTest = new App();
        assertNotNull(classUnderTest.getGreeting(), "app should have a greeting");
    }
}
----

The generated test class has a single _JUnit Jupiter_ test.
The test instantiates the `App` class, invokes a method on it, and checks that it returns the expected value.

[[ab_part1_step5]]
== Step 5. Run the App

The Application plugin, which was automatically added by `gradle init`, facilitates creating an executable JVM application:

[.multi-language-sample]
=====
[source, kotlin]
----
plugins {
    id("application")
}
----
=====
[.multi-language-sample]
=====
[source, groovy]
----
plugins {
    id 'application'
}
----
=====

Applying the Application plugin implicitly applies the Java plugin and adds tasks like `assemble`, `build`, and `run` to our project.

Thanks to the `application` plugin, you can run the application directly from the command line.
The `run` task tells Gradle to execute the `main` method in the class assigned to the `mainClass` property.

[source,bash]
----
$ ./gradlew run
----
[source,text]
----
> Task :app:run
Hello World!

BUILD SUCCESSFUL in 998ms
2 actionable tasks: 2 executed
----

[[ab_part1_step6]]
== Step 6. Bundle the App

The `application` plugin packages the application, with all its dependencies, for you.
The archive will also contain a script to start the application with a single command.

Run `./gradlew build`:

[source,bash]
----
$ ./gradlew build
----
[source,text]
----
> Task :app:compileJava
> Task :app:processResources NO-SOURCE
> Task :app:classes
> Task :app:jar
> Task :app:startScripts
> Task :app:distTar
> Task :app:distZip
> Task :app:assemble
> Task :app:compileTestJava
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses
> Task :app:test
> Task :app:check
> Task :app:build

BUILD SUCCESSFUL in 5s
----

If you run a full build as shown above, Gradle will have produced the archive in two formats: `app/build/distributions/app.tar` and `app/build/distributions/app.zip`.

[[ab_part1_step6_build_scan]]
== Step 6. Publish a Build Scan

The best way to learn more about what your build is doing behind the scenes is to publish a link:https://scans.gradle.com[Build Scan].
To do so, run the `build` task again with the `--scan` flag.

[source,bash]
----
$ ./gradlew build --scan
----
[source,text]
----
> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:startScripts UP-TO-DATE
> Task :app:distTar UP-TO-DATE
> Task :app:distZip UP-TO-DATE
> Task :app:assemble UP-TO-DATE
> Task :app:compileTestJava UP-TO-DATE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test UP-TO-DATE
> Task :app:check UP-TO-DATE
> Task :app:build UP-TO-DATE

BUILD SUCCESSFUL in 1s
7 actionable tasks: 7 up-to-date
Resolving local hostname is slow, see https://gradle.com/help/gradle-slow-host-name

Publishing a Build Scan to scans.gradle.com requires accepting the Gradle Terms of Service defined at https://gradle.com/terms-of-service. Do you accept these terms? [yes, no] yes

Gradle Terms of Service accepted.

Publishing Build Scan...
https://gradle.com/s/link
----

Click the link and explore which tasks were executed, which dependencies were downloaded, and many more details:

image::build-scan-3.png[]

[.text-right]
**Next Step:** <<part2_build_lifecycle#part2_build_lifecycle,The Build Lifecycle>> >>
