From 7bd61a13686f0a8fd96f5e9367748df521067150 Mon Sep 17 00:00:00 2001 From: dhruv Date: Thu, 11 Jul 2024 20:52:00 +0530 Subject: [PATCH 01/16] added pr and build workflows Signed-off-by: dhruv --- .github/workflows/build.yaml | 44 +++++++++++++++++++++++++++++ .github/workflows/pr-build.yaml | 37 ++++++++++++++++++++++++ galasa-managers-parent/build.gradle | 12 +++++--- 3 files changed, 89 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/build.yaml create mode 100644 .github/workflows/pr-build.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 000000000..ccfb3c037 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,44 @@ +name: Main build + +on: + workflow_dispatch: + pull_request: + branches: [main] + +env: + NAMESPACE: jaydee029 + +jobs: + build-gradle: + name: build and Test Managers + runs-on: ubuntu-latest + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup JDK + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'semeru' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v3 + with: + gradle-version: 6.9.2 + + - name: Build ,Test and Publish Managers + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.GPG_KEY }} + ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} + ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} + run: | + gradle -b galasa-managers-parent/build.gradle check publish --info \ + -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ + -PcentralMaven=https://repo.maven.apache.org/maven2/ \ + -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ \ + -PjacocoEnabled=true \ + -PisMainOrRelease=true + \ No newline at end of file diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml new file mode 100644 index 000000000..f7e03d77a --- /dev/null +++ b/.github/workflows/pr-build.yaml @@ -0,0 +1,37 @@ +name: PR build + +on: + workflow_dispatch: + pull_request: + branches: [main] + +env: + NAMESPACE: jaydee029 + +jobs: + build-gradle: + name: build and Test Managers + runs-on: ubuntu-latest + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup JDK + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'semeru' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v3 + with: + gradle-version: 6.9.2 + + - name: Test and Build Managers + run: | + gradle -b galasa-managers-parent/build.gradle clean build \ + -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ + -PcentralMaven=https://repo.maven.apache.org/maven2/ \ + -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ + \ No newline at end of file diff --git a/galasa-managers-parent/build.gradle b/galasa-managers-parent/build.gradle index 0922eb38c..dc93eaa94 100644 --- a/galasa-managers-parent/build.gradle +++ b/galasa-managers-parent/build.gradle @@ -51,6 +51,10 @@ repositories { } signing { + def signingKeyId = findProperty("signingKeyId") + def signingKey = findProperty("signingKey") + def signingPassword = findProperty("signingPassword") + useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) sign publishing.publications } @@ -74,8 +78,8 @@ if (jacocoEnabled.toBoolean()) { if ("$targetMaven".startsWith('http')) { credentials { - username System.getenv('MAVENUSERNAME') - password System.getenv('MAVENPASSWORD') + username System.getenv("GITHUB_ACTOR") + password System.getenv("GITHUB_TOKEN") } } } @@ -230,8 +234,8 @@ publishing { if ("$targetMaven".startsWith('http')) { credentials { - username System.getenv('MAVENUSERNAME') - password System.getenv('MAVENPASSWORD') + username System.getenv("GITHUB_ACTOR") + password System.getenv("GITHUB_TOKEN") } } } From 489de62ff73026d210f9144dd2ccd1ba4a2b550f Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 13:20:53 +0530 Subject: [PATCH 02/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/build.yaml | 6 ++---- .github/workflows/pr-build.yaml | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ccfb3c037..250bd9688 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -35,10 +35,8 @@ jobs: ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} run: | - gradle -b galasa-managers-parent/build.gradle check publish --info \ + gradle -xmx4096m -b galasa-managers-parent/build.gradle check publish --info \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ - -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ \ - -PjacocoEnabled=true \ - -PisMainOrRelease=true + -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ -PjacocoEnabled=true -PisMainOrRelease=true \ No newline at end of file diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index f7e03d77a..2bb0786ac 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -30,7 +30,7 @@ jobs: - name: Test and Build Managers run: | - gradle -b galasa-managers-parent/build.gradle clean build \ + gradle -xmx4096m -b galasa-managers-parent/build.gradle clean build \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ From cfae3dd6fbe6ee810f72e5217ad98bd3da4db557 Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 13:31:38 +0530 Subject: [PATCH 03/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/build.yaml | 2 +- .github/workflows/pr-build.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 250bd9688..ec2c4212e 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -35,7 +35,7 @@ jobs: ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} run: | - gradle -xmx4096m -b galasa-managers-parent/build.gradle check publish --info \ + gradle -b galasa-managers-parent/build.gradle check publish -Xmx4096m --info \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ -PjacocoEnabled=true -PisMainOrRelease=true diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 2bb0786ac..81337b0fc 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -30,7 +30,7 @@ jobs: - name: Test and Build Managers run: | - gradle -xmx4096m -b galasa-managers-parent/build.gradle clean build \ + gradle -b galasa-managers-parent/build.gradle clean build -Xmx4096m \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ From 43cad3269cf07b221fca737fc1322094dfbecf8e Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 13:42:26 +0530 Subject: [PATCH 04/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/build.yaml | 3 +++ .github/workflows/pr-build.yaml | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ec2c4212e..726721e89 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -27,6 +27,9 @@ jobs: uses: gradle/actions/setup-gradle@v3 with: gradle-version: 6.9.2 + + - name: Set Heap size + run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV - name: Build ,Test and Publish Managers env: diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 81337b0fc..643eec298 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -27,10 +27,12 @@ jobs: uses: gradle/actions/setup-gradle@v3 with: gradle-version: 6.9.2 - + + - name: Set Heap size + run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV - name: Test and Build Managers run: | - gradle -b galasa-managers-parent/build.gradle clean build -Xmx4096m \ + gradle -b galasa-managers-parent/build.gradle clean build -Xmx 4096m \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ From 83298c071b18a8fdba4bb0932918c71c2208f6c3 Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 13:43:50 +0530 Subject: [PATCH 05/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/pr-build.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 643eec298..8cf360d14 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -30,6 +30,7 @@ jobs: - name: Set Heap size run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV + - name: Test and Build Managers run: | gradle -b galasa-managers-parent/build.gradle clean build -Xmx 4096m \ From e7910e845859ea099a1950c71851e5182e099904 Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 13:46:10 +0530 Subject: [PATCH 06/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/build.yaml | 2 +- .github/workflows/pr-build.yaml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 726721e89..664895802 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -38,7 +38,7 @@ jobs: ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} run: | - gradle -b galasa-managers-parent/build.gradle check publish -Xmx4096m --info \ + gradle -b galasa-managers-parent/build.gradle check publish --info \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ -PjacocoEnabled=true -PisMainOrRelease=true diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 8cf360d14..c096bf52b 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -30,10 +30,10 @@ jobs: - name: Set Heap size run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV - + - name: Test and Build Managers run: | - gradle -b galasa-managers-parent/build.gradle clean build -Xmx 4096m \ + gradle -b galasa-managers-parent/build.gradle clean build \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ From 8ccf68bf56fdbb4aaa243dc640c48a25501b911c Mon Sep 17 00:00:00 2001 From: dhruv Date: Mon, 15 Jul 2024 14:05:29 +0530 Subject: [PATCH 07/16] edited build.yaml Signed-off-by: dhruv --- .github/workflows/build.yaml | 4 +--- .github/workflows/pr-build.yaml | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 664895802..c5825bb11 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -27,9 +27,6 @@ jobs: uses: gradle/actions/setup-gradle@v3 with: gradle-version: 6.9.2 - - - name: Set Heap size - run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV - name: Build ,Test and Publish Managers env: @@ -39,6 +36,7 @@ jobs: ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} run: | gradle -b galasa-managers-parent/build.gradle check publish --info \ + -Dorg.gradle.jvmargs=-Xmx4096M \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ -PjacocoEnabled=true -PisMainOrRelease=true diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index c096bf52b..bcc627ff5 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -28,12 +28,10 @@ jobs: with: gradle-version: 6.9.2 - - name: Set Heap size - run: echo "JAVA_OPTS=-Xmx4g" >> $GITHUB_ENV - - name: Test and Build Managers run: | gradle -b galasa-managers-parent/build.gradle clean build \ + -Dorg.gradle.jvmargs=-Xmx4096M \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ From 7d86f58add73f85217023cef1600bf48360e71cf Mon Sep 17 00:00:00 2001 From: Aashir Siddiqui Date: Tue, 23 Jul 2024 11:43:30 +0100 Subject: [PATCH 08/16] Updated comment in root directory's build.gradle file Signed-off-by: Aashir Siddiqui --- galasa-managers-parent/build.gradle | 20 ++++++++++ .../main/java/dev/galasa/cicsts/ICeci.java | 17 ++++---- .../main/java/dev/galasa/cicsts/ICemt.java | 2 +- .../galasa/cicsts/IExecInterfaceBlock.java | 11 +++-- .../cicsts/cicsresource/IJvmserver.java | 11 +++-- .../cloud/internal/CloudManagerImpl.java | 2 +- .../docker/internal/DockerContainerImpl.java | 12 +++--- .../docker/internal/DockerImageImpl.java | 2 +- .../docker/internal/DockerManagerImpl.java | 12 +++--- .../docker/internal/DockerRegistryImpl.java | 11 ++--- .../dev/galasa/http/HttpClientResponse.java | 8 ++-- .../java/dev/galasa/http/IHttpClient.java | 40 +++++++++---------- .../dev/galasa/ipnetwork/ICommandShell.java | 12 +++--- .../galasa/core/manager/ResourceString.java | 4 +- .../core/manager/StoredArtifactRoot.java | 4 +- .../java/dev/galasa/textscan/ILogScanner.java | 30 +++++++------- .../internal/ElasticLogManagerImpl.java | 11 +++-- .../galasaecosystem/IGenericEcosystem.java | 1 - .../dev/galasa/jmeter/IJMeterSession.java | 3 +- .../galasa/sdv/internal/SdvManagerImpl.java | 2 +- .../java/dev/galasa/selenium/IWebPage.java | 1 - .../java/dev/galasa/linux/ILinuxImage.java | 2 +- .../dev/galasa/windows/IWindowsImage.java | 2 +- .../main/java/dev/galasa/zos/IZosImage.java | 12 +++--- .../dev/galasa/zos/spi/IZosManagerSpi.java | 22 +++++----- .../dev/galasa/zosbatch/IZosBatchJob.java | 16 ++++---- .../ZosBatchJobOutputSpoolFileImpl.java | 11 +++-- .../java/dev/galasa/zosfile/IZosDataset.java | 16 ++++---- .../dev/galasa/zosfile/IZosFileHandler.java | 6 +-- .../java/dev/galasa/zosfile/IZosUNIXFile.java | 23 +++++------ .../dev/galasa/zosfile/IZosVSAMDataset.java | 12 +++--- .../dev/galasa/zosfile/spi/IZosFileSpi.java | 6 +-- .../java/dev/galasa/zos3270/ITerminal.java | 3 +- .../galasa/zosliberty/IZosLibertyServer.java | 16 ++++---- .../zosliberty/IZosLibertyServerLog.java | 16 ++++---- .../zosliberty/IZosLibertyServerXml.java | 14 +++---- .../IZosLibertyServerXmlElementList.java | 12 +++--- .../main/java/dev/galasa/zosmf/IZosmf.java | 22 +++++----- .../dev/galasa/zosprogram/ZosProgram.java | 2 +- .../zosprogram/spi/IZosProgramManagerSpi.java | 2 +- .../java/dev/galasa/zosrseapi/IRseapi.java | 29 ++++++++------ .../dev/galasa/zossecurity/IZosSecurity.java | 16 ++++---- .../galasa/zossecurity/KerberosInitiator.java | 14 +++---- .../dev/galasa/zossecurity/ZosUserid.java | 16 ++++---- 44 files changed, 251 insertions(+), 255 deletions(-) diff --git a/galasa-managers-parent/build.gradle b/galasa-managers-parent/build.gradle index 0922eb38c..bf82f749c 100644 --- a/galasa-managers-parent/build.gradle +++ b/galasa-managers-parent/build.gradle @@ -22,6 +22,26 @@ subprojects { plugins.withId('jacoco') { rootProject.tasks.named('jacocoMerge').get().executionData(tasks.named('test').get()) } + + // Uncomment the block below to get details about deprecations. + +// tasks.withType(JavaCompile) { +// options.compilerArgs << '-Xlint:unchecked' +// options.deprecation = true +// } + + // This task will suppress warnings (only in javadoc) about missing description for (@return, @throws etc..) + /* + Example warning: + + warning: no description for @throws + * @throws SeleniumManagerException + */ + // However, it will not suppress warnings / errors in the code itself + tasks.withType(Javadoc) { + options.addStringOption('Xdoclint:none', '-quiet') + } + } // Define the artifact diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICeci.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICeci.java index b31024f55..5eb2643a6 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICeci.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICeci.java @@ -75,8 +75,8 @@ public interface ICeci { * @param parseOutput parse the command output and store in {@link ICeciResponse}. Setting to false can improve performance on commands * that contain a lot of output fields, e.g. ASSIGN.

* The following examples shows how to retrieve a specific returned value:
- * issueCommand(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
- * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&VAR)", false) + * issueCommand(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
+ * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&VAR)", false) * * @return an {@link ICeciResponse} object containing the command's response. * @throws CeciException @@ -239,7 +239,7 @@ public interface ICeci { /** * Retrieve the content of the current EXEC Interface Block (EIB) - * @param terminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session. + * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session. * @return the {@link IExecInterfaceBlock} * @throws CeciException */ @@ -252,7 +252,7 @@ public interface ICeci { * For example, the test could first issue CEOT TRANIDONLY * @param programName the name of the PROGRAM * @param commarea a string representing the COMMAREA. If null, COMMAREA will be omitted from the command. Can be CECI variable name populated with - * (&name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be + * (&)name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be * be allowed to default. * @param sysid the system name where the CICS region where the link request is to be routed. If null, SYSID will be omitted from the command. * @param transid the name of the mirror transaction on the remote region. If null, TRANSID will be omitted from the command. @@ -263,8 +263,8 @@ public interface ICeci { public ICeciResponse linkProgram(@NotNull ICicsTerminal ceciTerminal, @NotNull String programName, String commarea, String sysid, String transid, boolean synconreturn) throws CeciException; /** - * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String)} to create the container(s) on the CHANNEL - * and {@link #getContainer(ICicsTerminal, String, String, String)} to retrieve the content after the LINK. + * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String, String, String, String)} to create the container(s) on the CHANNEL + * and {@link #getContainer(ICicsTerminal, String, String, String, String, String)} to retrieve the content after the LINK. * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session. * If mixed case is required, the terminal should be presented with no upper case translate status. * For example, the test could first issue CEOT TRANIDONLY @@ -279,7 +279,7 @@ public interface ICeci { * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session. * @param channelName the CHANNELNAME * @param containerName the COTAINER name - * @param content a string representing the container contents. Can be CECI variable name populated with (&name set via {@link #defineVariableText(ICicsTerminal, String, String)}) + * @param content a string representing the container contents. Can be CECI variable name populated with (&)name set via {@link #defineVariableText(ICicsTerminal, String, String)}) * or the actual data. The value of FLENGTH in the command will be set to the data length. * @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command. * @param fromCcsid provides a value for FROMCCSID. If null, will be omitted from the command. @@ -296,8 +296,7 @@ public interface ICeci { * For example, the test could first issue CEOT TRANIDONLY * @param channelName the CHANNELNAME * @param containerName the CONTAINER name - * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)} or {@link #retrieveVariableHex(ICicsTerminal, String)} - * @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command. + * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)} * @param intoCcsid provides a value for INTOCCSID. If null, will be omitted from the command. * @param intoCodepage provides a value for INTOCODEPAGE. If null, will be omitted from the command. * @return an {@link ICeciResponse} object containing the command's response. diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java index 2cb9990a8..cdca1d18f 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java @@ -16,7 +16,7 @@ public interface ICemt { /** * Inquire a CEMT resource using the resource type and name. * This does not support inquiries of multiple resources at once. - * Will return {@link null} if the resource is not found. + * Will return null if the resource is not found. * @param cemtTerminal an {@link ITerminal} object logged on to the CICS region and in an active CEMT session. * If mixed case is required, the terminal should be presented with no upper case translate status. * For example, the test could first issue CEOT TRANIDONLY diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java index 9102e2ee6..e30b18096 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.cicsts; /** @@ -51,7 +51,6 @@ public interface IExecInterfaceBlock { /** * Returns the value of the EIBCPOSN field in the EIB. - * @param hex return a char array containing the hex values of the field * @return */ public int getEIBCPOSN(); diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java index b324a94b9..974c5b35b 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.cicsts.cicsresource; import java.util.List; @@ -394,7 +394,6 @@ public enum PurgeType { /** * Delete the JVM server logs - * @param rasPath path in Results Archive Store * @throws CicsJvmserverResourceException */ public void clearJvmLogs() throws CicsJvmserverResourceException; diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java index 9ee52b4f0..5b86405ae 100644 --- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java +++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java @@ -168,7 +168,7 @@ public void provisionGenerate() throws ManagerException, ResourceUnavailableExce * * @param field The test field * @param annotations any annotations with the ecosystem - * @return a {@link IKubernetesEcosystem} ecosystem + * @return a {@link dev.galasa.galasaecosystem.IKubernetesEcosystem} ecosystem * @throws InsufficientResourcesAvailableException * @throws KubernetesManagerException if there is a problem generating a ecosystem */ diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java index bd5571d88..44b29aa58 100644 --- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java +++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerContainerImpl.java @@ -417,7 +417,7 @@ public Map> getExposedPorts() throws DockerManag /** * Retrieves the first open socket ` * - * @param exposed port + * @param exposedPort * @return InetSocketAddress */ @Override @@ -432,7 +432,7 @@ public InetSocketAddress getFirstSocketForExposedPort(String exposedPort) { /** * Retrieves a random open socket * - * @param exposed port + * @param exposedPort * @return InetSocketAddress */ @Override @@ -447,7 +447,7 @@ public InetSocketAddress getRandomSocketForExposedPort(String exposedPort) { /** * Submit exec commands to be executed on the docker container. * - * @param String... commands + * @param command * @return IDockerExec */ @Override @@ -460,7 +460,7 @@ public IDockerExec exec(String... command) throws DockerManagerException { * timeout. * * @param timeout - * @param String... commands + * @param command * @return IDockerExec */ @Override @@ -678,8 +678,8 @@ public void discard() throws DockerManagerException { /** * Allows a file to be stored on a running docker container * - * @param path - * @param InputStream + * @param absolutePath + * @param file */ @Override public void storeFile(String absolutePath, InputStream file) throws DockerManagerException { diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerImageImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerImageImpl.java index cf9ea85c7..82e5c8f43 100644 --- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerImageImpl.java +++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerImageImpl.java @@ -43,7 +43,7 @@ public class DockerImageImpl implements IDockerImage { * @param framework * @param dockerManager * @param dockerEngine - * @param imageName + * @param fullImageName */ public DockerImageImpl(IFramework framework, DockerManagerImpl dockerManager, DockerEngineImpl dockerEngine, String fullImageName) { diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerManagerImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerManagerImpl.java index cf7273976..f164260cd 100644 --- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerManagerImpl.java +++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerManagerImpl.java @@ -71,10 +71,10 @@ public class DockerManagerImpl extends AbstractManager implements IDockerManager * * Docker Environment is generated at this stage * - * @param IFramework - the galasa framework - * @param List - list of all the managers - * @param List - list of all the active managers - * @param Class - the test class + * @param framework - the galasa framework + * @param allManagers - list of all the managers + * @param activeManagers - list of all the active managers + * @throws ManagerException */ @Override @@ -104,8 +104,8 @@ public void initialise(@NotNull IFramework framework, @NotNull List al /** * Makes sure that the docker manager is added to the list of active managers, and adds the dependency on http manager. * - * @param List - list of all the managers - * @param List - list of the active managers + * @param allManagers - list of all the managers + * @param activeManagers - list of the active managers * @throws ManagerException */ @Override diff --git a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerRegistryImpl.java b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerRegistryImpl.java index 86a4bbeb7..f83c21aa8 100644 --- a/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerRegistryImpl.java +++ b/galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.docker.manager/src/main/java/dev/galasa/docker/internal/DockerRegistryImpl.java @@ -65,7 +65,7 @@ public class DockerRegistryImpl { * * @param framework * @param dockerManager - * @param registryUrl + * @param registryId * @throws DockerManagerException */ public DockerRegistryImpl(IFramework framework, DockerManagerImpl dockerManager, String registryId) @@ -95,9 +95,7 @@ public DockerRegistryImpl(IFramework framework, DockerManagerImpl dockerManager, /** * Checks the registry for and image. * - * @param namespace - * @param repository - * @param tag + * @param image * @return true/false */ public boolean doYouHave(DockerImageImpl image) { @@ -130,8 +128,7 @@ public boolean doYouHave(DockerImageImpl image) { /** * Registry authentication * - * @param namespace - * @param repository + * @param image * @throws DockerManagerException */ public void registryAuthenticate(DockerImageImpl image) throws DockerManagerException { @@ -155,7 +152,6 @@ public void registryAuthenticate(DockerImageImpl image) throws DockerManagerExce * Attempts to gain a bearer token from realm, if unauthorized tries basic credentials login * retreive token * - * @param client * @return String token * @throws DockerManagerException */ @@ -191,7 +187,6 @@ public String retrieveBearerToken() throws DockerManagerException { /** * Uses basic crednetials to gain a basic auth token. * - * @param client * @return String token * @throws DockerManagerException */ diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java index c4e4ccf8c..192a4de9d 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java @@ -240,11 +240,11 @@ public static HttpClientResponse textResponse(CloseableHttpResponse http } /** - * Create an {@link HttpClientResponse} with a {@link JSONObject} content type + * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * from an {@link HttpResponse}. * * @param httpResponse - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse) @@ -253,14 +253,14 @@ public static HttpClientResponse jsonResponse(CloseableHttpResponse } /** - * Create an {@link HttpClientResponse} with a {@link JSONObject} content type + * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * from an {@link HttpResponse}. If contentOnBadResponse is true, an attempt * will be made to retrieve the content even on a non 200 status code, otherwise * the content will be null in such an instance. * * @param httpResponse * @param contentOnBadResponse - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse, diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java index 735e64a76..bcd53f1ea 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java @@ -122,54 +122,54 @@ HttpClientResponse postXML(String url, String xml) throws HttpClientException; /** - * Issue an HTTP GET to the provided URL, receiving a {@link JSONObject} in the + * Issue an HTTP GET to the provided URL, receiving a <com.google.gson.JsonObject> in the * response. * * @param url - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse getJson(String url) throws HttpClientException; /** * Issue an HTTP POST to the provided URL, sending the provided - * {@link JSONObject} and receiving a {@link JSONObject} in the response. + * <com.google.gson.JsonObject> and receiving a <com.google.gson.JsonObject> in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse postJson(String url, JsonObject json) throws HttpClientException; /** * Issue an HTTP PUT to the provided URL, sending the provided - * {@link JSONObject} and receiving a {@link JSONObject} in the response. + * com.google.gson.JSONObject and receiving a com.google.gson.JSONObject in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a com.google.gson.JSONObject content type * @throws HttpClientException */ HttpClientResponse putJson(String url, JsonObject json) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a {@link JSONObject} in + * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in * the response. * * @param url - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a {@link JSONObject} in + * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in * the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url, JsonObject json) throws HttpClientException; @@ -222,7 +222,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse putBinary(String url, byte[] binary) throws HttpClientException; @@ -233,7 +233,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse getBinary(String url, byte[] binary) throws HttpClientException; @@ -244,7 +244,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse postBinary(String url, byte[] binary) throws HttpClientException; @@ -255,7 +255,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a {@link JSONObject} content type + * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type * @throws HttpClientException */ HttpClientResponse deleteBinary(String url, byte[] binary) throws HttpClientException; @@ -263,25 +263,23 @@ HttpClientResponse postXML(String url, String xml) /** * Download a file from a specified location to a specified destination on local host. * - * @param Path destination - local location - * @param String path = URL path + * @param path = URL path */ CloseableHttpResponse getFile(String path) throws HttpClientException; /** * Download a file from a specified location to a specified destination on local host. * - * @param Path destination - local location - * @Param Content Types - * @param String path = URL path + * @param acceptTypes + * @param path - URL path */ CloseableHttpResponse getFile(String path, ContentType... acceptTypes) throws HttpClientException; /** * Send a compressed (tar) file from a local location to a specified destination on a host. * - * @param Sting path - URL path - * @param File file - tar archive file + * @param path - URL path + * @param file - tar archive file */ void putFile(String path, InputStream file); diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.ipnetwork.manager/src/main/java/dev/galasa/ipnetwork/ICommandShell.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.ipnetwork.manager/src/main/java/dev/galasa/ipnetwork/ICommandShell.java index b9a9b7679..b3c442d8d 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.ipnetwork.manager/src/main/java/dev/galasa/ipnetwork/ICommandShell.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.ipnetwork.manager/src/main/java/dev/galasa/ipnetwork/ICommandShell.java @@ -10,8 +10,8 @@ public interface ICommandShell { public String issueCommand(String command) throws IpNetworkManagerException; /** - * Issue a command using SSH. Equivalent to {@link #issueCommand(String, false, - * long)} + * Issue a command using SSH. Equivalent to {@link #issueCommand(String, boolean, long)} + * * @param command - command to issue * @param timeout - time (in milliseconds) to wait with no new output appearing @@ -23,7 +23,7 @@ public interface ICommandShell { /** * Issue a command using SSH. Equivalent to - * {@link #issueCommand(String, boolean, defaultTimeout)} + * {@link #issueCommand(String, boolean, long)} * * @param command - command to issue * @param newShell - if true will start a new @@ -61,7 +61,7 @@ public interface ICommandShell { * Issue a command using SSH shell. * * Equivalent to - * {@link #issueCommandToShell(String, false, defaultTimeout)} - not valid for + * {@link #issueCommandToShell(String, boolean, long)} - not valid for * Rexec implementation - equivalent to * {@link #issueCommand(String, long)} for Telnet implementation * @@ -73,7 +73,7 @@ public interface ICommandShell { /** * Issue a command using SSH shell. Equivalent to - * {@link #issueCommandToShell(String, false, long)} - not valid for Rexec + * {@link #issueCommandToShell(String, boolean, long)} - not valid for Rexec * implementation - equivalent to {@link #issueCommand(String, long)} * for Telnet implementation * @@ -85,7 +85,7 @@ public interface ICommandShell { /** * Issue a command using SSH shell. Equivalent to - * {@link #issueCommandToShell(String, boolean, defaultTimeout)} - not valid for + * {@link #issueCommandToShell(String, boolean, long)} - not valid for * Rexec implementation - equivalent to * {@link #issueCommand(String, long)} for Telnet implementation * diff --git a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/ResourceString.java b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/ResourceString.java index dc98d9971..dfca8b648 100644 --- a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/ResourceString.java +++ b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/ResourceString.java @@ -19,7 +19,7 @@ * The CPS property core.resource.string.[length].pattern determines the make up of the random string. *

*

- * Will only populate public {@link java.lang.Stringdev.galasa.core.manager.IResourceString} fields. + * Will only populate public {@link dev.galasa.core.manager.IResourceString} fields. *

* * @author Michael Baylis @@ -37,7 +37,7 @@ * * The tag must be provided as there is no default for this resource. * - * The {@link java.lang.Stringdev.galasa.core.manager.IResourceString} object is keyed on the tag, so if the tag is referred to in multiple + * The {@link dev.galasa.core.manager.IResourceString} object is keyed on the tag, so if the tag is referred to in multiple * super classes, then the lengths must be identical otherwise an exception will be thrown. */ String tag(); diff --git a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java index 90d7294b3..81b656792 100644 --- a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java +++ b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.core.manager/src/main/java/dev/galasa/core/manager/StoredArtifactRoot.java @@ -18,9 +18,9 @@ * Fill this field Root path of the Stored Artifacts for this Test Run. This can * be used to record test logs, job output, trace files etc. * - * Will only populate public {@link java.nio.files.Path} fields. + * Will only populate public {@link java.nio.file.Path} fields. * - * @see java.nio.files.Path + * @see java.nio.file.Path */ @Retention(RUNTIME) @Target(FIELD) diff --git a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java index 981632a97..32e94d4eb 100644 --- a/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java +++ b/galasa-managers-parent/galasa-managers-core-parent/dev.galasa.textscan.manager/src/main/java/dev/galasa/textscan/ILogScanner.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.textscan; import java.util.regex.Pattern; @@ -96,8 +96,8 @@ public interface ILogScanner { /** * Convenience method for scan(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + failString + "\E"), count) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search * @param count at least how many occurrences of the searchText must exist * @return This log scanner for fluent calls * @throws FailTextFoundException If the failText was found @@ -144,7 +144,7 @@ public interface ILogScanner { * * @param searchPattern The regex to search for * @param failPattern Failure regex to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -155,9 +155,9 @@ public interface ILogScanner { /** * Convenience method for scanForMatch(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + searchString + "\E"), occurrence) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -172,7 +172,7 @@ public interface ILogScanner { * * @param searchPattern The regex to search for * @param failPattern Failure regex to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchPattern was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found @@ -183,9 +183,9 @@ public interface ILogScanner { /** * Convenience method for scanForMatchSinceCheckpoint(Pattern.Compile("\Q" + searchString + "\E"), Pattern.Compile("\Q" + searchString + "\E"), occurrence) * - * @param searchText The text to search for - * @param failText Failure text to search for, can be null meaning no fail search - * @param occurrence The occurrence to be returned + * @param searchString The text to search for + * @param failString Failure text to search for, can be null meaning no fail search + * @param occurrance The occurrence to be returned * @return The text of the searchPattern found * @throws MissingTextException The searchString was not found at all * @throws IncorrectOccurrencesException If the specified occurrence was not found diff --git a/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java b/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java index a818d7ea9..73ab1a4ca 100644 --- a/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java +++ b/galasa-managers-parent/galasa-managers-logging-parent/dev.galasa.elasticlog.manager/src/main/java/dev/galasa/elasticlog/internal/ElasticLogManagerImpl.java @@ -71,10 +71,9 @@ public class ElasticLogManagerImpl extends AbstractManager { /** * Initialise the ElasticLogManager, adding a pointer to the other active managers * - * @param IFramework - the galasa framework - * @param List - list of all the managers - * @param List - list of all the active managers - * @param Class - the test class + * @param framework - the galasa framework + * @param allManagers - list of all the managers + * @param activeManagers - list of all the active managers * @throws ManagerException */ @Override @@ -101,8 +100,8 @@ public void initialise(@NotNull IFramework framework, @NotNull List al /** * Makes sure that the elastic log manager is added to the list of active managers, and adds the dependency on http manager. * - * @param List - list of all the managers - * @param List - list of the active managers + * @param allManagers - list of all the managers + * @param activeManagers - list of the active managers * @throws ManagerException */ @Override diff --git a/galasa-managers-parent/galasa-managers-other-parent/dev.galasa.galasaecosystem.manager/src/main/java/dev/galasa/galasaecosystem/IGenericEcosystem.java b/galasa-managers-parent/galasa-managers-other-parent/dev.galasa.galasaecosystem.manager/src/main/java/dev/galasa/galasaecosystem/IGenericEcosystem.java index ebe673f08..bc744e6d0 100644 --- a/galasa-managers-parent/galasa-managers-other-parent/dev.galasa.galasaecosystem.manager/src/main/java/dev/galasa/galasaecosystem/IGenericEcosystem.java +++ b/galasa-managers-parent/galasa-managers-other-parent/dev.galasa.galasaecosystem.manager/src/main/java/dev/galasa/galasaecosystem/IGenericEcosystem.java @@ -34,7 +34,6 @@ public interface IGenericEcosystem { * Retrieve a CPS property from the host ecosystem * * @param namespace The namespace of the CPS - * @param property The property to retrieve * @return the value of the property or null if not found * @throws GalasaEcosystemManagerException if there is a problem accessing the CPS */ diff --git a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java index 05e5985f0..6815c2aa6 100644 --- a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java +++ b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java @@ -60,7 +60,7 @@ public interface IJMeterSession { * JMX-files have to be prepared for this by replacing ALL the $P__VARIABLE notations with $VARIABLE notations * Then by adding neccesary parameters inside a HashMap with it, it is possible to change the target of a test dynamically inside the test * Example: - * HashMap map = new HashMap(); + * HashMap<String,Object> map = new HashMap<String,Object>(); * map.put("HOST", "galasa.dev"); * session.setChangedParametersJmxFile(jmxStream, map); * @param jmxStream @@ -107,7 +107,6 @@ public interface IJMeterSession { /** * Giving jmeter instance a shutdown signal to finish and clean up all running tests - * @param timeout specifying a timeout in milliseconds * @throws JMeterManagerException */ public void stopTest() throws JMeterManagerException; diff --git a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.sdv.manager/src/main/java/dev/galasa/sdv/internal/SdvManagerImpl.java b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.sdv.manager/src/main/java/dev/galasa/sdv/internal/SdvManagerImpl.java index 361173f9b..3f4e73f9c 100644 --- a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.sdv.manager/src/main/java/dev/galasa/sdv/internal/SdvManagerImpl.java +++ b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.sdv.manager/src/main/java/dev/galasa/sdv/internal/SdvManagerImpl.java @@ -60,7 +60,7 @@ * *

It initialises the SDV manager, gathers all required * config, assess which regions to record and what users, and - * intercepts and implements behaviour for test creation & + * intercepts and implements behaviour for test creation and * teardown. * */ diff --git a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.selenium.manager/src/main/java/dev/galasa/selenium/IWebPage.java b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.selenium.manager/src/main/java/dev/galasa/selenium/IWebPage.java index b82c2f873..ab7bc6ebb 100644 --- a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.selenium.manager/src/main/java/dev/galasa/selenium/IWebPage.java +++ b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.selenium.manager/src/main/java/dev/galasa/selenium/IWebPage.java @@ -29,7 +29,6 @@ public interface IWebPage { /** * Clears the Element specified by a Class Name * @param className The Object used to specify the Element - * @param secondsTimeout The wait timeout in seconds * @return The WebPage after the Element is cleared */ public IWebPage clearElementByClassName(String className); diff --git a/galasa-managers-parent/galasa-managers-unix-parent/dev.galasa.linux.manager/src/main/java/dev/galasa/linux/ILinuxImage.java b/galasa-managers-parent/galasa-managers-unix-parent/dev.galasa.linux.manager/src/main/java/dev/galasa/linux/ILinuxImage.java index a77e55ad3..f573f55ed 100644 --- a/galasa-managers-parent/galasa-managers-unix-parent/dev.galasa.linux.manager/src/main/java/dev/galasa/linux/ILinuxImage.java +++ b/galasa-managers-parent/galasa-managers-unix-parent/dev.galasa.linux.manager/src/main/java/dev/galasa/linux/ILinuxImage.java @@ -47,7 +47,7 @@ public interface ILinuxImage { * Retrieve the default credentials for the Image. * * @return The default credentials - see - * {@link dev.galasa.framework.spi.creds.ICredentials} + * {@link dev.galasa.ICredentials} * @throws LinuxManagerException if the credentials are missing or there is a * problem with the credentials store */ diff --git a/galasa-managers-parent/galasa-managers-windows-parent/dev.galasa.windows.manager/src/main/java/dev/galasa/windows/IWindowsImage.java b/galasa-managers-parent/galasa-managers-windows-parent/dev.galasa.windows.manager/src/main/java/dev/galasa/windows/IWindowsImage.java index 3a9f1eb72..395481a36 100644 --- a/galasa-managers-parent/galasa-managers-windows-parent/dev.galasa.windows.manager/src/main/java/dev/galasa/windows/IWindowsImage.java +++ b/galasa-managers-parent/galasa-managers-windows-parent/dev.galasa.windows.manager/src/main/java/dev/galasa/windows/IWindowsImage.java @@ -47,7 +47,7 @@ public interface IWindowsImage { * Retrieve the default credentials for the Image. * * @return The default credentials - see - * {@link dev.galasa.framework.spi.creds.ICredentials} + * {@link dev.galasa.ICredentials} * @throws WindowsManagerException if the credentials are missing or there is a * problem with the credentials store */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/IZosImage.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/IZosImage.java index 91e1354dd..2a0b3177f 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/IZosImage.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/IZosImage.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zos; import java.nio.charset.Charset; @@ -73,7 +73,7 @@ public interface IZosImage { /** * Retrieve the default credentials for the zOS Image. * - * @return The default credentials - see {@link dev.galasa.framework.spi.creds.ICredentials} + * @return The default credentials - see {@link dev.galasa.ICredentials} * @throws ZosManagerException if the credentials are missing or there is a problem with the credentials store */ @NotNull diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/spi/IZosManagerSpi.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/spi/IZosManagerSpi.java index 21247dc0d..33c8ea892 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/spi/IZosManagerSpi.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zos/spi/IZosManagerSpi.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zos.spi; import java.nio.file.Path; @@ -46,7 +46,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Returns a zOS Image for the specified image ID - * @param image the ID of the image + * @param imageId the ID of the image * @return the image, never null * @throws ZosManagerException */ @@ -55,7 +55,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Returns a zOS Image for the specified image that may not have been provisioned so far - * @param image the ID of the image + * @param imageId the ID of the image * @return the image, never null * @throws ZosManagerException if there is no image defined */ @@ -64,7 +64,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Returns the data set HLQ(s) for temporary data sets for the specified image - * @param the image + * @param image * @return the image, never null * @throws ZosManagerException */ @@ -73,7 +73,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Returns the zOS UNIX path prefix for temporary file for the specified image - * @param the image + * @param image * @return the image, never null * @throws ZosManagerException */ @@ -114,7 +114,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Provides other managers a {@link IZosBatchJobname} with a prefix defined by the zOS Batch {@code zosbatch.jobname.[imageid].prefix} property - * @param imageId + * @param image * @return * @throws ZosBatchException */ @@ -162,7 +162,7 @@ public interface IZosManagerSpi extends IZosManager { /** * Store an artifact in the results archive on behalf of another manager - * @param archivePath + * @param artifactPath * @param content * @param type */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java index 08c85efd7..c3ff97eac 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosbatch; /** @@ -92,7 +92,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * The batch job completion return code, e.g.
- * CC 0000, CC 0020, JCL ERROR, ABEND S0C4/code> etc.
+ * <code>CC 0000</code>, <code>CC 0020</code>, <code>JCL ERROR</code>, <code>ABEND S0C4</code> etc.<br> * Returns "????" if the job has not been submitted * * @return @@ -101,7 +101,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * Wait for a job to complete. Return the highest return code for the job. The method will wait for the default - * resource wait time before timing out. Returns {@link Integer.MIN_VALUE} if return code is non numeric. + * resource wait time before timing out. Returns {@link Integer#MIN_VALUE} if return code is non numeric. * Use {@link #getRetcode()} to get the {@link String} value * * @return highest CC @@ -111,7 +111,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * Wait for a job to complete. Return the highest return code for the job. The method will wait for the default - * resource wait time before timing out. Returns {@link Integer.MIN_VALUE} if return code is non numeric. + * resource wait time before timing out. Returns {@link Integer#MIN_VALUE} if return code is non numeric. * Use {@link #getRetcode()} to get the {@link String} value * * @param timeout in seconds diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/internal/ZosBatchJobOutputSpoolFileImpl.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/internal/ZosBatchJobOutputSpoolFileImpl.java index 569c5ee8a..cdab7602e 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/internal/ZosBatchJobOutputSpoolFileImpl.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/internal/ZosBatchJobOutputSpoolFileImpl.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosbatch.internal; import dev.galasa.zosbatch.IZosBatchJob; @@ -27,7 +27,6 @@ public class ZosBatchJobOutputSpoolFileImpl implements IZosBatchJobOutputSpoolFi /** * Constructor for creating spool file - * @param spoolFile * @param records * @param jobname * @param jobid diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosDataset.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosDataset.java index dff4872cf..002233313 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosDataset.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosDataset.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosfile; import java.util.Collection; @@ -376,7 +376,7 @@ public static DatasetDataType valueOfLabel(String label) { * primary and secondary extents to allocate. * * @param spaceUnit - * @param primaryExtent + * @param primaryExtents * @param secondaryExtents */ public void setSpace(SpaceUnit spaceUnit, int primaryExtents, int secondaryExtents); @@ -416,13 +416,13 @@ public static DatasetDataType valueOfLabel(String label) { /** * Set the storage class of the data set - * @param managementClass + * @param storageClass */ public void setStorageClass(String storageClass); /** * Set the data class of the data set - * @param managementClass + * @param dataClass */ public void setDataClass(String dataClass); diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosFileHandler.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosFileHandler.java index 0640a0582..ed183d4da 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosFileHandler.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosFileHandler.java @@ -22,7 +22,7 @@ *

  • IVSAMDataset
    • * * Typical usage would be to instantiate one of these using the newXXX(...) - * methods (e.g.: {@link #newDataset(String)}), then to call methods on that + * methods (e.g.: {@link #newDataset(String, IZosImage)}), then to call methods on that * object to configure it, and then to call methods on this manager to * manipulate it. *

    @@ -57,9 +57,7 @@ public interface IZosFileHandler { /** * Instantiate a new {@link IZosVSAMDataset} object with the given name. The * object returned is a 'blank-slate' and will require configuring before it - * can be defined or stored. See {@link #newESDS(String)}, - * {@link #newKSDS(String)} or {@link #newRRDS(String)} for pre-configured - * VSAM objects. + * can be defined or stored. * * @param dsname * @return diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosUNIXFile.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosUNIXFile.java index 4311590e9..c312d8ffb 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosUNIXFile.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosUNIXFile.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosfile; import java.nio.file.attribute.PosixFilePermission; @@ -125,7 +125,7 @@ public String toString() { /** * Write content to the zOS UNIX file on the zOS image in Binary mode - *

    See {@link #setDataType(DatasetDataType)} + *

    See {@link #setDataType(UNIXFileDataType)} * @param content * @throws ZosUNIXFileException */ @@ -133,14 +133,14 @@ public String toString() { /** * Retrieve the content of the zOS UNIX file from the zOS image in Text mode - *

    See {@link #setDataType(DatasetDataType)} + *

    See {@link #setDataType(UNIXFileDataType)} * @throws ZosUNIXFileException */ public String retrieveAsText() throws ZosUNIXFileException; /** * Retrieve content of the zOS UNIX file from the zOS image in Binary mode - *

    See {@link #setDataType(DatasetDataType)} + *

    See {@link #setDataType(UNIXFileDataType)} * @return data set content * @throws ZosUNIXFileException */ @@ -176,7 +176,7 @@ public String toString() { /** * Set the data type ({@link UNIXFileDataType}) for store and retrieve of the zOS UNIX file content - * @param fileType + * @param dataType */ public void setDataType(UNIXFileDataType dataType); @@ -191,19 +191,16 @@ public String toString() { /** * Return the zOS UNIX file type ({@link UNIXFileType}) - * @param fileType */ public UNIXFileType getFileType(); /** * Return the data type ({@link UNIXFileDataType}) for store and retrieve of the zOS UNIX file content - * @param fileType */ public UNIXFileDataType getDataType(); /** * Return the path of the zOS UNIX file or directory - * @param fileType */ public String getUnixPath(); @@ -263,7 +260,7 @@ public String toString() { public boolean shouldCleanup(); /** - * Convert {@link Set}<{@link PosixFilePermission}> to Symbolic Notation (e.g. rwxwrxrwx) + * Convert {@link Set}<{@link PosixFilePermission}> to Symbolic Notation (e.g. rwxwrxrwx) * @param accessPermissions * @return a {@link String} containing the file permissions in Symbolic Notation */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosVSAMDataset.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosVSAMDataset.java index 327e2c056..638a3d5fe 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosVSAMDataset.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/IZosVSAMDataset.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosfile; import javax.validation.constraints.NotNull; @@ -685,7 +685,7 @@ public enum WriteCheckOption { /** * Get the IDCAMS REPRO command - * @param infile + * @param indatasetName * @return * @throws ZosVSAMDatasetException */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/spi/IZosFileSpi.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/spi/IZosFileSpi.java index 58d67574b..8f7fa9488 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/spi/IZosFileSpi.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosfile/spi/IZosFileSpi.java @@ -10,14 +10,12 @@ import dev.galasa.zosfile.IZosFileHandler; import dev.galasa.zosfile.ZosFileManagerException; -/** - * SPI interface to {@link IZosFile} - */ + public interface IZosFileSpi { /** * Returns a zOS File Handler instance - * @return an {@link IZosFileHandler} implementation instance + * @return an {@link dev.galasa.zosfile.IZosFileHandler} implementation instance */ @NotNull public IZosFileHandler getZosFileHandler() throws ZosFileManagerException; diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos3270.manager/src/main/java/dev/galasa/zos3270/ITerminal.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos3270.manager/src/main/java/dev/galasa/zos3270/ITerminal.java index ae55aa292..5507b07cd 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos3270.manager/src/main/java/dev/galasa/zos3270/ITerminal.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos3270.manager/src/main/java/dev/galasa/zos3270/ITerminal.java @@ -60,7 +60,7 @@ ITerminal positionCursorToFieldContaining(@NotNull String searchText) * The returned boolean will depend on if the amount of occurrences is found. * * @param text - * @param occurances + * @param occurrences * @return if the text was found */ boolean searchText(String text, int occurrences); @@ -271,7 +271,6 @@ ITerminal reportExtendedScreen(boolean printCursor, boolean printColour, boolean * If there are not enough characters on the row to satisfy the length requirement, the retrieve will wrap to the next * row, unless it is the last row, in which case an exception will be thrown. * - * @param length * @param length - The number of characters to extract * @return The contents extracted * @throws Zos3270Exception - If the length causes the extract to overflow the end of the screen buffer diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServer.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServer.java index edf7cad86..ea8cbc58f 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServer.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServer.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosliberty; import java.util.List; @@ -376,11 +376,11 @@ public String toString() { /** * Deploy an application to the Liberty server. This method copies the application archive file to the zOS UNIX file system and * creates an application element in the server.xml. - * @param testClass a {@link class} in the same bundle containing the application archive file, use this.getClass() + * @param testClass a class in the same bundle containing the application archive file, use this.getClass() * @param path the path in the bundle to the application archive file * @param targetLocation the location on the zOS UNIX file system to store the application archive file. If the value is null, * ${shared.app.dir}/fileName will be used - * @param type the application type {@see ApplicationType} + * @param type the application type {@link dev.galasa.zosliberty.IZosLibertyServer.ApplicationType} * @param name the name of the application * @param contextRoot the application context-root. Can be null * @throws ZosLibertyServerException @@ -389,7 +389,7 @@ public String toString() { /** * Deploy an application to the Liberty server dropins directory. This method copies the application archive file to the Liberty server dropins directory - * @param testClass a {@link class} in the same bundle containing the application archive file, use this.getClass() + * @param testClass a class in the same bundle containing the application archive file, use this.getClass() * @param path the path in the bundle to the application archive file * @throws ZosLibertyServerException */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerLog.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerLog.java index 052f4484a..807910245 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerLog.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerLog.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosliberty; import java.io.OutputStream; @@ -137,7 +137,7 @@ public interface IZosLibertyServerLog { *

  • the failText is found;
    • *
  • the specified timeout is reached.
    • * - * @param searchString the text to search + * @param searchText the text to search * @param timeout timeout value in seconds * @return the string found or null * @throws ZosLibertyServerException @@ -151,8 +151,8 @@ public interface IZosLibertyServerLog { *
  • the failText is found;
    • *
  • the specified timeout is reached.
    • * - * @param searchString the text to search - * @param failString the failure text to search + * @param searchText the text to search + * @param failText the failure text to search * @param timeout timeout value in seconds * @return the string found or null * @throws ZosLibertyServerException diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXml.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXml.java index c58cab937..4de563721 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXml.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXml.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosliberty; import java.util.List; @@ -72,7 +72,7 @@ public interface IZosLibertyServerXml { public void store() throws ZosLibertyServerException; /** - * Update the content of the {@link IZosLibertyServerXml) with the content of the server.xml file from the zOS UNIX file system + * Update the content of the {@link IZosLibertyServerXml} with the content of the server.xml file from the zOS UNIX file system * @throws ZosLibertyServerException */ public void loadFromFileSystem() throws ZosLibertyServerException; @@ -177,7 +177,7 @@ public interface IZosLibertyServerXml { /** * Remove all XML elements with specified name and id from the Liberty server.xml Document object * @param elementName the XML element name - * @param elementId the XML element id + * @param id the XML element id * @throws ZosLibertyServerException */ public void removeElementsById(String elementName, String id) throws ZosLibertyServerException; diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java index 36bbf9892..180da00e1 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosliberty; import java.util.Collection; @@ -17,7 +17,7 @@ public interface IZosLibertyServerXmlElementList /** * Put an XML element in the element list * @param elementName - The name of the element to add - * @param attributes - A HashMap of attributes + * @param attributes - A HashMap<String, String> of attributes */ public void add(String elementName, Map attributes); diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosmf.manager/src/main/java/dev/galasa/zosmf/IZosmf.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosmf.manager/src/main/java/dev/galasa/zosmf/IZosmf.java index ea7a7a734..be965eb12 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosmf.manager/src/main/java/dev/galasa/zosmf/IZosmf.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosmf.manager/src/main/java/dev/galasa/zosmf/IZosmf.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosmf; import java.util.List; @@ -134,7 +134,7 @@ public String toString() { * Issue an HTTP PUT request to the zOSMF server with no request body * * @param path identifies the zOSMF REST API - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @param convert is a data conversion required. If true, data will be converted betwen EBCDIC to ISO8859-1. If false, no data conversion will take place. * @return the zOSMF server response * @throws ZosmfException @@ -146,7 +146,7 @@ public String toString() { * * @param path identifies the zOSMF REST API * @param requestBody the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the zOSMF server response * @throws ZosmfException */ @@ -157,7 +157,7 @@ public String toString() { * * @param path identifies the zOSMF REST API * @param requestBody the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the zOSMF server response * @throws ZosmfException */ @@ -168,7 +168,7 @@ public String toString() { * * @param path identifies the zOSMF REST API * @param body the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the zOSMF server response * @throws ZosmfException */ @@ -179,7 +179,7 @@ public String toString() { * * @param path identifies the zOSMF REST API * @param body the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the zOSMF server response * @throws ZosmfException */ @@ -189,7 +189,7 @@ public String toString() { * Issue an HTTP DELETE request to the zOSMF server with no request body * * @param path identifies the zOSMF REST API - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the zOSMF server response * @throws ZosmfException */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java index fe2ccc210..174f3d7f1 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java @@ -96,7 +96,7 @@ public enum Language { */ PL1(".pl1"), /** - * Assembler program with .asm<\code> file extension + * Assembler program with <code>.asm<\code> file extension */ ASSEMBLER(".asm"), /** diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/spi/IZosProgramManagerSpi.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/spi/IZosProgramManagerSpi.java index 27a699410..38770f420 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/spi/IZosProgramManagerSpi.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/spi/IZosProgramManagerSpi.java @@ -22,7 +22,7 @@ public interface IZosProgramManagerSpi { * Returns a new zOS Program * @param image The zOS Image * @param name The program name - * @param programSource The program source in the bundle + * @param source The program source in the bundle * @param language The programming language. See {@link ZosProgram.Language} * @param cics Is a CICS program. * @param loadlib The load module data set name diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosrseapi.manager/src/main/java/dev/galasa/zosrseapi/IRseapi.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosrseapi.manager/src/main/java/dev/galasa/zosrseapi/IRseapi.java index 2bcb7d557..5d4713256 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosrseapi.manager/src/main/java/dev/galasa/zosrseapi/IRseapi.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosrseapi.manager/src/main/java/dev/galasa/zosrseapi/IRseapi.java @@ -1,14 +1,16 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zosrseapi; import java.util.List; import javax.validation.constraints.NotNull; +import java.net.HttpURLConnection; + import org.apache.http.HttpStatus; import com.google.gson.JsonObject; @@ -21,6 +23,8 @@ */ public interface IRseapi { + + /** * Enumeration of RSE API request types */ @@ -79,7 +83,7 @@ public String getRequestType() { * Issue an HTTP PUT request to the RSE API server with no request body * * @param path identifies the RSE API REST API server - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @param convert is a data conversion required. If true, data will be converted betwen EBCDIC to ISO8859-1. If false, no data conversion will take place. * @return the RSE API server response * @throws RseapiException @@ -91,7 +95,7 @@ public String getRequestType() { * * @param path identifies the RSE API REST API server * @param body the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ @@ -102,7 +106,7 @@ public String getRequestType() { * * @param path identifies the RSE API REST API server * @param body the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ @@ -113,7 +117,7 @@ public String getRequestType() { * * @param path identifies the RSE API REST API server * @param body the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ @@ -123,8 +127,7 @@ public String getRequestType() { * Issue an HTTP POST request to the RSE API server with no request body * * @param path identifies the RSE API REST API server - * @param requestBody the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ @@ -135,7 +138,7 @@ public String getRequestType() { * * @param path identifies the RSE API REST API server * @param requestBody the request body - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ @@ -145,7 +148,7 @@ public String getRequestType() { * Issue an HTTP DELETE request to the RSE API server with no request body * * @param path identifies the RSE API REST API server - * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus.HttpStatus.SC_OK} when null + * @param validStatusCodes a {@link List} of acceptable HTTP Status codes. Default to {@link HttpStatus#SC_OK} when null * @return the RSE API server response * @throws RseapiException */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/IZosSecurity.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/IZosSecurity.java index 8639c4d3e..626e94fb0 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/IZosSecurity.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/IZosSecurity.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zossecurity; import java.security.KeyStore; @@ -86,7 +86,6 @@ public interface IZosSecurity { /** * Create a new profile on the specified image/sysplex. * @param className - * @param image - The image/sysplex * @param name - The name of the profiles * @param uacc - The uacc to assign, or null * @param refresh - issue SETROPTS REFRESH @@ -521,7 +520,7 @@ public KeyStore generateSelfSignedCertificate(String alias, String distinguished /** * Create a Kerberos client principal. This will create the kerbname and the * required association with the passed in service principal (see - * {@link #createKerberosPrincipal(IZosUserid, IZosImage, String)} fr the passed + * {@link #createKerberosPrincipal(IZosUserid, String)} fr the passed * userid. * * @param servicePrincipal - service principal with which to associate this @@ -538,7 +537,8 @@ public KeyStore generateSelfSignedCertificate(String alias, String distinguished * * @param serviceUserid - zOS Userid for this principal * @param realm - realm to use, see - * {@link #getDefaultKerberosRealm(IZosImage)} + * {@link #getDefaultKerberosRealm()} + * * @return * @throws ZosSecurityManagerException */ diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/KerberosInitiator.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/KerberosInitiator.java index 4425f00ee..d8bddff33 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/KerberosInitiator.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/KerberosInitiator.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zossecurity; import jakarta.xml.bind.DatatypeConverter; @@ -20,9 +20,6 @@ * {@link #create()} to create the security context. {@link #initiate()} will * then be called, (and potentially {@link #initiate(KerberosToken)} if further * initiation is required). - * - * @author James Bartlett - * */ public class KerberosInitiator { @@ -42,7 +39,6 @@ public class KerberosInitiator { /** * Construct with service client and kdc * - * @param logRepo * @param service * @param client * @param kdc diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/ZosUserid.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/ZosUserid.java index daa0f02b8..0b0f9564b 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/ZosUserid.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zossecurity.manager/src/main/java/dev/galasa/zossecurity/ZosUserid.java @@ -1,8 +1,8 @@ -/* - * Copyright contributors to the Galasa project - * - * SPDX-License-Identifier: EPL-2.0 - */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ package dev.galasa.zossecurity; import java.lang.annotation.ElementType; @@ -17,7 +17,7 @@ * Requests a zOS Userid. Will not have any groups attached, a default password * set, no passphrase and no access to any resources. * - * @author Michael Baylis + * */ @Retention(RetentionPolicy.RUNTIME) @@ -46,8 +46,8 @@ public boolean runUser() default false; /** - * Set tag of {@link EnsZosClient} where user will be created. - * + + * @see #ensZosClient() * @return - the set symbolic */ public String ensZosClient() default ""; From 2fc79cd1fa1bbb33f1ea1e43ecfc8ab69012bcb5 Mon Sep 17 00:00:00 2001 From: Aashir Siddiqui Date: Tue, 23 Jul 2024 15:18:40 +0100 Subject: [PATCH 09/16] Changes made as requested Issue #1249 Signed-off-by: Aashir Siddiqui --- .../main/java/dev/galasa/cicsts/ICemt.java | 2 +- .../galasa/cicsts/IExecInterfaceBlock.java | 119 +++++++++--------- .../dev/galasa/http/HttpClientResponse.java | 8 +- .../java/dev/galasa/http/IHttpClient.java | 28 ++--- .../dev/galasa/jmeter/IJMeterSession.java | 8 +- .../dev/galasa/zosbatch/IZosBatchJob.java | 6 +- .../IZosLibertyServerXmlElementList.java | 2 +- .../dev/galasa/zosprogram/ZosProgram.java | 8 +- 8 files changed, 91 insertions(+), 90 deletions(-) diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java index cdca1d18f..2dbf3646d 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java @@ -16,7 +16,7 @@ public interface ICemt { /** * Inquire a CEMT resource using the resource type and name. * This does not support inquiries of multiple resources at once. - * Will return null if the resource is not found. + * @return null if the resource is not found. * @param cemtTerminal an {@link ITerminal} object logged on to the CICS region and in an active CEMT session. * If mixed case is required, the terminal should be presented with no upper case translate status. * For example, the test could first issue CEOT TRANIDONLY diff --git a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java index e30b18096..6be5e8910 100644 --- a/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java +++ b/galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java @@ -12,187 +12,186 @@ public interface IExecInterfaceBlock { /** - * Returns a {@link String} representation of the EIBRESP field if available - * @return + * @return a {@link String} representation of the EIBRESP field if available */ public String getResponse(); /** - * Returns the value of the EIBTIME field in the EIB. - * @return + * @return the value of the EIBTIME field in the EIB. + * */ public int getEIBTIME(); /** - * Returns the value of the EIBDATE field in the EIB. - * @return + * @return the value of the EIBDATE field in the EIB. + * */ public int getEIBDATE(); /** - * Returns the value of the EIBTRNID field in the EIB. + * @return the value of the EIBTRNID field in the EIB. * @param hex return a char array containing the hex values of the field - * @return + * */ public String getEIBTRNID(boolean hex); /** - * Returns the value of the EIBTASKN field in the EIB. - * @return + * @return the value of the EIBTASKN field in the EIB. + * */ public int getEIBTASKN(); /** - * Returns the value of the EIBTRMID field in the EIB. + * @return the value of the EIBTRMID field in the EIB. * @param hex return a char array containing the hex values of the field - * @return + * */ public String getEIBTRMID(boolean hex); /** - * Returns the value of the EIBCPOSN field in the EIB. - * @return + * @return the value of the EIBCPOSN field in the EIB. + * */ public int getEIBCPOSN(); /** - * Returns the value of the EIBCALEN field in the EIB. - * @return + * @return the value of the EIBCALEN field in the EIB. + * */ public int getEIBCALEN(); /** - * Returns the value of the EIBAID field in the EIB. - * @return + * @return the value of the EIBAID field in the EIB. + * */ public char getEIBAID(); /** - * Returns the value of the EIBFN field in the EIB. - * @return + * @return the value of the EIBFN field in the EIB. + * */ public char[] getEIBFN(); /** - * Returns the value of the EIBRCODE field in the EIB. - * @return + * @return the value of the EIBRCODE field in the EIB. + * */ public char[] getEIBRCODE(); /** - * Returns the value of the EIBDS field in the EIB. + * @return the value of the EIBDS field in the EIB. * @param hex return a char array containing the hex values of the field - * @return + * */ public String getEIBDS(boolean hex); /** - * Returns the value of the EIBREQID field in the EIB. + * @return the value of the EIBREQID field in the EIB. * @param hex return a char array containing the hex values of the field - * @return + * */ public String getEIBREQID(boolean hex); /** - * Returns the value of the EIBRSRCE field in the EIB. + * @return the value of the EIBRSRCE field in the EIB. * @param hex return a char array containing the hex values of the field - * @return + * */ public String getEIBRSRCE(boolean hex); /** - * Returns the value of the EIBSYNC field in the EIB. - * @return + * @return the value of the EIBSYNC field in the EIB. + * */ public char getEIBSYNC(); /** - * Returns the value of the EIBFREE field in the EIB. - * @return + * @return the value of the EIBFREE field in the EIB. + * */ public char getEIBFREE(); /** - * Returns the value of the EIBRECV field in the EIB. - * @return + * @return the value of the EIBRECV field in the EIB. + * */ public char getEIBRECV(); /** - * Returns the value of the EIBATT field in the EIB. - * @return + * @return the value of the EIBATT field in the EIB. + * */ public char getEIBATT(); /** - * Returns the value of the EIBEOC field in the EIB. - * @return + * @return the value of the EIBEOC field in the EIB. + * */ public char getEIBEOC(); /** - * Returns the value of the field in the EIB. - * @return + * @return the value of the field in the EIB. + * */ public char getEIBFMH(); /** - * Returns the value of the EIBCOMPL field in the EIB. - * @return + * @return the value of the EIBCOMPL field in the EIB. + * */ public char getEIBCOMPL(); /** - * Returns the value of the EIBSIG field in the EIB. - * @return + * @return the value of the EIBSIG field in the EIB. + * */ public char getEIBSIG(); /** - * Returns the value of the EIBCONF field in the EIB. - * @return + * @return the value of the EIBCONF field in the EIB. + * */ public char getEIBCONF(); /** - * Returns the value of the EIBERR field in the EIB. - * @return + * @return the value of the EIBERR field in the EIB. + * */ public char getEIBERR(); /** - * Returns the value of the EIBERRCD field in the EIB. - * @return + * @return the value of the EIBERRCD field in the EIB. + * */ public char[] getEIBERRCD(); /** - * Returns the value of the EIBSYNRB field in the EIB. - * @return + * @return the value of the EIBSYNRB field in the EIB. + * */ public char getEIBSYNRB(); /** - * Returns the value of the EIBNODAT field in the EIB. - * @return + * @return the value of the EIBNODAT field in the EIB. + * */ public char getEIBNODAT(); /** - * Returns the value of the EIBRESP field in the EIB. - * @return + * @return the value of the EIBRESP field in the EIB. + * */ public int getEIBRESP(); /** - * Returns the value of the EIBRESP2 field in the EIB. - * @return + * @return the value of the EIBRESP2 field in the EIB. + * */ public int getEIBRESP2(); /** - * Returns the value of the EIBRLDBK field in the EIB. - * @return + * @return the value of the EIBRLDBK field in the EIB. + * */ public char getEIBRLDBK(); } diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java index 192a4de9d..7cc1a0d5b 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java @@ -240,11 +240,11 @@ public static HttpClientResponse textResponse(CloseableHttpResponse http } /** - * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type * from an {@link HttpResponse}. * * @param httpResponse - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse) @@ -253,14 +253,14 @@ public static HttpClientResponse jsonResponse(CloseableHttpResponse } /** - * Create an {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type * from an {@link HttpResponse}. If contentOnBadResponse is true, an attempt * will be made to retrieve the content even on a non 200 status code, otherwise * the content will be null in such an instance. * * @param httpResponse * @param contentOnBadResponse - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ public static HttpClientResponse jsonResponse(CloseableHttpResponse httpResponse, diff --git a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java index bcd53f1ea..06438fb4f 100644 --- a/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java +++ b/galasa-managers-parent/galasa-managers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java @@ -122,54 +122,54 @@ HttpClientResponse postXML(String url, String xml) throws HttpClientException; /** - * Issue an HTTP GET to the provided URL, receiving a <com.google.gson.JsonObject> in the + * Issue an HTTP GET to the provided URL, receiving a com.google.gson.JsonObject in the * response. * * @param url - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse getJson(String url) throws HttpClientException; /** * Issue an HTTP POST to the provided URL, sending the provided - * <com.google.gson.JsonObject> and receiving a <com.google.gson.JsonObject> in the response. + * com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse postJson(String url, JsonObject json) throws HttpClientException; /** * Issue an HTTP PUT to the provided URL, sending the provided - * com.google.gson.JSONObject and receiving a com.google.gson.JSONObject in the response. + * com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a com.google.gson.JSONObject content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse putJson(String url, JsonObject json) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in + * Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in * the response. * * @param url - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url) throws HttpClientException; /** - * Issue an HTTP DELETE to the provided URL, receiving a <com.google.gson.JsonObject> in + * Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in * the response. * * @param url * @param json - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteJson(String url, JsonObject json) throws HttpClientException; @@ -222,7 +222,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse putBinary(String url, byte[] binary) throws HttpClientException; @@ -233,7 +233,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse getBinary(String url, byte[] binary) throws HttpClientException; @@ -244,7 +244,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse postBinary(String url, byte[] binary) throws HttpClientException; @@ -255,7 +255,7 @@ HttpClientResponse postXML(String url, String xml) * * @param url * @param binary - * @return - {@link HttpClientResponse} with a <com.google.gson.JsonObject> content type + * @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type * @throws HttpClientException */ HttpClientResponse deleteBinary(String url, byte[] binary) throws HttpClientException; diff --git a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java index 6815c2aa6..c9eba0acd 100644 --- a/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java +++ b/galasa-managers-parent/galasa-managers-testingtools-parent/dev.galasa.jmeter.manager/src/main/java/dev/galasa/jmeter/IJMeterSession.java @@ -60,9 +60,11 @@ public interface IJMeterSession { * JMX-files have to be prepared for this by replacing ALL the $P__VARIABLE notations with $VARIABLE notations * Then by adding neccesary parameters inside a HashMap with it, it is possible to change the target of a test dynamically inside the test * Example: - * HashMap<String,Object> map = new HashMap<String,Object>(); - * map.put("HOST", "galasa.dev"); - * session.setChangedParametersJmxFile(jmxStream, map); + * 
    +        HashMap map = new HashMap();
+        map.put("HOST", "galasa.dev");
+        session.setChangedParametersJmxFile(jmxStream, map);
+
    * @param jmxStream * @param parameters * @throws JMeterManagerException diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java index c3ff97eac..14a32c0f9 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zos.manager/src/main/java/dev/galasa/zosbatch/IZosBatchJob.java @@ -66,7 +66,7 @@ public static JobStatus valueOfLabel(String jobStatus) { public String getOwner(); /** - * The type for this Job, i.e. JOB, STC or TSU. Returns "???" if no type has been associated + * The type for this Job, i.e. "JOB", "STC" or "TSU". Returns "???" if no type has been associated * * @return batch job type */ @@ -81,7 +81,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * The batch job value as a {@link String}, e.g.
    - * INPUT, ACTIVE, OUTPUT etc.
    + * "INPUT", "ACTIVE", "OUTPUT" etc.
    * Returns "????????" if the job has not been submitted *

    * N.B. Values are implementation dependent @@ -92,7 +92,7 @@ public static JobStatus valueOfLabel(String jobStatus) { /** * The batch job completion return code, e.g.
    - * <code>CC 0000</code>, <code>CC 0020</code>, <code>JCL ERROR</code>, <code>ABEND S0C4</code> etc.<br> + * "CC 0000", "CC 0020", "JCL ERROR", "ABEND S0C4" etc. * Returns "????" if the job has not been submitted * * @return diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java index 180da00e1..f4d806266 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosliberty.manager/src/main/java/dev/galasa/zosliberty/IZosLibertyServerXmlElementList.java @@ -17,7 +17,7 @@ public interface IZosLibertyServerXmlElementList /** * Put an XML element in the element list * @param elementName - The name of the element to add - * @param attributes - A HashMap<String, String> of attributes + * @param attributes - A HashMap of attributes */ public void add(String elementName, Map attributes); diff --git a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java index 174f3d7f1..ae9c40b7b 100644 --- a/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java +++ b/galasa-managers-parent/galasa-managers-zos-parent/dev.galasa.zosprogram.manager/src/main/java/dev/galasa/zosprogram/ZosProgram.java @@ -84,19 +84,19 @@ */ public enum Language { /** - * COBOL program with .cbl file extension + * COBOL program with ".cbl" file extension */ COBOL(".cbl"), /** - * C program with .c file extension + * C program with ".c" file extension */ C(".c"), /** - * PL1 program with .pl1 file extension + * PL1 program with ".pl1" file extension */ PL1(".pl1"), /** - * Assembler program with <code>.asm<\code> file extension + * Assembler program with ".asm" file extension */ ASSEMBLER(".asm"), /** From 95d7d9615efc3eb8704f55972419ca0623c8feb1 Mon Sep 17 00:00:00 2001 From: dhruv Date: Wed, 24 Jul 2024 17:28:06 +0530 Subject: [PATCH 10/16] added recommended changes Signed-off-by: dhruv --- .github/workflows/build.yaml | 39 +++++++++++++++++++++++++++++---- .github/workflows/pr-build.yaml | 19 ++++++++++++++-- dockerfiles/dockerfile | 6 +++++ 3 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 dockerfiles/dockerfile diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index c5825bb11..7a7da1395 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -6,7 +6,9 @@ on: branches: [main] env: - NAMESPACE: jaydee029 + REGISTRY: ghcr.io + NAMESPACE: galasa-dev + IMAGE_TAG: main jobs: build-gradle: @@ -23,6 +25,10 @@ jobs: java-version: '11' distribution: 'semeru' + - name: Print githash + run: | + echo $GITHUB_SHA > ./managers.githash + - name: Setup Gradle uses: gradle/actions/setup-gradle@v3 with: @@ -30,7 +36,8 @@ jobs: - name: Build ,Test and Publish Managers env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_ACTOR: ${{github.actor}} + GITHUB_TOKEN: ${{ github.token }} ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.GPG_KEY }} ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} @@ -39,5 +46,29 @@ jobs: -Dorg.gradle.jvmargs=-Xmx4096M \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ - -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ -PjacocoEnabled=true -PisMainOrRelease=true - \ No newline at end of file + -PtargetMaven=${{github.workspace}}/repo -PjacocoEnabled=true -PisMainOrRelease=true + + - name: Extract metadata for Managers image + id: metadata + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.NAMESPACE }}/managers-maven-artefacts + + - name: Build Managers image for development Maven registry + id: build + uses: docker/build-push-action@v5 + with: + context: . + file: dockerfiles/dockerfile + push: true + tags: ${{ steps.metadata.outputs.tags }} + labels: ${{ steps.metadata.outputs.labels }} + build-args: | + dockerRepository=harbor.galasa.dev + tag=${{ env.IMAGE_TAG }} + + - name: Recycle application in ArgoCD + env: + ARGOCD_AUTH_TOKEN: ${{ secrets.ARGOCD_TOKEN }} + run: | + docker run --env ARGOCD_AUTH_TOKEN=${{ env.ARGOCD_AUTH_TOKEN }} --rm -v ${{ github.workspace }}:/var/workspace ghcr.io/galasa-dev/argocdcli:main app actions run main-maven-repos restart --kind Deployment --resource-name managers-main --server argocd.galasa.dev \ No newline at end of file diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index bcc627ff5..16f491f11 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -22,6 +22,10 @@ jobs: with: java-version: '11' distribution: 'semeru' + + - name: Print githash + run: | + echo $GITHUB_SHA > ./managers.githash - name: Setup Gradle uses: gradle/actions/setup-gradle@v3 @@ -30,9 +34,20 @@ jobs: - name: Test and Build Managers run: | - gradle -b galasa-managers-parent/build.gradle clean build \ + gradle -b galasa-managers-parent/build.gradle check publish \ -Dorg.gradle.jvmargs=-Xmx4096M \ -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ - -PtargetMaven=https://maven.pkg.github.com/${{env.NAMESPACE}}/managers/ + -PtargetMaven=${{github.workspace}}/repo + + - name: Build managers Image for testing + uses: docker/build-push-action@v5 + with: + context: . + file: dockerfiles/dockerfile + load: true + tags: managers:test + build-args: | + dockerRepository=harbor.galasa.dev + tag=main \ No newline at end of file diff --git a/dockerfiles/dockerfile b/dockerfiles/dockerfile new file mode 100644 index 000000000..a473265ea --- /dev/null +++ b/dockerfiles/dockerfile @@ -0,0 +1,6 @@ +ARG dockerRepository +ARG tag +FROM ${dockerRepository}/galasadev/galasa-extensions:${tag} + +COPY repo/ /usr/local/apache2/htdocs/ +COPY managers.githash /usr/local/apache2/htdocs/managers.githash \ No newline at end of file From 43a2f77734909aea069fdf15be4dfc2b7e61c1b9 Mon Sep 17 00:00:00 2001 From: dhruv Date: Wed, 24 Jul 2024 17:43:37 +0530 Subject: [PATCH 11/16] final changes Signed-off-by: dhruv --- .github/workflows/build.yaml | 5 ++--- .github/workflows/pr-build.yaml | 8 ++------ 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 7a7da1395..501ea277b 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,9 +1,8 @@ name: Main build on: - workflow_dispatch: - pull_request: - branches: [main] + push: + branches: [main] env: REGISTRY: ghcr.io diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 16f491f11..e43e93aea 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -1,12 +1,8 @@ name: PR build on: - workflow_dispatch: - pull_request: - branches: [main] - -env: - NAMESPACE: jaydee029 + pull_request: + branches: [main] jobs: build-gradle: From f5ac91c135bf955f6f3e178a09f01f4b743a550e Mon Sep 17 00:00:00 2001 From: dhruv Date: Wed, 24 Jul 2024 17:48:20 +0530 Subject: [PATCH 12/16] final changes Signed-off-by: dhruv --- .github/workflows/build.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 501ea277b..c90d8309c 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -70,4 +70,4 @@ jobs: env: ARGOCD_AUTH_TOKEN: ${{ secrets.ARGOCD_TOKEN }} run: | - docker run --env ARGOCD_AUTH_TOKEN=${{ env.ARGOCD_AUTH_TOKEN }} --rm -v ${{ github.workspace }}:/var/workspace ghcr.io/galasa-dev/argocdcli:main app actions run main-maven-repos restart --kind Deployment --resource-name managers-main --server argocd.galasa.dev \ No newline at end of file + docker run --env ARGOCD_AUTH_TOKEN=${{ env.ARGOCD_AUTH_TOKEN }} --rm -v ${{ github.workspace }}:/var/workspace ghcr.io/galasa-dev/argocdcli:main app actions run gh-maven-repos restart --kind Deployment --resource-name managers-gh --server argocd.galasa.dev \ No newline at end of file From c14b1a59082ef06126fc54362eaa648128793481 Mon Sep 17 00:00:00 2001 From: dhruv Date: Wed, 24 Jul 2024 19:38:08 +0530 Subject: [PATCH 13/16] changed pointing url Signed-off-by: dhruv --- .github/workflows/build.yaml | 2 +- .github/workflows/pr-build.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index c90d8309c..98eb93813 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -43,7 +43,7 @@ jobs: run: | gradle -b galasa-managers-parent/build.gradle check publish --info \ -Dorg.gradle.jvmargs=-Xmx4096M \ - -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ + -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=${{github.workspace}}/repo -PjacocoEnabled=true -PisMainOrRelease=true diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index e43e93aea..fa08b3353 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -32,7 +32,7 @@ jobs: run: | gradle -b galasa-managers-parent/build.gradle check publish \ -Dorg.gradle.jvmargs=-Xmx4096M \ - -PsourceMaven=https://development.galasa.dev/main/maven-repo/extensions \ + -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ -PcentralMaven=https://repo.maven.apache.org/maven2/ \ -PtargetMaven=${{github.workspace}}/repo From 31d3d7f87d4287b0c0979385dc7c99bcfdd25165 Mon Sep 17 00:00:00 2001 From: Jade Carino Date: Thu, 25 Jul 2024 12:15:46 +0100 Subject: [PATCH 14/16] Minor adjustments to workflow for readability and secret names Signed-off-by: Jade Carino --- .github/workflows/build.yaml | 121 +++++++++++++++++--------------- .github/workflows/pr-build.yaml | 78 ++++++++++---------- 2 files changed, 104 insertions(+), 95 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 98eb93813..8bf199c45 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -10,64 +10,73 @@ env: IMAGE_TAG: main jobs: - build-gradle: - name: build and Test Managers - runs-on: ubuntu-latest + build-managers: + name: Build Managers source code and Docker image for development Maven registry + runs-on: ubuntu-latest - steps: - - name: Checkout Code - uses: actions/checkout@v4 - - - name: Setup JDK - uses: actions/setup-java@v4 - with: - java-version: '11' - distribution: 'semeru' + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup JDK + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'semeru' - - name: Print githash - run: | - echo $GITHUB_SHA > ./managers.githash + - name: Print githash + run: | + echo $GITHUB_SHA > ./managers.githash - - name: Setup Gradle - uses: gradle/actions/setup-gradle@v3 - with: - gradle-version: 6.9.2 + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v3 + with: + gradle-version: 6.9.2 - - name: Build ,Test and Publish Managers - env: - GITHUB_ACTOR: ${{github.actor}} - GITHUB_TOKEN: ${{ github.token }} - ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.GPG_KEY }} - ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_SECRET }} - ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} - run: | - gradle -b galasa-managers-parent/build.gradle check publish --info \ - -Dorg.gradle.jvmargs=-Xmx4096M \ - -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ - -PcentralMaven=https://repo.maven.apache.org/maven2/ \ - -PtargetMaven=${{github.workspace}}/repo -PjacocoEnabled=true -PisMainOrRelease=true - - - name: Extract metadata for Managers image - id: metadata - uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 - with: - images: ${{ env.REGISTRY }}/${{ env.NAMESPACE }}/managers-maven-artefacts - - - name: Build Managers image for development Maven registry - id: build - uses: docker/build-push-action@v5 - with: - context: . - file: dockerfiles/dockerfile - push: true - tags: ${{ steps.metadata.outputs.tags }} - labels: ${{ steps.metadata.outputs.labels }} - build-args: | - dockerRepository=harbor.galasa.dev - tag=${{ env.IMAGE_TAG }} + - name: Build Managers source code + env: + GITHUB_ACTOR: ${{ github.actor }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.GPG_KEYID }} + ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_KEY }} + ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }} + run: | + gradle -b galasa-managers-parent/build.gradle check publish \ + -Dorg.gradle.jvmargs=-Xmx4096M \ + -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ + -PcentralMaven=https://repo.maven.apache.org/maven2/ \ + -PtargetMaven=${{github.workspace}}/repo \ + -PjacocoEnabled=true \ + -PisMainOrRelease=true - - name: Recycle application in ArgoCD - env: - ARGOCD_AUTH_TOKEN: ${{ secrets.ARGOCD_TOKEN }} - run: | - docker run --env ARGOCD_AUTH_TOKEN=${{ env.ARGOCD_AUTH_TOKEN }} --rm -v ${{ github.workspace }}:/var/workspace ghcr.io/galasa-dev/argocdcli:main app actions run gh-maven-repos restart --kind Deployment --resource-name managers-gh --server argocd.galasa.dev \ No newline at end of file + - name: Login to Github Container Registry + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata for Managers image + id: metadata + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.NAMESPACE }}/managers-maven-artefacts + + - name: Build Managers image for development Maven registry + id: build + uses: docker/build-push-action@v5 + with: + context: . + file: dockerfiles/dockerfile + push: true + tags: ${{ steps.metadata.outputs.tags }} + labels: ${{ steps.metadata.outputs.labels }} + build-args: | + dockerRepository=harbor.galasa.dev + tag=${{ env.IMAGE_TAG }} + + - name: Recycle application in ArgoCD + env: + ARGOCD_AUTH_TOKEN: ${{ secrets.ARGOCD_TOKEN }} + run: | + docker run --env ARGOCD_AUTH_TOKEN=${{ env.ARGOCD_AUTH_TOKEN }} --rm -v ${{ github.workspace }}:/var/workspace ghcr.io/galasa-dev/argocdcli:main app actions run gh-maven-repos restart --kind Deployment --resource-name managers-gh --server argocd.galasa.dev \ No newline at end of file diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index fa08b3353..19fd0aa91 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -5,45 +5,45 @@ on: branches: [main] jobs: - build-gradle: - name: build and Test Managers - runs-on: ubuntu-latest + build-managers: + name: Build Managers source code and Docker image + runs-on: ubuntu-latest - steps: - - name: Checkout Code - uses: actions/checkout@v4 - - - name: Setup JDK - uses: actions/setup-java@v4 - with: - java-version: '11' - distribution: 'semeru' - - - name: Print githash - run: | - echo $GITHUB_SHA > ./managers.githash + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup JDK + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'semeru' + + - name: Print githash + run: | + echo $GITHUB_SHA > ./managers.githash - - name: Setup Gradle - uses: gradle/actions/setup-gradle@v3 - with: - gradle-version: 6.9.2 - - - name: Test and Build Managers - run: | - gradle -b galasa-managers-parent/build.gradle check publish \ - -Dorg.gradle.jvmargs=-Xmx4096M \ - -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ - -PcentralMaven=https://repo.maven.apache.org/maven2/ \ - -PtargetMaven=${{github.workspace}}/repo + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v3 + with: + gradle-version: 6.9.2 + + - name: Build Managers source code + run: | + gradle -b galasa-managers-parent/build.gradle check publish \ + -Dorg.gradle.jvmargs=-Xmx4096M \ + -PsourceMaven=https://development.galasa.dev/gh/maven-repo/extensions \ + -PcentralMaven=https://repo.maven.apache.org/maven2/ \ + -PtargetMaven=${{github.workspace}}/repo - - name: Build managers Image for testing - uses: docker/build-push-action@v5 - with: - context: . - file: dockerfiles/dockerfile - load: true - tags: managers:test - build-args: | - dockerRepository=harbor.galasa.dev - tag=main - \ No newline at end of file + - name: Build Managers image for testing + uses: docker/build-push-action@v5 + with: + context: . + file: dockerfiles/dockerfile + load: true + tags: managers:test + build-args: | + dockerRepository=harbor.galasa.dev + tag=main + \ No newline at end of file From 9c97099c9ce59ab4ebe4da233d0a4c800da3afe1 Mon Sep 17 00:00:00 2001 From: Jade Carino Date: Thu, 25 Jul 2024 14:58:58 +0100 Subject: [PATCH 15/16] Add missing config for GPG signing artefacts Signed-off-by: Jade Carino --- .../buildSrc/src/main/groovy/galasa.java.gradle | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/galasa-managers-parent/buildSrc/src/main/groovy/galasa.java.gradle b/galasa-managers-parent/buildSrc/src/main/groovy/galasa.java.gradle index bda13eac0..8e8c39865 100644 --- a/galasa-managers-parent/buildSrc/src/main/groovy/galasa.java.gradle +++ b/galasa-managers-parent/buildSrc/src/main/groovy/galasa.java.gradle @@ -58,6 +58,10 @@ repositories { } signing { + def signingKeyId = findProperty("signingKeyId") + def signingKey = findProperty("signingKey") + def signingPassword = findProperty("signingPassword") + useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) sign publishing.publications } @@ -108,8 +112,8 @@ publishing { if ("$targetMaven".startsWith('http')) { credentials { - username System.getenv('MAVENUSERNAME') - password System.getenv('MAVENPASSWORD') + username System.getenv("GITHUB_ACTOR") + password System.getenv("GITHUB_TOKEN") } } } From c177b46a1a1e190e764fd04dacbb5ac3b4fb2b33 Mon Sep 17 00:00:00 2001 From: Jade Carino Date: Thu, 25 Jul 2024 15:00:33 +0100 Subject: [PATCH 16/16] Use new image in GHCR Signed-off-by: Jade Carino --- .github/workflows/build.yaml | 2 +- .github/workflows/pr-build.yaml | 2 +- dockerfiles/dockerfile | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 8bf199c45..f7e4d31e3 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -72,7 +72,7 @@ jobs: tags: ${{ steps.metadata.outputs.tags }} labels: ${{ steps.metadata.outputs.labels }} build-args: | - dockerRepository=harbor.galasa.dev + dockerRepository=ghcr.io tag=${{ env.IMAGE_TAG }} - name: Recycle application in ArgoCD diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml index 19fd0aa91..7fe26321d 100644 --- a/.github/workflows/pr-build.yaml +++ b/.github/workflows/pr-build.yaml @@ -44,6 +44,6 @@ jobs: load: true tags: managers:test build-args: | - dockerRepository=harbor.galasa.dev + dockerRepository=ghcr.io tag=main \ No newline at end of file diff --git a/dockerfiles/dockerfile b/dockerfiles/dockerfile index a473265ea..2cc63736a 100644 --- a/dockerfiles/dockerfile +++ b/dockerfiles/dockerfile @@ -1,6 +1,6 @@ ARG dockerRepository ARG tag -FROM ${dockerRepository}/galasadev/galasa-extensions:${tag} +FROM ${dockerRepository}/galasa-dev/extensions-maven-artefacts:${tag} COPY repo/ /usr/local/apache2/htdocs/ COPY managers.githash /usr/local/apache2/htdocs/managers.githash \ No newline at end of file