Easy Github Docs

Appearance

DevOps Lab Manual ​

Experiment 1 ​

Working with Maven: Creating a Maven Project, Understanding the POM File ​

Steps to Create a Maven Project in IntelliJ IDEA ​

  1. Install Maven (if not already installed):

    • Download Maven from the official website.
    • Set the MAVEN_HOME environment variable and update the system PATH.

  2. Create a New Maven Project:

    • Open IntelliJ IDEA.
    • Go to File > New > Project.
    • Select Maven from the project types.
    • Choose Create from Archetype (optional) or proceed without.
    • Set the project name and location, then click Finish.

  3. Set Up the pom.xml File:

    • The pom.xml file is where you define dependencies, plugins, and other configurations for your Maven project.
    • Example of a basic pom.xml:
xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>simple-project</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!-- Add your dependencies here -->
    </dependencies>
</project>
  1. Add Dependencies for Selenium and TestNG:
    • In the pom.xml, add Selenium andTestNG dependencies under the <dependencies> section.
xml
<dependencies>
    <dependency>
        <groupId>org.seleniumhq.selenium</groupId>
        <artifactId>selenium-java</artifactId>
        <version>3.141.59</version>
    </dependency>
    <dependency>
        <groupId>org.testng</groupId>
        <artifactId>testng</artifactId>
        <version>7.4.0</version>
        <scope>test</scope>
    </dependency>
</dependencies>
  1. Create a Simple Website (HTML, CSS, and Logo):
    • In the src/main/resources folder, create an index.html file, a style.css file, and place the logo.png image.
    • Example of a simple index.html:
html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My Simple Website</title>
    <link rel="stylesheet" href="style.css">
</head>
<body>
    <header>
        <img src="logo.png" alt="Logo">
    </header>
    <h1>Welcome to My Simple Website</h1>
</body>
</html>
  1. Upload the Website to GitHub:
    • Initialize a Git repository in your project folder:
bash
git init
  • Add your files and commit them:
bash
git add .
git commit -m "Initial commit"
  • Create a GitHub repository and push the local project to GitHub:
bash
git remote add origin <your-repository-url>
git push -u origin master

Experiment 2 ​

Installing and Setting Up Gradle in IntelliJ IDEA ​

Creating a Gradle Project in IntelliJ IDEA: ​

Step 1: Open IntelliJ IDEA and Create a New Project

  1. Click on "New Project".
  2. Select "Gradle" (under Java/Kotlin).
  3. Choose Groovy or Kotlin DSL (Domain Specific Language) for the build script.
  4. Set the Group ID (e.g., com.example).
  5. Click Finish.

Step 2: Understanding Project Structure

my-gradle-project
├── build.gradle (Groovy Build Script)
├── settings.gradle
└── src
    ├── main
    │   ├── java
    │   └── resources
    └── test
        ├── java
        └── resources

Build and Run a Simple Java Application: ​

Step 1: Modify build.gradle (Groovy DSL)

groovy
plugins {
    id 'application'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
}

application {
    mainClass = 'com.example.Main'
}

Step 2: Create Main.java in src/main/java/com/example

java
package com.example;

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello from Gradle!");
    }
}

Step 3: Build and Run the Project

  • In IntelliJ IDEA, open the Gradle tool window (View -> Tool Windows -> Gradle).
  • Click Tasks > application > run.
  • Or run from terminal:
bash
gradle run

Hosting a Static Website on GitHub Pages ​

Step 1: Create a /docs Directory

  • Create docs inside the root folder (not in src).
  • Add your HTML, CSS, and images inside /docs.

Step 2: Modify build.gradle to Copy Website Files (This is optional)

groovy
task copyWebsite(type: Copy) {
    from 'src/main/resources/website'
    into 'docs'
}

Step 3: Commit and Push to GitHub

bash
git add .
git commit -m "Deploy website using Gradle"
git push origin main

Step 4: Enable GitHub Pages

  • Go to GitHub Repo -> Settings -> Pages.
  • Select the /docs folder as the source.

Your website will be hosted at:

https://yourusername.github.io/repository-name/

Experiment 3 ​

Working with Gradle: Setting Up a Gradle Project, Understanding Build Scripts ​

Setting Up the Gradle Project: ​

  1. Click on "New Project".
  2. Select "Gradle" (under Java/Kotlin).
  3. Choose Groovy or Kotlin DSL (Domain Specific Language) for the build script.
  4. Set the Group ID (e.g., com.example).
  5. Click Finish.

Understanding Project Structure: ​

my-gradle-project  
├── build.gradle (Groovy Build Script)  
├── settings.gradle  
└── src  
├── main  
│ ├── java  
│ └── resources  
└── test  
├── java  
└── resources

Build and Run a Simple Java Application ​

Step 1: Modify build.gradle (Groovy DSL)

groovy
plugins {
    id 'application'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
}

application {
    mainClass = 'com.example.Main'
}

Step 2: Create Main.java in src/main/java/com/example

java
package com.example;

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello from Gradle!");
    }
}

Step 3: Build and Run the Project

  • In IntelliJ IDEA, open the Gradle tool window (View -> Tool Windows -> Gradle).
  • Click Tasks > application > run.
  • Or run from terminal:
bash
gradle run
Hosting a Static Website on GitHub Pages ​

Step 1: Create a /docs Directory

  • Create docs inside the root folder (not in src).
  • Add your HTML, CSS, and images inside /docs.

Step 2: Modify build.gradle to Copy Website Files (This is optional)

groovy
task copyWebsite(type: Copy) {
    from 'src/main/resources/website'
    into 'docs'
}

Step 3: Commit and Push to GitHub

bash
git add .
git commit -m "Deploy website using Gradle"
git push origin main

Step 4: Enable GitHub Pages

  • Go to GitHub Repo -> Settings -> Pages.
  • Select the /docs folder as the source.

Your website will be hosted at:

https://yourusername.github.io/repository-name/

Experiment 4 ​

Gradle Kotlin DSL: Setting Up & Building a Kotlin Project in IntelliJ IDEA ​

Setting Up the Gradle Project ​

Step 1: Create a New Project

  1. Open IntelliJ IDEA.
  2. Click on File > New > Project.
  3. Select Gradle as the build system.
  4. Choose Kotlin as the language.
  5. Select Gradle Kotlin DSL (it will generate build.gradle.kts).
  6. Name your project (e.g., MVNGRDKOTLINDEMO).
  7. Set the JDK (use JDK 17.0.4, since that's your version).
  8. Click Finish.
Understanding build.gradle.kts ​

After creating the project, the default build.gradle.kts file looks like this:

kotlin
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
    kotlin("jvm") version "1.8.10" // Use latest stable Kotlin version
    application
}

group = "org.example"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib")) // Kotlin Standard Library
    testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")
    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")
}

tasks.test {
    useJUnitPlatform()
}

tasks.withType<KotlinCompile> {
    kotlinOptions.jvmTarget = "17" // Match with your JDK version
}

application {
    mainClass.set("MainKt") // Update this if using a package
}

Creating the Main Kotlin File ​

Now, create your Main.kt file inside src/main/kotlin/. If you're using a package (e.g., org.example), it should look like:

kotlin
package org.example

fun main() {
    println("Hello, Gradle with Kotlin DSL!")
}

If you're not using a package, remove the package line and ensure mainClass.set("MainKt") in build.gradle.kts.

Building and Running the Project ​

Build the Project

bash
./gradlew build

Run the Project

bash
./gradlew run

Packaging as a JAR ​

To run the project without Intellij, we need a JAR file.

  1. Create a Fat (Uber) JAR Modify build.gradle.kts:
kotlin
tasks.register<Jar>("fatJar") {
    archiveClassifier.set("all")
    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
    manifest {
        attributes["Main-Class"] = "MainKt"
    }
    from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) })
    with(tasks.jar.get() as CopySpec)
}
  1. Build the Fat JAR
bash
./gradlew fatJar
  1. Run the Fat JAR
bash
java -jar build/libs/MVNGRDKOTLINDEMO-1.0-SNAPSHOT-all.jar

Experiment 5 ​

Build and Run a Java Application with Maven, Migrate the Same Application to Gradle ​

Create and Build a Java Application with Maven ​

  1. Create a Maven Project in IntelliJ IDEA

    1. Open IntelliJ IDEA
      • Launch IntelliJ IDEA and click on File -> New -> Project.
    2. Select Maven
      • In the New Project window, choose Maven from the options on the left.
      • Check Create from archetype and select maven-archetype-quickstart.
      • Click Next.
    3. Enter Project Details
      • GroupId: com.example
      • ArtifactId: MVNGRDLDEMO
      • Click Next and then Finish.
    4. Wait for IntelliJ to Load Dependencies
      • IntelliJ will automatically download the Maven dependencies, so just relax for a moment.

  2. Update pom.xml to Add Build Plugin To compile and package your project into a .jar file, you need to add the Maven Compiler and Jar plugins.

    1. Open the pom.xml file.
    2. Add the following inside the <project> tag:
xml
<build>
    <plugins>
        <!-- Compiler Plugin -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
        <!-- Jar Plugin -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.2.0</version>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>com.example.App</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>
  1. Build and Run the Maven Project
    1. Open IntelliJ IDEA Terminal: Press Alt + F12 to open the terminal.
    2. Compile and Package the Project: Run the following commands to build the project:
bash
mvn clean compile
mvn package
  1. Locate the JAR File After running the above, your .jar file will be located at:
D:\Idea Projects\MVNGRDLDEMO\target\MVNGRDLDEMO-1.0-SNAPSHOT.jar
  1. Run the JAR File To run the generated JAR file, use:
bash
java -jar target\MVNGRDLDEMO-1.0-SNAPSHOT.jar
Migrate Maven Project to Gradle ​

Step 1: Initialize Gradle in Your Project

  1. Open Terminal in IntelliJ IDEA Make sure you're in the project directory:
bash
cd "D:\Idea Projects\MVNGRDLDEMO"
  1. Run Gradle Init Command Execute the following command to migrate your Maven project to Gradle:
bash
gradle init --type pom

This command will convert your Maven pom.xml into a Gradle build.gradle file.

Step 2: Review and Update build.gradle

  1. Open build.gradle in IntelliJ IDEA.
  2. Ensure the following configurations are correct:
groovy
plugins {
    id 'java'
}

group = 'com.example'
version = '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'junit:junit:4.13.2'
}

jar {
    manifest {
        attributes(
            'Main-Class': 'com.example.App'
        )
    }
}

Step 3: Build and Run the Gradle Project

  1. Clean and Build the Project To clean and build your Gradle project, run:
bash
gradle clean build
  1. Run the Generated JAR File Now, run the generated JAR file using:
bash
java -jar build/libs/MVNGRDLDEMO-1.0-SNAPSHOT.jar