RATIS-2171. Safer initialization of TransactionContext#logIndexFuture

.asf.yaml

@@ -24,7 +24,9 @@ github:
     squash:  true
     merge:   false
     rebase:  false
-  autolink_jira: RATIS
+  autolink_jira:
+    - HDDS
+    - RATIS
 
 notifications:
   commits:      commits@ratis.apache.org

.github/workflows/check.yaml

@@ -0,0 +1,203 @@
+# 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.
+
+# This reusable workflow executes a single check from `dev-support/checks/`.
+# Before and after the check, it performs various steps based on workflow inputs.
+
+name: ci-check
+
+on:
+  workflow_call:
+    inputs:
+      # REQUIRED
+      script:
+        type: string
+        description: "Test script to run from dev-support/checks, without .sh extension"
+        required: true
+
+      # OPTIONAL (ordered alphabetically)
+      java-version:
+        type: string
+        description: "Java version to set up (default: 8)"
+        default: '8'
+        required: false
+
+      needs-binary-tarball:
+        type: boolean
+        description: "Whether to download Ratis binary tarball created by build (default: no)"
+        default: false
+        required: false
+
+      needs-maven-repo:
+        type: boolean
+        description: "Whether to download Ratis jars created by build (default: no)"
+        default: false
+        required: false
+
+      needs-source-tarball:
+        type: boolean
+        description: "Whether to download Ratis source tarball created by build (default: no)"
+        default: false
+        required: false
+
+      runner:
+        type: string
+        description: "GitHub Actions runner to use"
+        default: 'ubuntu-24.04'
+        required: false
+
+      script-args:
+        type: string
+        description: "Arguments for the test script"
+        default: ''
+        required: false
+
+      split:
+        type: string
+        description: "Name of split for matrix jobs, only used in display name"
+        default: ''
+        required: false
+
+      timeout-minutes:
+        type: number
+        description: "Job timeout in minutes (default: 30)"
+        default: 30
+        required: false
+
+env:
+  MAVEN_ARGS: --batch-mode --show-version
+  MAVEN_OPTS: -Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false -Dmaven.wagon.http.retryHandler.class=standard -Dmaven.wagon.http.retryHandler.count=3
+  WITH_COVERAGE: ${{ github.event_name == 'push' }}
+
+jobs:
+  check:
+    name: ${{ (inputs.split && format('{0} ({1})', inputs.script, inputs.split)) || inputs.script }}
+    runs-on: ${{ inputs.runner }}
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+      - name: Checkout project
+        if: ${{ !inputs.needs-source-tarball }}
+        uses: actions/checkout@v4
+
+      - name: Download source tarball
+        if: ${{ inputs.needs-source-tarball }}
+        uses: actions/download-artifact@v4
+        with:
+          name: ratis-src
+
+      - name: Extract source tarball
+        if: ${{ inputs.needs-source-tarball }}
+        run: |
+          tar --strip-components 1 -xzvf ratis*-src.tar.gz
+
+      - name: Create cache for Maven dependencies
+        if: ${{ inputs.script == 'build' }}
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.m2/repository/*/*/*
+            !~/.m2/repository/org/apache/ratis
+          key: maven-repo-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            maven-repo-
+
+      - name: Restore cache for Maven dependencies
+        if: ${{ inputs.script != 'build' }}
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            ~/.m2/repository/*/*/*
+            !~/.m2/repository/org/apache/ratis
+          key: maven-repo-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            maven-repo-
+
+      - name: Download Maven repo
+        id: download-maven-repo
+        if: ${{ inputs.needs-maven-repo }}
+        uses: actions/download-artifact@v4
+        with:
+          name: maven-repo
+          path: |
+            ~/.m2/repository/org/apache/ratis
+
+      - name: Download binary tarball
+        if: ${{ inputs.needs-binary-tarball }}
+        uses: actions/download-artifact@v4
+        with:
+          name: ratis-bin
+
+      - name: Extract binary tarball
+        if: ${{ inputs.needs-binary-tarball }}
+        run: |
+          mkdir -p ratis-assembly/target
+          tar xzvf ratis-*-bin.tar.gz -C ratis-assembly/target
+
+      - name: Setup java ${{ inputs.java-version }}
+        if: ${{ inputs.java-version }}
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ inputs.java-version }}
+
+      - name: Execute tests
+        run: |
+          dev-support/checks/${{ inputs.script }}.sh ${{ inputs.script-args }}
+        env:
+          DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+
+      - name: Summary of failures
+        if: ${{ failure() }}
+        run: |
+          if [[ -s "target/${{ inputs.script }}/summary.txt" ]]; then
+            cat target/${{ inputs.script }}/summary.txt
+          fi
+
+      - name: Archive build results
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ (inputs.split && format('{0}-{1}', inputs.script, inputs.split)) || inputs.script }}
+          path: target/${{ inputs.script }}
+        continue-on-error: true
+
+      # The following steps are hard-coded to be run only for 'build' check,
+      # to avoid the need for 3 more inputs.
+      - name: Store binaries for tests
+        if: ${{ inputs.script == 'build' && !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ratis-bin
+          path: |
+            ratis-assembly/target/ratis-assembly-*-bin.tar.gz
+          retention-days: 1
+
+      - name: Store source tarball for compilation
+        if: ${{ inputs.script == 'build' && !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ratis-src
+          path: |
+            ratis-assembly/target/ratis-assembly-*-src.tar.gz
+          retention-days: 1
+
+      - name: Store Maven repo for tests
+        if: ${{ inputs.script == 'build' && !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: maven-repo
+          path: |
+            ~/.m2/repository/org/apache/ratis
+          retention-days: 1

.github/workflows/ci.yaml

@@ -0,0 +1,150 @@
+# 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: CI
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        type: string
+        description: Ratis git ref (branch, tag or commit hash)
+        default: ''
+        required: false
+
+jobs:
+  build:
+    uses: ./.github/workflows/check.yaml
+    with:
+      script: build
+      script-args: -Prelease
+      timeout-minutes: 30
+    secrets: inherit
+
+  compile:
+    needs:
+      - build
+    strategy:
+      matrix:
+        java: [ 11, 17, 21 ]
+      fail-fast: false
+    uses: ./.github/workflows/check.yaml
+    with:
+      java-version: ${{ matrix.java }}
+      needs-source-tarball: true
+      script: compile
+      script-args: -Djavac.version=${{ matrix.java }}
+      split: ${{ matrix.java }}
+      timeout-minutes: 30
+    secrets: inherit
+
+  release:
+    uses: ./.github/workflows/check.yaml
+    with:
+      script: release
+      timeout-minutes: 30
+    secrets: inherit
+
+  repro:
+    needs:
+      - build
+    uses: ./.github/workflows/check.yaml
+    with:
+      needs-maven-repo: true
+      script: repro
+      script-args: -Prelease
+      timeout-minutes: 30
+    secrets: inherit
+
+  basic:
+    strategy:
+      matrix:
+        check:
+          - author
+          - checkstyle
+          - findbugs
+          - rat
+      fail-fast: false
+    uses: ./.github/workflows/check.yaml
+    with:
+      script: ${{ matrix.check }}
+      timeout-minutes: 30
+    secrets: inherit
+
+  unit:
+    strategy:
+      matrix:
+        profile:
+          - grpc
+          - server
+          - misc
+          - flaky
+      fail-fast: false
+    uses: ./.github/workflows/check.yaml
+    with:
+      script: unit
+      script-args: -P${{ matrix.profile }}-tests
+      split: ${{ matrix.profile }}
+      timeout-minutes: 60
+    secrets: inherit
+
+  coverage:
+    needs:
+      - build
+      - unit
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    if: github.event_name != 'pull_request'
+    steps:
+        - name: Checkout project
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+        - name: Cache for maven dependencies
+          uses: actions/cache/restore@v4
+          with:
+            path: |
+              ~/.m2/repository
+              !~/.m2/repository/org/apache/ratis
+            key: maven-repo-${{ hashFiles('**/pom.xml') }}
+            restore-keys: |
+              maven-repo-
+        - name: Setup java 17
+          uses: actions/setup-java@v4
+          with:
+            distribution: 'temurin'
+            java-version: 17
+        - name: Download artifacts
+          uses: actions/download-artifact@v4
+          with:
+            path: target/artifacts
+        - name: Untar binaries
+          run: |
+            mkdir -p ratis-assembly/target
+            tar xzvf target/artifacts/ratis-bin/ratis-assembly-*.tar.gz -C ratis-assembly/target
+        - name: Calculate combined coverage
+          run: ./dev-support/checks/coverage.sh
+        - name: Upload coverage to Sonar
+          if: github.repository == 'apache/ratis'
+          run: ./dev-support/checks/sonar.sh
+          env:
+            SONAR_TOKEN: ${{ secrets.SONARCLOUD_TOKEN }}
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        - name: Archive build results
+          uses: actions/upload-artifact@v4
+          if: always()
+          with:
+            name: ${{ github.job }}
+            path: target/${{ github.job }}

.github/workflows/post-commit.yaml

@@ -0,0 +1,33 @@
+# 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: build-branch
+
+on:
+  push:
+    branches-ignore:
+      - 'dependabot/**'
+    tags:
+      - '**'
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  CI:
+    uses: ./.github/workflows/ci.yaml
+    secrets: inherit