From dd480ac856cecfba05a25593e47e4fe77d5b26b4 Mon Sep 17 00:00:00 2001 From: Arturo Bernal Date: Fri, 11 Aug 2023 21:47:09 +0200 Subject: [PATCH] Add GitHub Actions workflows for Java CI and Dependency Review - Implement Java CI workflow with matrix strategy for multiple OS and Java versions. - Introduce Dependency Review workflow to assess pull request dependencies. - Enhance build and analysis steps for better CI/CD integration. --- .github/workflows/codeql.yml | 90 +++++++++++++++++++ .github/workflows/dependency-review.yml | 31 +++++++ .github/workflows/maven.yml | 61 +++++++++++++ .../apache/wiki/util/PropertyReaderTest.java | 29 +++--- pom.xml | 1 + 5 files changed, 198 insertions(+), 14 deletions(-) create mode 100644 .github/workflows/codeql.yml create mode 100644 .github/workflows/dependency-review.yml create mode 100644 .github/workflows/maven.yml diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000000..64e47283ef --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,90 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# ******** NOTE ******** + +name: "CodeQL" + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '16 7 * * 5' + +permissions: + contents: read + +jobs: + analyze: + permissions: + actions: read # for github/codeql-action/init to get workflow details + contents: read # for actions/checkout to fetch code + security-events: write # for github/codeql-action/analyze to upload SARIF results + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'java' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more... + # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + #- name: Autobuild + # uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + - run: mvn clean package -DskipTests -Drat.skip=true -Dcheckstyle.skip + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 0000000000..83886a45a3 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,31 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v3 + - name: 'Dependency Review' + uses: actions/dependency-review-action@v3 diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 0000000000..aa13f9cc78 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,61 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Java CI + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + build: + + runs-on: ${{ matrix.os }} + continue-on-error: ${{ matrix.experimental }} + strategy: + matrix: + # windows-latest is not used due to intermittent lucene failures + os: [ubuntu-latest, macos-latest] + # All LTS versions plus the current version + java: [ 11, 17 ] + experimental: [false] +# include: +# - java: 20-ea +# os: ubuntu-latest +# experimental: true +# - java: 20-ea +# os: windows-latest +# experimental: true +# - java: 20-ea +# os: macos-latest +# experimental: true + fail-fast: false + + steps: + - uses: actions/checkout@v3 + - uses: actions/cache@v3 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@v3 + with: + distribution: 'temurin' + java-version: ${{ matrix.java }} + - name: Build with Maven + run: mvn -V --file pom.xml --no-transfer-progress -DtrimStackTrace=false -P-use-toolchains diff --git a/jspwiki-util/src/test/java/org/apache/wiki/util/PropertyReaderTest.java b/jspwiki-util/src/test/java/org/apache/wiki/util/PropertyReaderTest.java index f4e21b7443..eaf60cb653 100644 --- a/jspwiki-util/src/test/java/org/apache/wiki/util/PropertyReaderTest.java +++ b/jspwiki-util/src/test/java/org/apache/wiki/util/PropertyReaderTest.java @@ -131,27 +131,28 @@ public void testCollectPropertiesFrom() { public void testSetWorkDir() { final Properties properties = new Properties(); final ServletContext servletContext = mock(ServletContext.class); - final File tmp = new File( "/tmp" ); - Mockito.when(servletContext.getAttribute( "javax.servlet.context.tempdir" ) ).thenReturn( tmp ); + final String expectedTmpDir = System.getProperty("java.io.tmpdir"); - PropertyReader.setWorkDir( servletContext, properties ); + Mockito.when(servletContext.getAttribute("javax.servlet.context.tempdir")).thenReturn(new File(expectedTmpDir)); // Test when the "jspwiki.workDir" is not set, it should get set to servlet's temporary directory - String workDir = properties.getProperty( "jspwiki.workDir" ); - Assertions.assertEquals( tmp.getAbsolutePath(), workDir ); + PropertyReader.setWorkDir(servletContext, properties); + String workDir = properties.getProperty("jspwiki.workDir"); + Assertions.assertEquals(expectedTmpDir, workDir); // Test when the "jspwiki.workDir" is set, it should remain as it is - properties.setProperty( "jspwiki.workDir", "/custom/dir" ); - PropertyReader.setWorkDir( servletContext, properties ); - workDir = properties.getProperty( "jspwiki.workDir" ); - Assertions.assertEquals( "/custom/dir", workDir ); + properties.setProperty("jspwiki.workDir", "/custom/dir"); + PropertyReader.setWorkDir(servletContext, properties); + workDir = properties.getProperty("jspwiki.workDir"); + Assertions.assertEquals("/custom/dir", workDir); // Test when the servlet's temporary directory is null, it should get set to system's temporary directory - Mockito.when( servletContext.getAttribute( "javax.servlet.context.tempdir" ) ).thenReturn( null ); - properties.remove( "jspwiki.workDir" ); - PropertyReader.setWorkDir( servletContext, properties ); - workDir = properties.getProperty( "jspwiki.workDir" ); - Assertions.assertEquals( System.getProperty( "java.io.tmpdir" ), workDir ); + Mockito.when(servletContext.getAttribute("javax.servlet.context.tempdir")).thenReturn(null); + properties.remove("jspwiki.workDir"); + PropertyReader.setWorkDir(servletContext, properties); + workDir = properties.getProperty("jspwiki.workDir"); + Assertions.assertEquals(expectedTmpDir, workDir); } + } diff --git a/pom.xml b/pom.xml index 1dfa3aee4c..176e772a59 100644 --- a/pom.xml +++ b/pom.xml @@ -764,6 +764,7 @@ **/src/main/webapp/favicons/*.svg **/src/overlay/launchers/tomcat/woas.app/Contents/*.plist **/src/overlay/launchers/tomcat/woas.app/Contents/Resources/*.none + **/.eslintrc