Merge pull request #181 from johnjcasey/feature/automate-performance-…

…tests

Feature/automate performance tests

.github/workflows/beam_PostCommit_Java_IO_GCS_Performance_Tests.yml

@@ -0,0 +1,117 @@
+# 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: PostCommit Java IO GCS Performance Tests
+
+on:
+  push:
+    tags: ['v*']
+    branches: ['master', 'release-*']
+    paths: ['it/google-cloud-platform/**','.github/workflows/beam_PostCommit_Java_IO_GCS_Performance_Tests.yml']
+  issue_comment:
+    types: [created]
+  schedule:
+  - cron: '0 */6 * * *'
+  workflow_dispatch:
+
+#Setting explicit permissions for the action to avoid the default permissions which are `write-all` in case of pull_request_target event
+permissions:
+  actions: write
+  pull-requests: read
+  checks: read
+  contents: read
+  deployments: read
+  id-token: none
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  repository-projects: read
+  security-events: read
+  statuses: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.sha || github.head_ref || github.ref }}-${{ github.event.sender.login }}-${{ github.event.schedule }}'
+  cancel-in-progress: true
+
+env:
+  GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GE_ACCESS_TOKEN }}
+  GRADLE_ENTERPRISE_CACHE_USERNAME: ${{ secrets.GE_CACHE_USERNAME }}
+  GRADLE_ENTERPRISE_CACHE_PASSWORD: ${{ secrets.GE_CACHE_PASSWORD }}
+
+jobs:
+  beam_PostCommit_Java_IO_GCS_Performance_Tests:
+    if: |
+      github.event_name == 'push' ||
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'schedule' ||
+      github.event.comment.body == 'Run Java PostCommit IO GCS Performance Tests'
+    runs-on: [self-hosted, ubuntu-20.04, main]
+    name: ${{ matrix.job_name }} (${{ matrix.job_phrase }})
+    strategy:
+      matrix:
+        job_name: ["beam_PostCommit_Java_IO_GCS_Performance_Tests"]
+        job_phrase: ["Run Java PostCommit IO GCS Performance Tests"]
+    steps:
+    - name: Setup repository
+      uses: ./.github/actions/setup-action
+      with:
+        comment_phrase: ${{ matrix.job_phrase }}
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        github_job: ${{ matrix.job_name }} (${{ matrix.job_phrase }})
+    - name: Checkout release branch
+      if: github.event_name == 'schedule' #This has scheduled runs run against the latest release
+      uses: actions/checkout@v3
+      with:
+        ref: release-2.50.0 #TODO automate updating this
+        repository: apache/beam
+    - name: Checkout non-release branch
+      if: github.event_name != 'schedule' #This has triggered runs checkout the triggering branch
+      uses: actions/checkout@v3
+    - name: Install Java
+      uses: actions/setup-java@v3.8.0
+      with:
+        distribution: 'zulu'
+        java-version: '8'
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2
+      with:
+        cache-read-only: false
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+    - name: Authenticate on GCP
+      uses: google-github-actions/setup-gcloud@v0
+      with:
+        service_account_email: ${{ secrets.GCP_SA_EMAIL }}
+        service_account_key: ${{ secrets.GCP_SA_KEY }}
+        project_id: ${{ secrets.GCP_PROJECT_ID }}
+        export_default_credentials: true
+    - name: GCloud Docker credential helper
+      run: |
+        gcloud auth configure-docker us.gcr.io
+    - name: run scheduled javaPostcommitIOGCSPerformanceTests script
+      if: github.event_name == 'schedule' #This ensures only scheduled runs publish metrics publicly
+      with:
+        exportDataset: performance_tests
+        exportTable: io_performance_metrics
+      run: ./gradlew :it:google-cloud-platform:GCSPerformanceTest
+      env:
+        USER: github-actions
+    - name: run triggered javaPostcommitIOGCSPerformanceTests script
+      if: github.event_name != 'schedule'
+      run: ./gradlew :it:google-cloud-platform:GCSPerformanceTest
+      env:
+        USER: github-actions

buildSrc/src/main/groovy/org/apache/beam/gradle/IoPerformanceTestUtilities.groovy

@@ -0,0 +1,45 @@
+/*
+ * 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.
+ */
+package org.apache.beam.gradle
+
+import org.gradle.api.Project
+import org.gradle.api.tasks.testing.Test
+
+import javax.inject.Inject
+
+class IoPerformanceTestUtilities {
+  abstract static class IoPerformanceTest extends Test {
+    @Inject
+    IoPerformanceTest(Project runningProject, String module, String testClass, Map<String,String> systemProperties){
+      group = "Verification"
+      description = "Runs IO Performance Test for $testClass"
+      outputs.upToDateWhen { false }
+      testClassesDirs = runningProject.findProject(":it:${module}").sourceSets.test.output.classesDirs
+      classpath =  runningProject.sourceSets.test.runtimeClasspath + runningProject.findProject(":it:${module}").sourceSets.test.runtimeClasspath
+
+      include "**/${testClass}.class"
+
+      systemProperty 'exportDataset', System.getenv('exportDataset')
+      systemProperty 'exportTable', System.getenv('exportTable')
+
+      for (entry in systemProperties){
+        systemProperty entry.key, entry.value
+      }
+    }
+  }
+}

it/google-cloud-platform/build.gradle

@@ -15,6 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import org.apache.beam.gradle.IoPerformanceTestUtilities
 
 plugins { id 'org.apache.beam.module' }
 applyJavaNature(
@@ -74,4 +75,6 @@ dependencies {
     testImplementation library.java.mockito_inline
     testRuntimeOnly project(path: ":runners:direct-java", configuration: "shadowTest")
     testRuntimeOnly library.java.slf4j_simple
-}
+}
+
+tasks.register("GCSPerformanceTest", IoPerformanceTestUtilities.IoPerformanceTest, project, 'google-cloud-platform', 'FileBasedIOLT', ['configuration':'large','project':'apache-beam-testing', 'artifactBucket':'io-performance-temp'])