From 8b91d892f948b164ab96696b30692db4ba6db8fb Mon Sep 17 00:00:00 2001 From: Sachin Date: Thu, 28 Nov 2024 15:32:54 +0530 Subject: [PATCH 1/3] add pipleline for build, publish, test cases Signed-off-by: Sachin --- .github/workflows/habitat-build.yml | 116 ++++++++++++++++++++++++++ .github/workflows/habitat-publish.yml | 113 +++++++++++++++++++++++++ .github/workflows/verify-tests.yml | 45 ++++++++++ habitat/tests/test.ps1 | 21 +++++ habitat/tests/test.sh | 23 +++++ 5 files changed, 318 insertions(+) create mode 100644 .github/workflows/habitat-build.yml create mode 100644 .github/workflows/habitat-publish.yml create mode 100644 .github/workflows/verify-tests.yml create mode 100644 habitat/tests/test.ps1 create mode 100644 habitat/tests/test.sh diff --git a/.github/workflows/habitat-build.yml b/.github/workflows/habitat-build.yml new file mode 100644 index 000000000..70aaa750a --- /dev/null +++ b/.github/workflows/habitat-build.yml @@ -0,0 +1,116 @@ +name: Build Habitat packages + +on: + push: + branches: + - workstation-LTS + pull_request: + branches: + - workstation-LTS + +env: + # BLDR URL Defined as: 'https://bldr.habitat.sh/' but as an env var in workspace settings. + BLDR_URL: ${{vars.BLDR_URL}} + # HAB_ORIGIN Defined as: 'chef' defined in workspace settings. + HAB_ORIGIN: ${{vars.HAB_ORIGIN}} + # BLDR_CHANNEL defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment + BLDR_CHANNEL: ${{ vars.BLDR_CHANNEL }} + # HABITAT_VERSION_SET this is the version of habitat CLI you are using, defaults to latest. + HABITAT_VERSION_SET: ${{vars.HABITAT_VERSION_SET}} + # HAB_AUTH_TOKEN your orgs/projects auth token value + HAB_AUTH_TOKEN: ${{ secrets.HAB_AUTH_TOKEN }} + # HABITAT_TARGET this is the CPU arch for the linux CLI tool, its defaulted to x86_64 + #HABITAT_TARGET: $#{{vars.HABITAT_TARGET}} + HAB_FALLBACK_CHANNEL: ${{vars.HAB_FALLBACK_CHANNEL}} + +permissions: + contents: write + +jobs: + pre-build: + name: Setup before building packages + runs-on: ubuntu-latest + outputs: + app_version: ${{ steps.app_version.outputs.APP_VERSION }} + steps: + - name: Get branch name + id: get_branch_name + run: | + echo "BRANCH_NAME=${GITHUB_REF_NAME//\//-}" >> "$GITHUB_OUTPUT" + - name: Get version from tag + id: app_version + run: | + echo "APP_VERSION=${{ github.ref_type == 'tag' && github.ref_name || format('{0}-{1}', steps.get_branch_name.outputs.BRANCH_NAME, github.sha) }}" >> "$GITHUB_OUTPUT" + agent-matrix: + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest] + # matrix strategy is described at https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs + + runs-on: ${{ matrix.os }} + # free runner types are https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners + # from macos-latest, windows-latest, ubuntu-latest, ubuntu-20.04, ubuntu-18.04, ubuntu-16.04, windows-2019, windows-2016 + # included software packages on runners are at https://github.com/actions/runner-images#available-images + # defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment + # environment: unstable + steps: + - name: print OS + run: echo "--- ${{ matrix.os }}" + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + + - name: install habitat on Linux + if: ${{ matrix.os == 'ubuntu-latest' }} + shell: bash + run: | + echo "--- STARTING HAB INSTALL ON ${{ matrix.os }} UBUNTU with habitat version:${{vars.HABITAT_VERSION_SET}}" + export HABITAT_VERSION="${{vars.HABITAT_VERSION_SET}}" + export HAB_FALLBACK_CHANNEL="${{vars.HAB_FALLBACK_CHANNEL}}" + HABITAT_VERSION="${HABITAT_VERSION:?HABITAT_VERSION must be set}" + HABITAT_TARGET="${HABITAT_TARGET:-x86_64-linux}" + curl https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh | sudo bash -s -- -v "$HABITAT_VERSION" -t "$HABITAT_TARGET" + - name: run Habitat packaging (linux) + if: ${{ matrix.os == 'ubuntu-latest' }} + shell: bash + run: | + hab license accept + hab origin key download $HAB_ORIGIN + hab origin key download --auth $HAB_AUTH_TOKEN --secret $HAB_ORIGIN + echo "--- running linux hab build" + hab pkg build . + hartfile=$(ls ./results | grep "berkshelf" | tail -n 1) + sudo hab license accept + export CHEF_LICENSE="accept-no-persist" + export HAB_LICENSE="accept-no-persist" + export HAB_NONINTERACTIVE="true" + sudo hab pkg install ./results/$hartfile + . ./results/last_build.env + export pkg_ident + chmod +x habitat/tests/test.sh + habitat/tests/test.sh + - name: Install Habitat on Windows + if: ${{ matrix.os == 'windows-latest' }} + shell: pwsh + run: | + write-output "--- STARTING HAB INSTALL ON ${{ matrix.os }} WINDOWS with habitat version:${{vars.HABITAT_VERSION_SET}}" + $env:HAB_LICENSE = "accept-no-persist" + $env:HAB_FALLBACK_CHANNEL= "${{vars.HAB_FALLBACK_CHANNEL}}" + Invoke-Expression "& { $(Invoke-RestMethod https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.ps1) } -Version ${{vars.HABITAT_VERSION_SET}}" + - name: run habitat packaging windows + if: ${{ matrix.os == 'windows-latest' }} + shell: pwsh + run: | + $env:Path += ";C:\ProgramData\Habitat" + hab license accept + hab origin key download ${{ env.HAB_ORIGIN }} + hab origin key download --auth ${{ secrets.HAB_AUTH_TOKEN }} --secret ${{ env.HAB_ORIGIN }} + write-output "--- running windows hab build" + hab pkg build . + $hartfile=(ls ./results -Name | findstr "berkshelf") + hab pkg install ./results/$hartfile + . ./results/last_build.ps1 + habitat/tests/test.ps1 $pkg_ident \ No newline at end of file diff --git a/.github/workflows/habitat-publish.yml b/.github/workflows/habitat-publish.yml new file mode 100644 index 000000000..dc5c69273 --- /dev/null +++ b/.github/workflows/habitat-publish.yml @@ -0,0 +1,113 @@ +name: Publish Habitat packages + +on: + push: + branches: + - workstation-LTS + release: + types: + - created + +env: + # BLDR URL Defined as: 'https://bldr.habitat.sh/' but as an env var in workspace settings. + BLDR_URL: ${{vars.BLDR_URL}} + # HAB_ORIGIN Defined as: 'chef' defined in workspace settings. + HAB_ORIGIN: ${{vars.HAB_ORIGIN}} + # BLDR_CHANNEL defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment + BLDR_CHANNEL: ${{ vars.BLDR_CHANNEL }} + # HABITAT_VERSION_SET this is the version of habitat CLI you are using, defaults to latest. + HABITAT_VERSION_SET: ${{vars.HABITAT_VERSION_SET}} + # HAB_PACKAGE is the name of the project you are on, IE: node-management-agent + HAB_PACKAGE: ${{vars.HAB_PACKAGE}} + # HAB_AUTH_TOKEN your orgs/projects auth token value + HAB_AUTH_TOKEN: ${{ secrets.HAB_AUTH_TOKEN }} + HAB_FALLBACK_CHANNEL: ${{vars.HAB_FALLBACK_CHANNEL}} + # HABITAT_TARGET this is the CPU arch for the linux CLI tool, its defaulted to x86_64 + #HABITAT_TARGET: $#{{vars.HABITAT_TARGET}} + # org-wide access token on https://github.com/organizations/progress-platform-services/settings/secrets/actions + +permissions: + contents: write + +jobs: + pre-build: + name: Setup before building packages + runs-on: ubuntu-latest + outputs: + app_version: ${{ steps.app_version.outputs.APP_VERSION }} + steps: + - name: Get branch name + id: get_branch_name + run: | + echo "BRANCH_NAME=${GITHUB_REF_NAME//\//-}" >> "$GITHUB_OUTPUT" + - name: Get version from tag + id: app_version + run: | + echo "APP_VERSION=${{ github.ref_type == 'tag' && github.ref_name || format('{0}-{1}', steps.get_branch_name.outputs.BRANCH_NAME, github.sha) }}" >> "$GITHUB_OUTPUT" + agent-matrix: + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest] + # matrix strategy is described at https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs + + runs-on: ${{ matrix.os }} + # free runner types are https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners + # from macos-latest, windows-latest, ubuntu-latest, ubuntu-20.04, ubuntu-18.04, ubuntu-16.04, windows-2019, windows-2016 + # included software packages on runners are at https://github.com/actions/runner-images#available-images + # environment: unstable + steps: + - name: print OS + run: echo "--- ${{ matrix.os }}" + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + + - name: install habitat on Linux + if: ${{ matrix.os == 'ubuntu-latest' }} + shell: bash + run: | + echo "--- STARTING HAB INSTALL ON ${{ matrix.os }} UBUNTU with habitat version:${{vars.HABITAT_VERSION_SET}}" + export HABITAT_VERSION="${{vars.HABITAT_VERSION_SET}}" + HABITAT_VERSION="${HABITAT_VERSION:?HABITAT_VERSION must be set}" + HABITAT_TARGET="${HABITAT_TARGET:-x86_64-linux}" + export HAB_FALLBACK_CHANNEL="${{vars.HAB_FALLBACK_CHANNEL}}" + curl https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh | sudo bash -s -- -v "$HABITAT_VERSION" -t "$HABITAT_TARGET" + - name: run Habitat packaging (linux) + if: ${{ matrix.os == 'ubuntu-latest' }} + shell: bash + run: | + hab license accept + hab origin key download $HAB_ORIGIN + hab origin key download --auth $HAB_AUTH_TOKEN --secret $HAB_ORIGIN + echo "--- running linux hab build" + hab pkg build . + echo "--- pushing to ${{ env.BLDR_URL }}/#/${{ env.HAB_ORIGIN }}/${{ env.HAB_PACKAGE }}..." + source results/last_build.env + hab pkg upload --auth $HAB_AUTH_TOKEN results/$pkg_artifact + echo "--- push complete!!" + - name: Install Habitat on Windows + if: ${{ matrix.os == 'windows-latest' }} + shell: pwsh + run: | + write-output "--- STARTING HAB INSTALL ON ${{ matrix.os }} WINDOWS with habitat version:${{vars.HABITAT_VERSION_SET}}" + $env:HAB_LICENSE = "accept-no-persist" + $env:HAB_FALLBACK_CHANNEL= "${{vars.HAB_FALLBACK_CHANNEL}}" + Invoke-Expression "& { $(Invoke-RestMethod https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.ps1) } -Version ${{vars.HABITAT_VERSION_SET}}" + - name: run habitat packaging windows + if: ${{ matrix.os == 'windows-latest' }} + shell: pwsh + run: | + $env:Path += ";C:\ProgramData\Habitat" + hab license accept + hab origin key download ${{ env.HAB_ORIGIN }} + hab origin key download --auth ${{ secrets.HAB_AUTH_TOKEN }} --secret ${{ env.HAB_ORIGIN }} + write-output "--- running windows hab build" + hab pkg build . + write-output "--- pushing hab to unstable channel" + . results\last_build.ps1 + hab pkg upload results\$pkg_artifact --auth ${{ secrets.HAB_AUTH_TOKEN }} + write-output "--- push complete!!" + outreach \ No newline at end of file diff --git a/.github/workflows/verify-tests.yml b/.github/workflows/verify-tests.yml new file mode 100644 index 000000000..b102568a6 --- /dev/null +++ b/.github/workflows/verify-tests.yml @@ -0,0 +1,45 @@ +name: Run Rake Tests + +on: + push: + branches: + - workstation-LTS + pull_request: + branches: + - workstation-LTS + +jobs: + unit-tests: + name: Execute Tests cases + runs-on: ubuntu-latest + + steps: + # Step 1: Checkout the code + - name: Checkout Code + uses: actions/checkout@v4 + + # Step 2: Set up Ruby + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: 3.1 # Use Ruby 3.1 as specified + + # Step 3: Install system dependencies + - name: Install Dependencies + run: | + sudo apt-get update -y + sudo apt-get install -y graphviz + + # Step 4: Install project dependencies + - name: Install Bundler and Dependencies + run: | + rm -f .bundle/config + gem install bundler + bundle config set --local path 'vendor/bundle' + bundle install --jobs=3 --retry=3 + + # Step 5: Run the Rake tests + - name: Run Rake Tests + run: | + bundle exec rake + diff --git a/habitat/tests/test.ps1 b/habitat/tests/test.ps1 new file mode 100644 index 000000000..be2b6e579 --- /dev/null +++ b/habitat/tests/test.ps1 @@ -0,0 +1,21 @@ +param ( + [Parameter()] + [string]$PackageIdentifier = $(throw "Usage: test.ps1 [test_pkg_ident] e.g. test.ps1 ci/user-windows/1.0.0/20190812103929") +) + +Write-Host "--- :fire: Smokish test" + + +$version=hab pkg exec "${pkg_ident}" berks -v +$actual_version=[Regex]::Match($version,"([0-9]+.[0-9]+.[0-9]+)").Value +$package_version=$PackageIdentifier.split("/",4)[2] + +Write-Host "package_version $package_version actual version $actual_version" +if ($package_version -eq $actual_version) +{ + Write "Berkshelf working fine" +} +else { + Write-Error "Berkshelf version not met expected $package_version actual version $actual_version " + throw "Berkshelf windows pipeline not working for hab pkg" +} \ No newline at end of file diff --git a/habitat/tests/test.sh b/habitat/tests/test.sh new file mode 100644 index 000000000..d84a2a7d5 --- /dev/null +++ b/habitat/tests/test.sh @@ -0,0 +1,23 @@ +set -euo pipefail + + +project_root="$(git rev-parse --show-toplevel)" + +# print error message followed by usage and exit +error () { + local message="$1" + + echo -e "\nERROR: ${message}\n" >&2 + + exit 1 +} + +[[ -n "$pkg_ident" ]] || error 'no hab package identity provided' + +package_version=$(awk -F / '{print $3}' <<<"$pkg_ident") + +cd "${project_root}" + +echo "--- :msg_right: Testing ${pkg_ident} executables" +actual_version=$(hab pkg exec "${pkg_ident}" berks -v | sed -E 's/.*: ([0-9]+\.[0-9]+\.[0-9]+).*/\1/') +[[ "$package_version" = "$actual_version" ]] || error "Berkshelf version is not the expected version. Expected '$package_version', got '$actual_version'" From b8d1e79eeba90085542a71d1f3755a8f7868606d Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Sat, 7 Dec 2024 22:53:05 +0530 Subject: [PATCH 2/3] updating pipeline to run on expeditor instead of github actions Signed-off-by: nikhil2611 --- .expeditor/build.habitat.yml | 9 ++ .../buildkite/artifact.habitat.test.ps1 | 86 ++++++++++++ .expeditor/buildkite/artifact.habitat.test.sh | 71 ++++++++++ .expeditor/habitat-test.pipeline.yml | 35 +++++ habitat/plan.ps1 | 2 +- habitat/plan.sh | 130 +++++++----------- habitat/tests/test.sh | 3 +- 7 files changed, 251 insertions(+), 85 deletions(-) create mode 100644 .expeditor/build.habitat.yml create mode 100644 .expeditor/buildkite/artifact.habitat.test.ps1 create mode 100644 .expeditor/buildkite/artifact.habitat.test.sh create mode 100644 .expeditor/habitat-test.pipeline.yml diff --git a/.expeditor/build.habitat.yml b/.expeditor/build.habitat.yml new file mode 100644 index 000000000..9c2d3d7a2 --- /dev/null +++ b/.expeditor/build.habitat.yml @@ -0,0 +1,9 @@ +--- +origin: chef + +expeditor: + defaults: + buildkite: + retry: + automatic: + limit: 1 \ No newline at end of file diff --git a/.expeditor/buildkite/artifact.habitat.test.ps1 b/.expeditor/buildkite/artifact.habitat.test.ps1 new file mode 100644 index 000000000..2f7dc420e --- /dev/null +++ b/.expeditor/buildkite/artifact.habitat.test.ps1 @@ -0,0 +1,86 @@ +#!/usr/bin/env powershell + +#Requires -Version 5 +# https://stackoverflow.com/questions/9948517 +# TODO: Set-StrictMode -Version Latest +$PSDefaultParameterValues['*:ErrorAction']='Stop' +$ErrorActionPreference = 'Stop' +$env:HAB_BLDR_CHANNEL = "LTS-2024" +$env:HAB_ORIGIN = 'ci' +$env:CHEF_LICENSE = 'accept-no-persist' +$env:HAB_LICENSE = 'accept-no-persist' +$Plan = 'berkshelf' + +Write-Host "--- system details" +$Properties = 'Caption', 'CSName', 'Version', 'BuildType', 'OSArchitecture' +Get-CimInstance Win32_OperatingSystem | Select-Object $Properties | Format-Table -AutoSize + +Write-Host "--- Installing the version of Habitat required" + +function Stop-HabProcess { + $habProcess = Get-Process hab -ErrorAction SilentlyContinue + if ($habProcess) { + Write-Host "Stopping hab process..." + Stop-Process -Name hab -Force + } +} + +# Installing Habitat +function Install-Habitat { + Write-Host "Downloading and installing Habitat..." + Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.ps1')) +} + +try { + hab --version +} +catch { + Set-ExecutionPolicy Bypass -Scope Process -Force + + Stop-HabProcess + + # Remove the existing hab.exe if it exists and if you have permissions + $habPath = "C:\ProgramData\Habitat\hab.exe" + if (Test-Path $habPath) { + Write-Host "Attempting to remove existing hab.exe..." + Remove-Item $habPath -Force -ErrorAction SilentlyContinue + if (Test-Path $habPath) { + Write-Host "Failed to remove hab.exe, re-running script with elevated permissions." + Start-Process powershell -Verb runAs -ArgumentList "-NoProfile -ExecutionPolicy Bypass -File `"$PSCommandPath`"" + exit + } + } + + Install-Habitat +} +finally { + Write-Host ":habicat: I think I have the version I need to build." +} + + +Write-Host "--- Generating fake origin key" +hab origin key generate $env:HAB_ORIGIN + +Write-Host "--- Building $Plan" +$project_root = "$(git rev-parse --show-toplevel)" +Set-Location $project_root + +$env:DO_CHECK=$true; hab pkg build . + +. $project_root/results/last_build.ps1 + +Write-Host "--- Installing $pkg_ident/$pkg_artifact" +hab pkg install -b $project_root/results/$pkg_artifact + +Write-Host "+++ Testing $Plan" + +Push-Location $project_root + +try { + Write-Host "Running unit tests..." + habitat/tests/test.ps1 $pkg_ident +} +finally { + # Ensure we always return to the original directory + Pop-Location +} \ No newline at end of file diff --git a/.expeditor/buildkite/artifact.habitat.test.sh b/.expeditor/buildkite/artifact.habitat.test.sh new file mode 100644 index 000000000..27dc4c9a2 --- /dev/null +++ b/.expeditor/buildkite/artifact.habitat.test.sh @@ -0,0 +1,71 @@ +#!/usr/bin/env bash + +set -eo pipefail + +export HAB_ORIGIN='ci' +export PLAN='berkshelf' +export CHEF_LICENSE="accept-no-persist" +export HAB_LICENSE="accept-no-persist" +export HAB_BLDR_CHANNEL="LTS-2024" + +echo "--- checking if git is installed" +if ! command -v git &> /dev/null; then + echo "Git is not installed. Installing Git..." + sudo yum install -y git +else + echo "Git is already installed." + git --version +fi + +echo "--- add an exception for this directory since detected dubious ownership in repository at /workdir" +git config --global --add safe.directory /workdir + +echo "--- git status for this workdir" +git status + +echo "--- ruby version" +ruby -v + +export project_root="$(git rev-parse --show-toplevel)" +echo "The value for project_root is: $project_root" + +export HAB_NONINTERACTIVE=true +export HAB_NOCOLORING=true +export HAB_STUDIO_SECRET_HAB_NONINTERACTIVE=true + +echo "--- system details" +uname -a + +echo "--- Installing Habitat" +id -a +curl https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.sh | bash + +echo "--- :key: Generating fake origin key" +hab origin key generate "$HAB_ORIGIN" + + +echo "--- Building $PLAN" +cd "$project_root" +DO_CHECK=true hab pkg build . + +echo "--- Sourcing 'results/last_build.sh'" +if [ -f ./results/last_build.env ]; then + cat ./results/last_build.env + . ./results/last_build.env + export pkg_artifact +fi + +echo "+++ Installing ${pkg_ident:?is undefined}" +echo "++++" +echo $project_root +echo "+++" +hab pkg install -b "${project_root:?is undefined}/results/${pkg_artifact:?is undefined}" + +echo "+++ Testing $PLAN" + +PATH="$(hab pkg path ci/berkshelf)/bin:$PATH" +export PATH +echo "PATH is $PATH" + +echo "--- :mag_right: Testing $PLAN" +${project_root}/habitat/tests/test.sh "$pkg_ident" || error 'failures during test of executables' \ No newline at end of file diff --git a/.expeditor/habitat-test.pipeline.yml b/.expeditor/habitat-test.pipeline.yml new file mode 100644 index 000000000..39493f20c --- /dev/null +++ b/.expeditor/habitat-test.pipeline.yml @@ -0,0 +1,35 @@ +--- +expeditor: + defaults: + buildkite: + timeout_in_minutes: 30 + retry: + automatic: + limit: 1 + +steps: + + - label: ":linux: Validate Habitat Builds of Berkshelf" + commands: + - .expeditor/buildkite/artifact.habitat.test.sh + expeditor: + executor: + docker: + image: ruby:3.1 + privileged: true + + - label: ":windows: Validate Habitat Builds of Berkshelf" + commands: + - .expeditor/buildkite/artifact.habitat.test.ps1 + expeditor: + executor: + docker: + host_os: windows + shell: ["powershell", "-Command"] + image: rubydistros/windows-2019:3.1 + user: 'NT AUTHORITY\SYSTEM' + environment: + - FORCE_FFI_YAJL=ext + - EXPIRE_CACHE=true + - CHEF_LICENSE=accept-no-persist + - CHEF_LICENSE_SERVER=http://hosted-license-service-lb-8000-606952349.us-west-2.elb.amazonaws.com:8000/ diff --git a/habitat/plan.ps1 b/habitat/plan.ps1 index 537901284..034692d0a 100644 --- a/habitat/plan.ps1 +++ b/habitat/plan.ps1 @@ -1,6 +1,7 @@ $ErrorActionPreference = "Stop" $PSDefaultParameterValues['*:ErrorAction']='Stop' +$env:HAB_BLDR_CHANNEL = "LTS-2024" $pkg_name="berkshelf" $pkg_origin="chef" $pkg_version=$(Get-Content "$PLAN_CONTEXT/../VERSION") @@ -48,7 +49,6 @@ function Invoke-Build { gem build berkshelf.gemspec Write-BuildLine " ** Using gem to install" gem install berkshelf-*.gem --no-document - If ($lastexitcode -ne 0) { Exit $lastexitcode } } finally { diff --git a/habitat/plan.sh b/habitat/plan.sh index 237ba2e2f..ed231a9ec 100644 --- a/habitat/plan.sh +++ b/habitat/plan.sh @@ -1,8 +1,9 @@ -_chef_client_ruby="core/ruby31" +export HAB_BLDR_CHANNEL="LTS-2024" +_chef_client_ruby="core/ruby3_1" pkg_name="berkshelf" -pkg_origin=chef +pkg_origin="chef" pkg_maintainer="The Chef Maintainers " -pkg_description="Manage Chef Infra cookbooks and cookbook dependencies" +pkg_description="Manage Chef Infra cookbooks and cookbook dependencies." pkg_license=('Apache-2.0') pkg_bin_dirs=( bin @@ -10,116 +11,79 @@ pkg_bin_dirs=( ) pkg_build_deps=( core/make + core/bash core/gcc - core/git ) pkg_deps=( $_chef_client_ruby core/coreutils + core/git ) pkg_svc_user=root pkg_version() { - cat "${SRC_PATH}/VERSION" + cat "$SRC_PATH/VERSION" } do_before() { - do_default_before update_pkg_version - # We must wait until we update the pkg_version to use the pkg_version - pkg_filename="${pkg_name}-${pkg_version}.tar.gz" -} - -do_download() { - build_line "Locally creating archive of latest repository commit at ${HAB_CACHE_SRC_PATH}/${pkg_filename}" - # source is in this repo, so we're going to create an archive from the - # appropriate path within the repo and place the generated tarball in the - # location expected by do_unpack - ( cd "${SRC_PATH}" || exit_with "unable to enter hab-src directory" 1 - git archive --prefix="${pkg_name}-${pkg_version}/" --output="${HAB_CACHE_SRC_PATH}/${pkg_filename}" HEAD - ) } -do_verify() { - build_line "Skipping checksum verification on the archive we just created." - return 0 +do_unpack() { + mkdir -pv "$HAB_CACHE_SRC_PATH/$pkg_dirname" + cp -RT "$PLAN_CONTEXT"/.. "$HAB_CACHE_SRC_PATH/$pkg_dirname/" } -# Setup environment variables for Ruby Gems -do_setup_environment() { - push_runtime_env GEM_PATH "${pkg_prefix}/vendor" +do_build() { + echo $(pkg_path_for $_chef_client_ruby) + export GEM_HOME="$pkg_prefix/vendor/gems" - set_runtime_env APPBUNDLER_ALLOW_RVM "true" # prevent appbundler from clearing out the carefully constructed runtime GEM_PATH - set_runtime_env LANG "en_US.UTF-8" - set_runtime_env LC_CTYPE "en_US.UTF-8" + build_line "Setting GEM_PATH=$GEM_HOME" + export GEM_PATH="$GEM_HOME" + bundle config --local without integration deploy maintenance + bundle config --local jobs 4 + bundle config --local retry 5 + bundle config --local silence_root_warning 1 + bundle install --without development --jobs=3 --retry=3 + gem build berkshelf.gemspec } -do_prepare() { - export GEM_HOME="${pkg_prefix}/vendor" - export CPPFLAGS="${CPPFLAGS} ${CFLAGS}" - - ( cd "$CACHE_PATH" - bundle config --local jobs "$(nproc)" - bundle config --local without server docgen maintenance pry travis integration ci chefstyle - bundle config --local shebang "$(pkg_path_for "$_chef_client_ruby")/bin/ruby" - bundle config --local retry 5 - bundle config --local silence_root_warning 1 - ) - - build_line "Setting link for /usr/bin/env to 'coreutils'" - if [ ! -f /usr/bin/env ]; then - ln -s "$(pkg_interpreter_for core/coreutils bin/env)" /usr/bin/env - fi -} +do_install() { + export GEM_HOME="$pkg_prefix/vendor/gems" -# Build the gem from the gemspec file -do_build() { - ( cd "$CACHE_PATH" || exit_with "unable to enter hab-cache directory" 1 - build_line "Installing gem dependencies ..." - bundle install --without development --jobs=3 --retry=3 - build_line "Installing gems from git repos properly ..." - build_line "Installing this project's gems ..." - bundle exec rake install:local - gem install chef-utils chef-config - ) + build_line "Setting GEM_PATH=$GEM_HOME" + export GEM_PATH="$GEM_HOME" + gem install berkshelf-*.gem --no-document + wrap_ruby_berkshelf + set_runtime_env "GEM_PATH" "${pkg_prefix}/vendor/gems" } -# Install the built gem into the package directory -do_install() { - ( cd "$pkg_prefix" || exit_with "unable to enter pkg prefix directory" 1 - export BUNDLE_GEMFILE="${CACHE_PATH}/Gemfile" - build_line "** fixing binstub shebangs" - fix_interpreter "${pkg_prefix}/vendor/bin/*" "$_chef_client_ruby" bin/ruby - export BUNDLE_GEMFILE="${CACHE_PATH}/Gemfile" - for gem in berkshelf; do - build_line "** generating binstubs for $gem with precise version pins" - appbundler $CACHE_PATH $pkg_prefix/bin $gem - done - ) +wrap_ruby_berkshelf() { + local bin="$pkg_prefix/bin/berks" + local real_bin="$GEM_HOME/gems/berkshelf-${pkg_version}/bin/berks" + wrap_bin_with_ruby "$bin" "$real_bin" } -do_after() { - build_line "Trimming the fat ..." +wrap_bin_with_ruby() { + local bin="$1" + local real_bin="$2" + build_line "Adding wrapper $bin to $real_bin" + cat < "$bin" +#!$(pkg_path_for core/bash)/bin/bash +set -e - # We don't need the cache of downloaded .gem files ... - rm -rf "$pkg_prefix/vendor/cache" +# Set binary path that allows berkshelf to use non-Hab pkg binaries +export PATH="/sbin:/usr/sbin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:\$PATH" - # We don't need the gem docs. - rm -rf "$pkg_prefix/vendor/doc" - # We don't need to ship the test suites for every gem dependency, - # only Chef's for package verification. - find "$pkg_prefix/vendor/gems" -name spec -type d | grep -v "berkshelf-${pkg_version}" \ - | while read spec_dir; do rm -rf "$spec_dir"; done -} +# Set Ruby paths defined from 'do_setup_environment()' +export GEM_HOME="$pkg_prefix/vendor/gems" +export GEM_PATH="\$GEM_HOME" -do_end() { - if [ "$(readlink /usr/bin/env)" = "$(pkg_interpreter_for core/coreutils bin/env)" ]; then - build_line "Removing the symlink we created for '/usr/bin/env'" - rm /usr/bin/env - fi +exec $(pkg_path_for $_chef_client_ruby)/bin/ruby $real_bin \$@ +EOF + chmod -v 755 "$bin" } -# No additional stripping needed do_strip() { return 0 } \ No newline at end of file diff --git a/habitat/tests/test.sh b/habitat/tests/test.sh index d84a2a7d5..5858ae1ac 100644 --- a/habitat/tests/test.sh +++ b/habitat/tests/test.sh @@ -2,6 +2,7 @@ set -euo pipefail project_root="$(git rev-parse --show-toplevel)" +pkg_ident="$1" # print error message followed by usage and exit error () { @@ -18,6 +19,6 @@ package_version=$(awk -F / '{print $3}' <<<"$pkg_ident") cd "${project_root}" -echo "--- :msg_right: Testing ${pkg_ident} executables" +echo "--- :mag_right: Testing ${pkg_ident} executables" actual_version=$(hab pkg exec "${pkg_ident}" berks -v | sed -E 's/.*: ([0-9]+\.[0-9]+\.[0-9]+).*/\1/') [[ "$package_version" = "$actual_version" ]] || error "Berkshelf version is not the expected version. Expected '$package_version', got '$actual_version'" From ed57bac016c26ca3b935803bd59048ce7aacd0c6 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Sat, 7 Dec 2024 23:26:02 +0530 Subject: [PATCH 3/3] updating pipeline to run on expeditor instead of github actions Signed-off-by: nikhil2611 --- .expeditor/config.yml | 29 +++++++ .github/workflows/habitat-build.yml | 116 -------------------------- .github/workflows/habitat-publish.yml | 113 ------------------------- .github/workflows/verify-tests.yml | 45 ---------- 4 files changed, 29 insertions(+), 274 deletions(-) delete mode 100644 .github/workflows/habitat-build.yml delete mode 100644 .github/workflows/habitat-publish.yml delete mode 100644 .github/workflows/verify-tests.yml diff --git a/.expeditor/config.yml b/.expeditor/config.yml index 162c837fa..f52f4b0bb 100644 --- a/.expeditor/config.yml +++ b/.expeditor/config.yml @@ -22,6 +22,8 @@ github: - "Expeditor: Bump Version Major" release_branches: + - workstation-LTS: + version_constraint: 8* - main: version_constraint: 8* @@ -44,10 +46,24 @@ subscriptions: - "Expeditor: Skip All" - built_in:build_gem: only_if: built_in:bump_version + - trigger_pipeline:habitat/test: + only_if: built_in:bump_version + ignore_labels: + - "Expeditor: Skip Habitat" + - "Expeditor: Skip All" + - trigger_pipeline:habitat/build: + only_if: built_in:bump_version + ignore_labels: + - "Expeditor: Skip Habitat" + - "Expeditor: Skip All" - workload: project_promoted:{{agent_id}}:* actions: - built_in:rollover_changelog - built_in:publish_rubygems + - workload: buildkite_hab_build_group_published:{{agent_id}}:* + actions: + # when all of the hab package publish to the unstable channel, test and promote them + - trigger_pipeline:habitat/test pipelines: - verify: @@ -55,3 +71,16 @@ pipelines: public: true env: - IGNORE_CACHE: true + - habitat/build: + env: + - HAB_NONINTERACTIVE: "true" + - HAB_NOCOLORING: "true" + - HAB_STUDIO_SECRET_HAB_NONINTERACTIVE: "true" + - habitat/test: + description: Execute tests against the habitat artifact + definition: .expeditor/habitat-test.pipeline.yml + env: + - HAB_NONINTERACTIVE: "true" + - HAB_NOCOLORING: "true" + - HAB_STUDIO_SECRET_HAB_NONINTERACTIVE: "true" + trigger: pull_request diff --git a/.github/workflows/habitat-build.yml b/.github/workflows/habitat-build.yml deleted file mode 100644 index 70aaa750a..000000000 --- a/.github/workflows/habitat-build.yml +++ /dev/null @@ -1,116 +0,0 @@ -name: Build Habitat packages - -on: - push: - branches: - - workstation-LTS - pull_request: - branches: - - workstation-LTS - -env: - # BLDR URL Defined as: 'https://bldr.habitat.sh/' but as an env var in workspace settings. - BLDR_URL: ${{vars.BLDR_URL}} - # HAB_ORIGIN Defined as: 'chef' defined in workspace settings. - HAB_ORIGIN: ${{vars.HAB_ORIGIN}} - # BLDR_CHANNEL defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment - BLDR_CHANNEL: ${{ vars.BLDR_CHANNEL }} - # HABITAT_VERSION_SET this is the version of habitat CLI you are using, defaults to latest. - HABITAT_VERSION_SET: ${{vars.HABITAT_VERSION_SET}} - # HAB_AUTH_TOKEN your orgs/projects auth token value - HAB_AUTH_TOKEN: ${{ secrets.HAB_AUTH_TOKEN }} - # HABITAT_TARGET this is the CPU arch for the linux CLI tool, its defaulted to x86_64 - #HABITAT_TARGET: $#{{vars.HABITAT_TARGET}} - HAB_FALLBACK_CHANNEL: ${{vars.HAB_FALLBACK_CHANNEL}} - -permissions: - contents: write - -jobs: - pre-build: - name: Setup before building packages - runs-on: ubuntu-latest - outputs: - app_version: ${{ steps.app_version.outputs.APP_VERSION }} - steps: - - name: Get branch name - id: get_branch_name - run: | - echo "BRANCH_NAME=${GITHUB_REF_NAME//\//-}" >> "$GITHUB_OUTPUT" - - name: Get version from tag - id: app_version - run: | - echo "APP_VERSION=${{ github.ref_type == 'tag' && github.ref_name || format('{0}-{1}', steps.get_branch_name.outputs.BRANCH_NAME, github.sha) }}" >> "$GITHUB_OUTPUT" - agent-matrix: - strategy: - fail-fast: false - matrix: - os: [ubuntu-latest, windows-latest] - # matrix strategy is described at https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs - - runs-on: ${{ matrix.os }} - # free runner types are https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners - # from macos-latest, windows-latest, ubuntu-latest, ubuntu-20.04, ubuntu-18.04, ubuntu-16.04, windows-2019, windows-2016 - # included software packages on runners are at https://github.com/actions/runner-images#available-images - # defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment - # environment: unstable - steps: - - name: print OS - run: echo "--- ${{ matrix.os }}" - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - - name: install habitat on Linux - if: ${{ matrix.os == 'ubuntu-latest' }} - shell: bash - run: | - echo "--- STARTING HAB INSTALL ON ${{ matrix.os }} UBUNTU with habitat version:${{vars.HABITAT_VERSION_SET}}" - export HABITAT_VERSION="${{vars.HABITAT_VERSION_SET}}" - export HAB_FALLBACK_CHANNEL="${{vars.HAB_FALLBACK_CHANNEL}}" - HABITAT_VERSION="${HABITAT_VERSION:?HABITAT_VERSION must be set}" - HABITAT_TARGET="${HABITAT_TARGET:-x86_64-linux}" - curl https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh | sudo bash -s -- -v "$HABITAT_VERSION" -t "$HABITAT_TARGET" - - name: run Habitat packaging (linux) - if: ${{ matrix.os == 'ubuntu-latest' }} - shell: bash - run: | - hab license accept - hab origin key download $HAB_ORIGIN - hab origin key download --auth $HAB_AUTH_TOKEN --secret $HAB_ORIGIN - echo "--- running linux hab build" - hab pkg build . - hartfile=$(ls ./results | grep "berkshelf" | tail -n 1) - sudo hab license accept - export CHEF_LICENSE="accept-no-persist" - export HAB_LICENSE="accept-no-persist" - export HAB_NONINTERACTIVE="true" - sudo hab pkg install ./results/$hartfile - . ./results/last_build.env - export pkg_ident - chmod +x habitat/tests/test.sh - habitat/tests/test.sh - - name: Install Habitat on Windows - if: ${{ matrix.os == 'windows-latest' }} - shell: pwsh - run: | - write-output "--- STARTING HAB INSTALL ON ${{ matrix.os }} WINDOWS with habitat version:${{vars.HABITAT_VERSION_SET}}" - $env:HAB_LICENSE = "accept-no-persist" - $env:HAB_FALLBACK_CHANNEL= "${{vars.HAB_FALLBACK_CHANNEL}}" - Invoke-Expression "& { $(Invoke-RestMethod https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.ps1) } -Version ${{vars.HABITAT_VERSION_SET}}" - - name: run habitat packaging windows - if: ${{ matrix.os == 'windows-latest' }} - shell: pwsh - run: | - $env:Path += ";C:\ProgramData\Habitat" - hab license accept - hab origin key download ${{ env.HAB_ORIGIN }} - hab origin key download --auth ${{ secrets.HAB_AUTH_TOKEN }} --secret ${{ env.HAB_ORIGIN }} - write-output "--- running windows hab build" - hab pkg build . - $hartfile=(ls ./results -Name | findstr "berkshelf") - hab pkg install ./results/$hartfile - . ./results/last_build.ps1 - habitat/tests/test.ps1 $pkg_ident \ No newline at end of file diff --git a/.github/workflows/habitat-publish.yml b/.github/workflows/habitat-publish.yml deleted file mode 100644 index dc5c69273..000000000 --- a/.github/workflows/habitat-publish.yml +++ /dev/null @@ -1,113 +0,0 @@ -name: Publish Habitat packages - -on: - push: - branches: - - workstation-LTS - release: - types: - - created - -env: - # BLDR URL Defined as: 'https://bldr.habitat.sh/' but as an env var in workspace settings. - BLDR_URL: ${{vars.BLDR_URL}} - # HAB_ORIGIN Defined as: 'chef' defined in workspace settings. - HAB_ORIGIN: ${{vars.HAB_ORIGIN}} - # BLDR_CHANNEL defaulted to unstable, but can be switched to stable, it is defined via the environment setting https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment - BLDR_CHANNEL: ${{ vars.BLDR_CHANNEL }} - # HABITAT_VERSION_SET this is the version of habitat CLI you are using, defaults to latest. - HABITAT_VERSION_SET: ${{vars.HABITAT_VERSION_SET}} - # HAB_PACKAGE is the name of the project you are on, IE: node-management-agent - HAB_PACKAGE: ${{vars.HAB_PACKAGE}} - # HAB_AUTH_TOKEN your orgs/projects auth token value - HAB_AUTH_TOKEN: ${{ secrets.HAB_AUTH_TOKEN }} - HAB_FALLBACK_CHANNEL: ${{vars.HAB_FALLBACK_CHANNEL}} - # HABITAT_TARGET this is the CPU arch for the linux CLI tool, its defaulted to x86_64 - #HABITAT_TARGET: $#{{vars.HABITAT_TARGET}} - # org-wide access token on https://github.com/organizations/progress-platform-services/settings/secrets/actions - -permissions: - contents: write - -jobs: - pre-build: - name: Setup before building packages - runs-on: ubuntu-latest - outputs: - app_version: ${{ steps.app_version.outputs.APP_VERSION }} - steps: - - name: Get branch name - id: get_branch_name - run: | - echo "BRANCH_NAME=${GITHUB_REF_NAME//\//-}" >> "$GITHUB_OUTPUT" - - name: Get version from tag - id: app_version - run: | - echo "APP_VERSION=${{ github.ref_type == 'tag' && github.ref_name || format('{0}-{1}', steps.get_branch_name.outputs.BRANCH_NAME, github.sha) }}" >> "$GITHUB_OUTPUT" - agent-matrix: - strategy: - fail-fast: false - matrix: - os: [ubuntu-latest, windows-latest] - # matrix strategy is described at https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs - - runs-on: ${{ matrix.os }} - # free runner types are https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners - # from macos-latest, windows-latest, ubuntu-latest, ubuntu-20.04, ubuntu-18.04, ubuntu-16.04, windows-2019, windows-2016 - # included software packages on runners are at https://github.com/actions/runner-images#available-images - # environment: unstable - steps: - - name: print OS - run: echo "--- ${{ matrix.os }}" - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - - name: install habitat on Linux - if: ${{ matrix.os == 'ubuntu-latest' }} - shell: bash - run: | - echo "--- STARTING HAB INSTALL ON ${{ matrix.os }} UBUNTU with habitat version:${{vars.HABITAT_VERSION_SET}}" - export HABITAT_VERSION="${{vars.HABITAT_VERSION_SET}}" - HABITAT_VERSION="${HABITAT_VERSION:?HABITAT_VERSION must be set}" - HABITAT_TARGET="${HABITAT_TARGET:-x86_64-linux}" - export HAB_FALLBACK_CHANNEL="${{vars.HAB_FALLBACK_CHANNEL}}" - curl https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh | sudo bash -s -- -v "$HABITAT_VERSION" -t "$HABITAT_TARGET" - - name: run Habitat packaging (linux) - if: ${{ matrix.os == 'ubuntu-latest' }} - shell: bash - run: | - hab license accept - hab origin key download $HAB_ORIGIN - hab origin key download --auth $HAB_AUTH_TOKEN --secret $HAB_ORIGIN - echo "--- running linux hab build" - hab pkg build . - echo "--- pushing to ${{ env.BLDR_URL }}/#/${{ env.HAB_ORIGIN }}/${{ env.HAB_PACKAGE }}..." - source results/last_build.env - hab pkg upload --auth $HAB_AUTH_TOKEN results/$pkg_artifact - echo "--- push complete!!" - - name: Install Habitat on Windows - if: ${{ matrix.os == 'windows-latest' }} - shell: pwsh - run: | - write-output "--- STARTING HAB INSTALL ON ${{ matrix.os }} WINDOWS with habitat version:${{vars.HABITAT_VERSION_SET}}" - $env:HAB_LICENSE = "accept-no-persist" - $env:HAB_FALLBACK_CHANNEL= "${{vars.HAB_FALLBACK_CHANNEL}}" - Invoke-Expression "& { $(Invoke-RestMethod https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.ps1) } -Version ${{vars.HABITAT_VERSION_SET}}" - - name: run habitat packaging windows - if: ${{ matrix.os == 'windows-latest' }} - shell: pwsh - run: | - $env:Path += ";C:\ProgramData\Habitat" - hab license accept - hab origin key download ${{ env.HAB_ORIGIN }} - hab origin key download --auth ${{ secrets.HAB_AUTH_TOKEN }} --secret ${{ env.HAB_ORIGIN }} - write-output "--- running windows hab build" - hab pkg build . - write-output "--- pushing hab to unstable channel" - . results\last_build.ps1 - hab pkg upload results\$pkg_artifact --auth ${{ secrets.HAB_AUTH_TOKEN }} - write-output "--- push complete!!" - outreach \ No newline at end of file diff --git a/.github/workflows/verify-tests.yml b/.github/workflows/verify-tests.yml deleted file mode 100644 index b102568a6..000000000 --- a/.github/workflows/verify-tests.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Run Rake Tests - -on: - push: - branches: - - workstation-LTS - pull_request: - branches: - - workstation-LTS - -jobs: - unit-tests: - name: Execute Tests cases - runs-on: ubuntu-latest - - steps: - # Step 1: Checkout the code - - name: Checkout Code - uses: actions/checkout@v4 - - # Step 2: Set up Ruby - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 3.1 # Use Ruby 3.1 as specified - - # Step 3: Install system dependencies - - name: Install Dependencies - run: | - sudo apt-get update -y - sudo apt-get install -y graphviz - - # Step 4: Install project dependencies - - name: Install Bundler and Dependencies - run: | - rm -f .bundle/config - gem install bundler - bundle config set --local path 'vendor/bundle' - bundle install --jobs=3 --retry=3 - - # Step 5: Run the Rake tests - - name: Run Rake Tests - run: | - bundle exec rake -