CHEF-17473-Added Github action pipeline to verify build and publish package

.github/workflows/habitat-build.yml

@@ -0,0 +1,117 @@
+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 "cookstyle" | 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_NONINTERACTIVE = "true"
+          $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 "cookstyle")
+          hab pkg install ./results/$hartfile
+          . ./results/last_build.ps1
+          habitat/tests/test.ps1 $pkg_ident

.github/workflows/habitat-publish.yml

@@ -0,0 +1,112 @@
+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!!"

.github/workflows/verify.yml

@@ -0,0 +1,40 @@
+name: Verify Pipeline
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  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 Repository
+        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 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 4: Run the Unit tests
+      - name: Run Unit Tests
+        run: |
+          bundle exec rspec

habitat/plan.ps1

@@ -1,6 +1,7 @@
 $ErrorActionPreference = "Stop"
 $PSDefaultParameterValues['*:ErrorAction']='Stop'
 
+$env:HAB_BLDR_CHANNEL = "LTS-2024"
 $pkg_name="cookstyle"
 $pkg_origin="chef"
 $pkg_version=$(Get-Content "$PLAN_CONTEXT/../VERSION")
@@ -21,7 +22,6 @@ function pkg_version {
 function Invoke-Before {
     Set-PkgVersion
 }
-
 function Invoke-SetupEnvironment {
     Push-RuntimeEnv -IsPath GEM_PATH "$pkg_prefix/vendor"
 
@@ -48,7 +48,6 @@ function Invoke-Build {
         gem build cookstyle.gemspec
 	    Write-BuildLine " ** Using gem to  install"
 	    gem install cookstyle-*.gem --no-document
-
 
         If ($lastexitcode -ne 0) { Exit $lastexitcode }
     } finally {