Java Maven sample

examples/java-docker-buildspec-sample/.gitignore

@@ -0,0 +1,3 @@
+.idea
+out
+target

examples/java-docker-buildspec-sample/Dockerfile

@@ -0,0 +1,4 @@
+FROM openjdk:8-alpine
+COPY ./src/com/sample/HelloWorld.class /app/com/sample/HelloWorld.class
+WORKDIR /app
+ENTRYPOINT ["java", "com.sample.HelloWorld"]

examples/java-docker-buildspec-sample/README.md

@@ -0,0 +1,120 @@
+# Build Spec File Example using Java and Docker
+
+This is an example Hello World project using Java SE JDK 11 and Docker. With the [OCI DevOps service](https://www.oracle.com/devops/devops-service/) and this project, you'll be able to build this application, build a Docker image and store it in [OCI Container Registry.](https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryoverview.htm)
+
+In this example, you'll build a container image of this Java Hello World app, and store your built container in the OCI Container Registry,  all using the OCI DevOps service!
+
+Let's go!
+
+## Building the application locally
+
+### Download the repo
+The first step to get started is to download the repository to your local workspace
+
+```shell
+git clone git@github.com:dlcbld/BuildSpecSampleFiles.git
+cd examples/java-docker-buildspec-sample
+```
+
+### Install and run the application
+
+1. Install Java SE SDK 11 on your system: https://java.com/en/download/help/download_options.html
+2. Compile the app: 
+
+   ```javac src/com/sample/HelloWorld.java```
+3. Run the app:
+
+    ```java src/com/sample/HelloWorld```
+4. To verify, make sure the string "Hello World" is printed in the shell.
+
+### Build a container image for the app
+You can locally build a container image using docker (or your favorite container image builder), to verify that you can run the app within a container.
+
+```
+docker build -t hello-world:1.0 .
+```
+
+Verify that your image was built, with `docker images`
+
+Next run your local container and confirm you can access the app running in the container
+```
+docker run --rm -d --name hello-world:latest
+```
+
+The string "Hello World" must be printed in the shell if your container has been built successfully.
+
+## Building the application in OCI DevOps
+Now that you've seen you can locally build this app, let's try this out through OCI DevOps Build service.
+
+### Create External Connection to your Git repository 
+
+1. Create a [DevOps Project](https://docs.oracle.com/en-us/iaas/Content/devops/using/devops_projects.htm) or use and an existing project. 
+2. In your DevOps project, create an External Connection to your GitHub repository which holds your application.
+   - Create a Personal Access Token (PAT): https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
+   - In the OCI Console, Go to Identity & Security -> Vault and create a [Vault]( https://docs.oracle.com/en-us/iaas/Content/KeyManagement/Concepts/keyoverview.htm) in compartment of your own choice.
+   - Create a Master Key that will be used to encrypt the PATs. 
+   - Select Secrets from under Resources and create a secret using PAT obtained from GitHub account.
+   - Make a note of the OCID of the secret.
+   - Now, go to the desired project and select External Connection from the resources.
+   - Select type as GitHub and provide OCID of the secret under Personal Access Token.
+   - Finally, allow BuildPipeline (dynamic group with DevOps Resources) to use a PAT secret by writing a policy in the root compartment as: ``` Allow dynamic-group dg-with-devops-resources to manage secret-family in tenancy```
+
+### Setup your Build Pipeline
+Create a new Build Pipeline to build, test and deliver artifacts from your GitHub Repository.
+
+### Managed Build stage
+In your Build Pipeline, first add a Managed Build stage
+1. The Build Spec File Path is the relative location in your repo of the build_spec.yaml . Leave the default, for this example.
+2. For the Primary Code Repository follow the below steps
+    - Select connection type as GitHub
+    - Select the external connection you created above
+    - Give the HTTPS URL to the repo which contains your application.
+    - Select main branch.
+
+### Create a Container Registry repository
+Create a [Container Registry repository](https://docs.oracle.com/en-us/iaas/Content/Registry/Tasks/registrycreatingarepository.htm) for the `hello-world` container image built in the Managed Build stage.
+1. You can name the repo: `java-docker-buildspec-sample-image`. So if you create the repository in the Ashburn region, the path is iad.ocir.io/TENANCY-NAMESPACE/java-docker-buildspec-sample-image
+2. Set the repository access to private for security reasons. You can add policies to manage access for the same.
+
+
+### Create a DevOps Artifact for your container image repository
+Reference :  https://docs.oracle.com/en-us/iaas/Content/devops/using/containerimage_repository_artifact.htm
+
+The version of the container image that will be delivered to the OCI repository is defined by a [parameter](https://docs.oracle.com/en-us/iaas/Content/devops/using/configuring_parameters.htm) in the Artifact URI that matches a Build Spec exported variable or Build Pipeline parameter name.
+
+Create a DevOps Artifact to point to the Container Registry repository location you just created above. Enter the information for the Artifact location:
+1. Name: `java-docker-buildspec-sample-artifact`
+1. Type: Container image repository
+1. Path: `REGION/TENANCY-OBJECT-STORAGE-NAMESPACE/java-docker-buildspec-sample-image`
+1. Replace parameters: Yes
+
+<img src="./assets/Create DevOps Artifact.png" />
+
+Required policies must be added in the root compartment for the Container Registry repository and DevOps Artifact resource.
+1. Provide access to OCIR to deliver artifacts : ```Allow dynamic-group dg-with-devops-resources to manage repos in tenancy```
+2. Provide access to read deploy artifacts in deliver artifact stage : ```Allow dynamic-group dg-with-devops-resources to manage devops-family in tenancy```
+
+### Add a Deliver Artifacts stage
+Let's add a **Deliver Artifacts** stage to your Build Pipeline to deliver the `java-docker-buildspec-sample` container image to an OCI repository.
+
+The Deliver Artifacts stage **maps** the ouput Artifacts from the Managed Build stage with the version to deliver to OCI Container Registry, through the DevOps Artifact Resource.
+
+Add a **Deliver Artifacts** stage to your Build Pipeline after the **Managed Build** stage. To configure this stage:
+1. In your Deliver Artifacts stage, choose `Select Artifact`
+   <img src="./assets/Final Details in Deliver Artifact Stage.png" />
+1. From the list of artifacts select the `java-docker-buildspec-sample-artifact` artifact that you created above
+   <img src="./assets/Selecting DevOps Artifact resource.png" />
+1. In the next section, you'll assign the  container image outputArtifact from the `build_spec.yaml` to the DevOps project artifact. For the "Build config/result Artifact name" enter: `hello_world_image`
+   <img src="./assets/Final Details in Deliver Artifact Stage.png" />
+
+
+### Run your Build in OCI DevOps
+
+#### From your Build Pipeline, choose `Manual Run`
+Use the Manual Run button to start a Build Run
+
+Manual Run will use the Primary Code Repository, will start the Build Pipeline, first running the Managed Build stage, followed by the Deliver Artifacts stage.
+
+After the Build Pipeline execution is complete, we can view the container image stored in the OCI Container Registry, which can then be pulled to local workspace (Under ```Actions``` , choose ``` Copy Pull Command```).
+
+

examples/java-docker-buildspec-sample/buildSpec.yml

@@ -0,0 +1,33 @@
+version: 0.1
+component: build
+timeoutInSeconds: 20000
+runAs: root
+shell: bash
+steps:
+  - type: Command
+    name: "Build Hello World"
+    timeoutInSeconds: 10000
+    command: |
+      cd src/com/sample/
+      javac HelloWorld.java
+    onFailure:
+      - type: Command
+        command: |
+          echo "Building Hello World failed"
+        timeoutInSeconds: 1000
+        runAs: root
+  - type: Command
+    timeoutInSeconds: 10000
+    name: "Create Docker image"
+    command: |
+      docker build -t hello-world:1.0 .
+    onFailure:
+      - type: Command
+        command: |
+          echo "Creating Docker image failed"
+        timeoutInSeconds: 1000
+        runAs: root
+outputArtifacts:
+  - name: hello_world_image
+    type: DOCKER_IMAGE
+    location: hello-world:1.0

examples/java-docker-buildspec-sample/src/com/sample/HelloWorld.java

@@ -0,0 +1,8 @@
+package com.sample;
+
+public class HelloWorld {
+
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+    }
+}

examples/java-maven/.gitignore

@@ -0,0 +1,35 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+.DS_Store

examples/java-maven/.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present 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
+ *
+ *      https://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.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

examples/java-maven/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.2/apache-maven-3.8.2-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

examples/java-maven/Dockerfile

@@ -0,0 +1,5 @@
+FROM adoptopenjdk/openjdk15
+WORKDIR /
+ADD target/HelloWorld-0.0.1-SNAPSHOT.jar HelloWorld.jar
+EXPOSE 8080
+CMD java - jar HelloWorld.jar