d1e9b99233
Improve our build workflow execution time by using custom runners, improved caching and conditional Web UI builds. Runners ------- We improve our build times[0] by using larger custom runners[1] when building the UI and Vault. Caching ------- We improve Vault caching by keeping a cache for each build job. This strategy has the following properties which should result in faster build times when `go.sum` hasn't been changed from prior builds, or when a pull request is retried or updated after a prior successful build: * Builds will restore cached Go modules and Go build cache according to the Go version, platform, architecture, go tags, and hash of `go.sum` that relates to each individual build workflow. This reduces the amount of time it will take to download the cache on hits and upload the cache on misses. * Parallel build workflows won't clobber each others build cache. This results in much faster compile times after cache hits because the Go compiler can reuse the platform, architecture, and tag specific build cache that it created on prior runs. * Older modules and build cache will not be uploaded when creating a new cache. This should result in lean cache sizes on an ongoing basis. * On cache misses we will have to upload our compressed module and build cache. This will slightly extend the build time for pull requests that modify `go.sum`. Web UI ------ We no longer build the web UI in every build workflow. Instead we separate the UI building into its own workflow and cache the resulting assets. The same UI assets are restored from cache during build worklows. This strategy has the following properties: * If the `ui` directory has not changed from prior builds we'll restore `http/web_ui` from cache and skip building the UI for no reason. * We continue to use the built-in `yarn` caching functionality in `action/setup-node`. The default mode saves the `yarn` global cache. to improve UI build times if the cache has not been modified. Changes ------- * Add per platform/archicture Go module and build caching * Move UI building into a separate job and cache the result * Restore UI cache during build * Pin workflows Notes ----- [0] https://hashicorp.atlassian.net/browse/QT-578 [1] https://github.com/hashicorp/vault/actions/runs/5415830307/jobs/9844829929 Signed-off-by: Ryan Cragun <me@ryan.ec>
114 lines
4.6 KiB
YAML
114 lines
4.6 KiB
YAML
---
|
|
name: enos-k8s
|
|
|
|
on:
|
|
workflow_call:
|
|
inputs:
|
|
artifact-build-date:
|
|
required: false
|
|
type: string
|
|
artifact-name:
|
|
required: true
|
|
type: string
|
|
artifact-revision:
|
|
required: true
|
|
type: string
|
|
artifact-version:
|
|
required: true
|
|
type: string
|
|
|
|
env:
|
|
ARTIFACT_BUILD_DATE: ${{ inputs.artifact-build-date }}
|
|
ARTIFACT_NAME: ${{ inputs.artifact-name }}
|
|
ARTIFACT_REVISION: ${{ inputs.artifact-revision }}
|
|
ARTIFACT_VERSION: ${{ inputs.artifact-version }}
|
|
|
|
jobs:
|
|
enos:
|
|
name: Integration
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.ELEVATED_GITHUB_TOKEN }}
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
|
|
- name: Set up Terraform
|
|
uses: hashicorp/setup-terraform@v2
|
|
with:
|
|
# the Terraform wrapper will break Terraform execution in Enos because
|
|
# it changes the output to text when we expect it to be JSON.
|
|
terraform_wrapper: false
|
|
- name: Set up Enos
|
|
uses: hashicorp/action-setup-enos@v1
|
|
with:
|
|
github-token: ${{ secrets.ELEVATED_GITHUB_TOKEN }}
|
|
- name: Download Docker Image
|
|
id: download
|
|
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
|
|
with:
|
|
name: ${{ inputs.artifact-name }}
|
|
path: ./enos/support/downloads
|
|
- name: Prepare for scenario execution
|
|
env:
|
|
IS_ENT: ${{ startsWith(env.ARTIFACT_NAME, 'vault-enterprise' ) }}
|
|
run: |
|
|
mkdir -p ./enos/support/terraform-plugin-cache
|
|
if [ "$IS_ENT" == true ]; then
|
|
echo "${{ secrets.VAULT_LICENSE }}" > ./enos/support/vault.hclic || true
|
|
echo "edition=ent" >> "$GITHUB_ENV"
|
|
echo "edition set to 'ent'"
|
|
echo "image_repo=hashicorp/vault-enterprise" >> "$GITHUB_ENV"
|
|
echo "image repo set to 'hashicorp/vault-enterprise'"
|
|
else
|
|
echo "edition=oss" >> "$GITHUB_ENV"
|
|
echo "edition set to 'oss'"
|
|
echo "image_repo=hashicorp/vault" >> "$GITHUB_ENV"
|
|
echo "image repo set to 'hashicorp/vault'"
|
|
fi
|
|
- name: Run Enos scenario
|
|
id: run
|
|
# Continue once and retry to handle occasional blips when creating
|
|
# infrastructure.
|
|
continue-on-error: true
|
|
env:
|
|
ENOS_VAR_tfc_api_token: ${{ secrets.TF_API_TOKEN }}
|
|
ENOS_VAR_terraform_plugin_cache_dir: ../support/terraform-plugin-cache
|
|
ENOS_VAR_vault_build_date: ${{ env.ARTIFACT_BUILD_DATE }}
|
|
ENOS_VAR_vault_product_version: ${{ env.ARTIFACT_VERSION }}
|
|
ENOS_VAR_vault_product_revision: ${{ env.ARTIFACT_REVISION }}
|
|
ENOS_VAR_vault_docker_image_archive: ${{steps.download.outputs.download-path}}/${{ env.ARTIFACT_NAME }}
|
|
ENOS_VAR_vault_image_repository: ${{ env.image_repo }}
|
|
run: |
|
|
enos scenario run --timeout 10m0s --chdir ./enos/k8s edition:${{ env.edition }}
|
|
- name: Retry Enos scenario
|
|
id: run_retry
|
|
if: steps.run.outcome == 'failure'
|
|
env:
|
|
ENOS_VAR_tfc_api_token: ${{ secrets.TF_API_TOKEN }}
|
|
ENOS_VAR_terraform_plugin_cache_dir: ../support/terraform-plugin-cache
|
|
ENOS_VAR_vault_build_date: ${{ env.ARTIFACT_BUILD_DATE }}
|
|
ENOS_VAR_vault_product_version: ${{ env.ARTIFACT_VERSION }}
|
|
ENOS_VAR_vault_product_revision: ${{ env.ARTIFACT_REVISION }}
|
|
ENOS_VAR_vault_docker_image_archive: ${{steps.download.outputs.download-path}}/${{ env.ARTIFACT_NAME }}
|
|
ENOS_VAR_vault_image_repository: ${{ env.image_repo }}
|
|
run: |
|
|
enos scenario run --timeout 10m0s --chdir ./enos/k8s edition:${{ env.edition }}
|
|
- name: Destroy Enos scenario
|
|
if: ${{ always() }}
|
|
env:
|
|
ENOS_VAR_tfc_api_token: ${{ secrets.TF_API_TOKEN }}
|
|
ENOS_VAR_terraform_plugin_cache_dir: ./support/terraform-plugin-cache
|
|
ENOS_VAR_vault_build_date: ${{ env.ARTIFACT_BUILD_DATE }}
|
|
ENOS_VAR_vault_product_version: ${{ env.ARTIFACT_VERSION }}
|
|
ENOS_VAR_vault_product_revision: ${{ env.ARTIFACT_REVISION }}
|
|
ENOS_VAR_vault_docker_image_archive: ${{steps.download.outputs.download-path}}
|
|
ENOS_VAR_vault_image_repository: ${{ env.image_repo }}
|
|
run: |
|
|
enos scenario destroy --timeout 10m0s --chdir ./enos/k8s edition:${{ env.edition }}
|
|
- name: Cleanup Enos runtime directories
|
|
if: ${{ always() }}
|
|
run: |
|
|
rm -rf /tmp/enos*
|
|
rm -rf ./enos/support
|
|
rm -rf ./enos/k8s/.enos
|