Compare commits

..

2 Commits

Author SHA1 Message Date
Oliver King 0b0b5178d5 fix broken yaml 2022-07-06 10:27:14 -04:00
Oliver King d43ff40a3e fix typo 2022-06-13 12:57:31 -04:00
121 changed files with 16189 additions and 36366 deletions
-36
View File
@@ -1,36 +0,0 @@
name: Bug Report
description: File a bug report specifying all inputs you provided for the action, we will respond to this thread with any questions.
title: 'Bug: '
labels: ['bug', 'triage']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: What-happened
attributes:
label: What happened?
description: Tell us what happened and how is it different from the expected?
placeholder: Tell us what you see!
validations:
required: true
- type: checkboxes
id: Version
attributes:
label: Version
options:
- label: I am using the latest version
required: true
- type: input
id: Runner
attributes:
label: Runner
description: What runner are you using?
placeholder: Mention the runner info (self-hosted, operating system)
validations:
required: true
- type: textarea
id: Logs
attributes:
label: Relevant log output
description: Run in debug mode for the most verbose logs. Please feel free to attach a screenshot of the logs
validations:
required: true
-6
View File
@@ -1,6 +0,0 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Action "k8s-deploy" Support
url: https://github.com/Azure/k8s-deploy
security: https://github.com/Azure/k8s-deploy/blob/main/SECURITY.md
about: Please ask and answer questions here.
@@ -1,13 +0,0 @@
name: Feature Request
description: File a Feature Request form, we will respond to this thread with any questions.
title: 'Feature Request: '
labels: ['Feature']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: Feature_request
attributes:
label: Feature request
description: Provide example functionality and links to relevant docs
validations:
required: true
-18
View File
@@ -1,18 +0,0 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
groups:
actions:
patterns:
- '*'
- package-ecosystem: github-actions
directory: .github/workflows
schedule:
interval: weekly
groups:
actions:
patterns:
- '*'
+41 -38
View File
@@ -1,49 +1,52 @@
name: 'Code scanning - action' name: "Code scanning - action"
on: on:
push: push:
pull_request: pull_request:
schedule: schedule:
- cron: '0 19 * * 0' - cron: '0 19 * * 0'
jobs: jobs:
CodeQL-Build: CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest
permissions:
contents: read
security-events: write
steps: # CodeQL runs on ubuntu-latest and windows-latest
- name: Checkout repository runs-on: ubuntu-latest
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2
# Initializes the CodeQL tools for scanning. steps:
- name: Initialize CodeQL - name: Checkout repository
uses: github/codeql-action/init@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15 uses: actions/checkout@v2
# Override language selection by uncommenting this and choosing your languages with:
# with: # We must fetch at least the immediate parents so that if this is
# languages: go, javascript, csharp, python, cpp, java # a pull request then we can checkout the head.
fetch-depth: 2
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this run was triggered by a pull request event, then checkout
# If this step fails, then you should remove it and run the build manually (see below) # the head of the pull request instead of the merge commit.
- name: Autobuild - run: git checkout HEAD^2
uses: github/codeql-action/autobuild@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15 if: ${{ github.event_name == 'pull_request' }}
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
# Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java
# ️ Command-line programs to run using the OS shell. # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# 📚 https://git.io/JvXDl # If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# If the Autobuild fails above, remove it and uncomment the following three lines # Command-line programs to run using the OS shell.
# and modify them (or add more) to build your code if your project # 📚 https://git.io/JvXDl
# uses a compiled language
#- run: | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# make bootstrap # and modify them (or add more) to build your code if your project
# make release # uses a compiled language
- name: Perform CodeQL Analysis #- run: |
uses: github/codeql-action/analyze@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15 # make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
+29 -28
View File
@@ -1,35 +1,36 @@
name: setting-default-labels name: setting-default-labels
# Controls when the action will run. # Controls when the action will run.
on: on:
schedule: schedule:
- cron: '0 0/3 * * *' - cron: "0 0/3 * * *"
# A workflow run is made up of one or more jobs that can run sequentially or in parallel # A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs: jobs:
build: build:
# The type of runner that the job will run on # The type of runner that the job will run on
runs-on: ubuntu-latest runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job # Steps represent a sequence of tasks that will be executed as part of the job
steps: steps:
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
name: Setting issue as idle - uses: actions/stale@v3
with: name: Setting issue as idle
repo-token: ${{ secrets.GITHUB_TOKEN }} with:
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.' repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-label: 'idle' stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
days-before-stale: 14 stale-issue-label: 'idle'
days-before-close: -1 days-before-stale: 14
operations-per-run: 100 days-before-close: -1
exempt-issue-labels: 'backlog' operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
name: Setting PR as idle - uses: actions/stale@v3
with: name: Setting PR as idle
repo-token: ${{ secrets.GITHUB_TOKEN }} with:
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.' repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-label: 'idle' stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
days-before-stale: 14 stale-pr-label: 'idle'
days-before-close: -1 days-before-stale: 14
operations-per-run: 100 days-before-close: -1
operations-per-run: 100
-18
View File
@@ -1,18 +0,0 @@
name: 'Run prettify'
on:
pull_request:
push:
branches: [main]
jobs:
prettier:
name: Prettier Check
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: install deps
run: npm install
- name: Enforce Prettier
run: npm run format-check
+10 -14
View File
@@ -1,18 +1,14 @@
name: Release Project name: Create release PR
on: on:
push: workflow_dispatch:
branches: inputs:
- main release:
paths: description: "Define release version (ex: v1, v2, v3)"
- CHANGELOG.md required: true
workflow_dispatch:
jobs: jobs:
release: release-pr:
permissions: uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
actions: read with:
contents: write release: ${{ github.event.inputs.release }}
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@v1
with:
changelogPath: ./CHANGELOG.md
@@ -1,76 +0,0 @@
name: Minikube Integration Tests - basic
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for pod
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
test/integration/manifests/manifest_test_dir/test.yml
action: deploy
- name: Checking if deployments and services were created
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment3 containerName=nginx:1.14.2 labels=app:nginx3,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx3
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service3 labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx3
@@ -1,180 +0,0 @@
name: Minikube Integration Tests - blue-green ingress
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ env.NAMESPACE }}
- name: Executing deploy action for ingress
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deployments, services and ingresses were created with green labels and original tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
- name: Executing promote action for ingress
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Checking if deployments, services and ingresses were created with none labels after first promote
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
- name: Executing second deploy action for ingress with new tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deployments (with new tag), services and ingresses were created with green labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
- name: Executing second promote action for ingress now using new image tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Checking if deployments, services and ingresses were created with none labels after promote for new tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
- name: Executing deploy action for ingress to be rejected using old tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if new deployments (with old tag), services and ingresses were created with green labels after deploy, and old deployment (with latest tag) persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
- name: Executing reject action for ingress to reject new deployment with 1.14.2 tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-ingress.yml
strategy: blue-green
route-method: ingress
action: reject
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
- name: Checking if deployments, services and ingresses were created with none labels and latest tag after reject
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns ${{ env.NAMESPACE }}
@@ -1,167 +0,0 @@
name: Minikube Integration Tests - blue-green service
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for service
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deployments and services were created with green labels and original tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
- name: Executing promote action for service
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Checking if deployments and services were created with none labels after first promote
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
- name: Executing second deploy action for service with new tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deployments (with new tag) and services were created with green labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
- name: Executing second promote action for service now using new image tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Checking if deployments and services were created with none labels after promote for new tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
- name: Executing deploy action for service to be rejected using old tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if new deployments (with old tag) and services were created with green labels after deploy, and old deployment (with latest tag) persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
- name: Executing reject action for service to reject new deployment with 1.14.2 tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: service
action: reject
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
- name: Checking if deployments and services were created with none labels and latest tag after reject
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns ${{ env.NAMESPACE }}
@@ -1,206 +0,0 @@
name: Minikube Integration Tests - blue-green SMI
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Install linkerd and add controlplane to cluster
run: |
curl --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install-edge | sh
export PATH=$PATH:/home/runner/.linkerd2/bin
curl -sL https://linkerd.github.io/linkerd-smi/install | sh
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.0/standard-install.yaml
linkerd install --crds | kubectl apply -f -
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
linkerd smi install | kubectl apply -f -
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for smi
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: deploy
- name: Checking if deployments, services, and ts objects were created with green labels and original tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
- name: Executing promote action for smi
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: promote
# another good place for anti-test - ensure old deps are deleted after promote
- name: Checking if deployments, services, and ts objects were created with none labels after first promote
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
- name: Executing second deploy action for smi with new tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: deploy
- name: Checking if deployments (with new tag) and services were created with green labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
- name: Executing second promote action for smi now using new image tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: promote
- name: Checking if deployments and services were created with none labels after promote for new tag, ts is stable
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
- name: Executing deploy action for smi to be rejected using old tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: deploy
- name: Checking if new deployments (with old tag) and services were created with green labels after deploy, and old deployment (with latest tag) persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
- name: Executing reject action for smi to reject new deployment with 1.14.2 tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/blue-green/test-service.yml
strategy: blue-green
route-method: smi
action: reject
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
- name: Checking if deployments and services were created with none labels and latest tag after reject
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns ${{ env.NAMESPACE }}
@@ -1,176 +0,0 @@
name: Minikube Integration Tests - canary pod
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for pod
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: deploy
- name: Checking if deployments and services were created with canary labels and original tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Executing promote action for pod
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: promote
# another good place for anti-test - ensure old deps are deleted after promote
- name: Checking if deployments and services were created with stable labels after first promote
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Executing second deploy action for pod with new tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: deploy
- name: Checking if deployments (with new tag) and services were created with canary labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:latest labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Executing second promote action for pod now using new image tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: promote
- name: Checking if deployments and services were created with stable labels after promote for new tag, ts is stable
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Executing deploy action for pod to be rejected using old tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: deploy
- name: Checking if new deployments (with old tag) and services were created with canary and baseline labels after deploy, and stable deployment (with latest tag) persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Executing reject action for pod to reject new deployment with 1.14.2 tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: pod
action: reject
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
- name: Checking if deployments and services were created with stable labels and latest tag after reject
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns ${{ env.NAMESPACE }}
@@ -1,215 +0,0 @@
name: Minikube Integration Tests - canary SMI
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
curl --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install-edge | sh
export PATH=$PATH:/home/runner/.linkerd2/bin
curl -sL https://linkerd.github.io/linkerd-smi/install | sh
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.0/standard-install.yaml
linkerd install --crds | kubectl apply -f -
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
linkerd smi install | kubectl apply -f -
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for smi
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: deploy
- name: Checking if deployments, services, and ts objects were created with canary labels and original tag
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:0,nginx-service-canary:1000,nginx-service-baseline:0
- name: Executing promote action for smi
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: promote
# another good place for anti-test - ensure old deps are deleted after promote
- name: Checking if deployments, services, and ts objects were created with stable labels after first promote
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:1.14.2 labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
- name: Executing second deploy action for smi with new tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: deploy
- name: Checking if deployments (with new tag) and services were created with canary labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:1.14.2 labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:latest labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-baseline containerName=nginx:1.14.2 labels=workflow/version:baseline,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:baseline
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-baseline labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:baseline selectorLabels=app:nginx,workflow/version:baseline
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:500,nginx-service-canary:250,nginx-service-baseline:250
- name: Executing second promote action for smi now using new image tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:latest
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: promote
- name: Checking if deployments and services were created with stable labels after promote for new tag, ts is stable
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
- name: Executing deploy action for smi to be rejected using old tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: deploy
- name: Checking if new deployments (with old tag) and services were created with canary and baseline labels after deploy, and stable deployment (with latest tag) persists
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-baseline containerName=nginx:latest labels=workflow/version:baseline,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:baseline
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-baseline labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:baseline selectorLabels=app:nginx,workflow/version:baseline
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:500,nginx-service-canary:250,nginx-service-baseline:250
- name: Executing reject action for smi to reject new deployment with 1.14.2 tag
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
strategy: canary
percentage: 50
traffic-split-method: smi
action: reject
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
- name: Checking if deployments and services were created with stable labels and latest tag after reject
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns ${{ env.NAMESPACE }}
@@ -1,85 +0,0 @@
name: Cluster Integration Tests - private cluster
on:
pull_request:
branches:
- 'releases/*'
push:
branches:
- main
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Build
run: ncc build src/run.ts -o lib
- name: Azure login
uses: azure/login@v2.3.0
with:
client-id: ${{ secrets.AZURE_CLIENT_ID }}
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- name: Create private AKS cluster and set context
run: |
set +x
# create cluster
az group create --location eastus2 --name ${{ env.NAMESPACE }}
az aks create --name ${{ env.NAMESPACE }} --resource-group ${{ env.NAMESPACE }} --enable-private-cluster --generate-ssh-keys
az aks get-credentials --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }}
- name: Create namespace to run tests
run: |
az aks command invoke --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }} --command "kubectl create ns ${{ env.NAMESPACE }}"
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Executing deploy action for pod
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
test/integration/manifests/test2.yml
action: deploy
private-cluster: true
resource-group: ${{ env.NAMESPACE }}
name: ${{ env.NAMESPACE }}
- name: Checking if deployments and services were created
run: |
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment2 containerName=nginx:1.14.2 labels=app:nginx2,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx2
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service2 labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx2
- name: Clean up AKS cluster
if: ${{ always() }}
run: |
echo "deleting AKS cluster and resource group"
az aks delete --yes --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }}
az group delete --resource-group ${{ env.NAMESPACE }} --yes
@@ -1,89 +0,0 @@
name: Minikube Integration Tests - resource annotation
on:
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Install conntrack
run: sudo apt-get install -y conntrack
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for pod with resource annotation enabled by default
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
action: deploy
- name: Checking if deployments is created with additional resource annotation
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_resource_annotation selectorLabels=app:nginx annotations=actions.github.com/k8s-deploy,deployment.kubernetes.io/revision,kubectl.kubernetes.io/last-applied-configuration
- name: Cleaning previously created deployment
run: |
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
- name: Executing deploy action for pod with resource annotation disabled
uses: ./
with:
namespace: ${{ env.NAMESPACE }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test.yml
action: deploy
annotate-resources: false
- name: Checking if deployment is created without additional resource annotation
run: |
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 selectorLabels=app:nginx annotations=deployment.kubernetes.io/revision,kubectl.kubernetes.io/last-applied-configuration
+215
View File
@@ -0,0 +1,215 @@
name: Minikube Integration Tests
on:
pull_request:
branches:
- master
- main
- "releases/*"
push:
branches:
- master
- main
- "releases/*"
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Build
run: ncc build src/run.ts -o lib
- name: Set name of ns
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
shell: bash
id: ns
- uses: Azure/setup-kubectl@v1
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2
with:
minikube version: "v1.24.0"
kubernetes version: "v1.17.8"
driver: "none"
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns test-${{ steps.ns.outputs.name }}
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: "3.x"
- name: Cleaning any previously created items
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
- name: Executing deploy action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Checking if deploments and services were created with none labels after promote
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action on
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
- name: Executing reject action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: reject
- name: Checking if deploments and services were routed back to none labels after reject
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Cleaning up current set up
run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Checking if deploments, services and ingresses were created with none labels after promote
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing reject action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: reject
- name: Checking if deploments, services and ingresses were created with none labels after reject
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns test-${{ steps.ns.outputs.name }}
- if: ${{ always() }}
name: Posting result back to PR
run: |
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
shell: bash
+10
View File
@@ -0,0 +1,10 @@
name: Tag and create release draft
on:
push:
branches:
- releases/*
jobs:
tag-and-release:
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
+16 -17
View File
@@ -1,20 +1,19 @@
name: 'Run unit tests.' name: "Run unit tests."
on: # rebuild any PRs and main branch changes on: # rebuild any PRs and main branch changes
pull_request: pull_request:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
push: push:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
jobs: jobs:
build: # make sure build/ci works properly build: # make sure build/ci works properly
name: Run Unit Tests runs-on: ubuntu-latest
runs-on: ubuntu-latest steps:
steps: - uses: actions/checkout@v1
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - run: |
- run: | npm install
npm install npm test
npm test
+1 -2
View File
@@ -2,5 +2,4 @@ node_modules
.DS_Store .DS_Store
.idea .idea
lib/
coverage/
-4
View File
@@ -1,4 +0,0 @@
# dependencies
/node_modules
coverage
/lib
-8
View File
@@ -1,8 +0,0 @@
{
"trailingComma": "none",
"bracketSpacing": false,
"semi": false,
"tabWidth": 3,
"singleQuote": true,
"printWidth": 80
}
-46
View File
@@ -1,46 +0,0 @@
# Changelog
## [5.0.3] - 2025-04-16
### Added
- #398 case-insensitive resource type
## [5.0.2] - 2025-04-15
### Added
- #396 Update new resource-type input for action
## [5.0.1] - 2024-03-12
### Added
- #356 Add fleet support
## [5.0.0] - 2024-03-12
### Changed
- #309 Updated to Node20 and upgraded release workflows to @v1 tag
- #306 update release workflow to use new prefix, remove deprecated release
- #303 fix: ensure imageNames are not empty strings
- #299 bump release workflow sha
- #298 bump minikube to fix runner deps
- #297 update release workflow
### Added
- #304 add v prefix for version tagging
- #302 adding ncc to build
- #301 adding release workflow artifact fix
## [4.10.0] - 2023-10-30
### Added
- #287 Make annotating resources optional
- #283 Fix “Service” route-method of the Blue-Green strategy with some manifest files
- #281 bump codeql to node 16
- #279 upgrade codeql
- #276 Fixes multiple namespaces bug
+9 -9
View File
@@ -1,9 +1,9 @@
# Microsoft Open Source Code of Conduct # Microsoft Open Source Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
Resources: Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns - Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+434 -489
View File
@@ -1,489 +1,434 @@
# Deploy manifests action for Kubernetes # Deploy manifests action for Kubernetes
This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action). This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action).
If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
This action requires the following permissions from your workflow: ## Action capabilities
```yaml Following are the key capabilities of this action:
permissions:
id-token: write - **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes.
contents: read
actions: read - **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure.
```
- **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster.
## Action capabilities
- **Deployment strategy** Supports both canary and blue-green deployment strategies
Following are the key capabilities of this action:
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
- **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes. - **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers).
- **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary.
- **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure. - **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
- **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster. - **Service route-method**: Identified services are configured to target the green deployments.
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services.
- **Deployment strategy** Supports both canary and blue-green deployment strategies - **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster.
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported: Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads.
- **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers).
- **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary. ## Action inputs
- **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
<table>
- **Service route-method**: Identified services are configured to target the green deployments. <thead>
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services. <tr>
- **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster. <th>Action inputs</th>
<th>Description</th>
Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads. </tr>
</thead>
## Action inputs <tr>
<td>action </br></br>(Required)</td>
<table> <td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td>
<thead> </tr>
<tr> <tr>
<th>Action inputs</th> <td>manifests </br></br>(Required)</td>
<th>Description</th> <td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
</tr> </tr>
</thead> <tr>
<tr> <td>namespace </br></br>(Optional)
<td>action </br></br>(Required)</td> <td>Namespace within the cluster to deploy to.</td>
<td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td> </tr>
</tr> <tr>
<tr> <td>images </br></br>(Optional)</td>
<td>manifests </br></br>(Required)</td> <td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br>
<td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed, or URLs to manifest files (like https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/controllers/nginx-deployment.yaml). Files and URLs not ending in .yml or .yaml will be ignored.</td> <code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br>
</tr> In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td>
<tr> </tr>
<td>strategy </br></br>(Required)</td> <tr>
<td>Acceptable values: basic/canary/blue-green. <br> <td>imagepullsecrets </br></br>(Optional)</td>
Default value: basic <td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td>
<br>Deployment strategy to be used while applying manifest files on the cluster. </tr>
<br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy <tr>
<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td> <td>pull-images</br></br>(Optional)</td>
</tr> <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
<tr> </tr>
<td>namespace </br></br>(Optional) <tr>
<td>Namespace within the cluster to deploy to.</td> <td>strategy </br></br>(Optional)</td>
</tr> <td>Acceptable values: none/canary/blue-green. <br>
<tr> Deployment strategy to be used while applying manifest files on the cluster.<br>none - No deployment strategy is used when deploying.<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
<td>images </br></br>(Optional)</td> </tr>
<td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br> <tr>
<code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br> <td>traffic-split-method </br></br>(Optional)</td>
In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td> <td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>
</tr> </tr>
<tr> <tr>
<td>imagepullsecrets </br></br>(Optional)</td> <td>percentage </br></br>(Optional but required if strategy is canary)</td>
<td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td> <td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td>
</tr> </tr>
<tr> <tr>
<td>pull-images</br></br>(Optional)</td> <td>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</td>
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td> <td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td>
</tr> </tr>
<tr> <tr>
<td>traffic-split-method </br></br>(Optional)</td> <td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td> <td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
</tr> <br>Service: Service selector labels are updated to target '-green' workloads.
<tr> <br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
<td>traffic-split-annotations </br></br>(Optional)</td> <br>SMI: A <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> object is created for each required service to route traffic to new workloads.</td>
<td>Annotations in the form of key/value pair to be added to TrafficSplit.</td> </tr>
<tr> <tr>
<td>percentage </br></br>(Optional but required if strategy is canary)</td> <td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td> <td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
</tr> </tr>
<tr> <tr>
<td>baseline-and-canary-replicas </br></br> (Optional and relevant only if strategy is canary and traffic-split-method is smi)</td> <td>force </br></br>(Optional)</td>
<td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas each, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td> <td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
</tr> </tr>
<tr> <tr>
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>annotate-namespace</br></br>(Optional)</td>
<td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input. <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
<br>Service: Service selector labels are updated to target '-green' workloads. </tr>
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments. </table>
<br>SMI: A <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> object is created for each required service to route traffic to new workloads.</td>
</tr> ## Usage Examples
<tr>
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td> ### Basic deployment (without any deployment strategy)
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
</tr> ```yaml
<tr> - uses: Azure/k8s-deploy@v3.1
<td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td> with:
<td>Acceptable values: true, false</br>Default value: false.</td> namespace: "myapp"
</tr> manifests: |
<tr> dir/manifestsDirectory
<td>force </br></br>(Optional)</td> images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
<td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td> imagepullsecrets: |
</tr> image-pull-secret1
<tr> image-pull-secret2
<td>annotate-resources</br></br>(Optional)</td> ```
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the resources or not. If set to false all annotations are skipped completely.</td>
</tr> ### Canary deployment without service mesh
<tr>
<td>annotate-namespace</br></br>(Optional)</td> ```yaml
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not. Ignored when annotate-resources is set to false.</td> - uses: Azure/k8s-deploy@v3.1
</tr> with:
<tr> namespace: "myapp"
<td>skip-tls-verify</br></br>(Optional)</td> images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
<td>Acceptable values: true/false</br>Default value: false</br>True if the insecure-skip-tls-verify option should be used</td> imagepullsecrets: |
</tr> image-pull-secret1
<tr> image-pull-secret2
<td>resource-type (Optional)</td> manifests: |
<td>Acceptable values: `Microsoft.ContainerService/managedClusters` (default), 'Microsoft.ContainerService/fleets'</td> deployment.yaml
</tr> service.yaml
</table> dir/manifestsDirectory
strategy: canary
## Usage Examples action: deploy
percentage: 20
### Basic deployment (without any deployment strategy) ```
```yaml To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
- uses: Azure/k8s-deploy@v5
with: ```yaml
namespace: 'myapp' - uses: Azure/k8s-deploy@v3.1
manifests: | with:
dir/manifestsDirectory namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
``` manifests: |
deployment.yaml
### Private cluster deployment service.yaml
dir/manifestsDirectory
```yaml strategy: canary
- uses: Azure/k8s-deploy@v5 action: promote # substitute reject if you want to reject
with: ```
resource-group: yourResourceGroup
name: yourClusterName ### Canary deployment based on Service Mesh Interface
action: deploy
strategy: basic ```yaml
- uses: Azure/k8s-deploy@v3.1
private-cluster: true with:
manifests: | namespace: "myapp"
manifests/azure-vote-backend-deployment.yaml images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
manifests/azure-vote-backend-service.yaml imagepullsecrets: |
manifests/azure-vote-frontend-deployment.yaml image-pull-secret1
manifests/azure-vote-frontend-service.yaml image-pull-secret2
images: | manifests: |
registry.azurecr.io/containername deployment.yaml
``` service.yaml
dir/manifestsDirectory
### Canary deployment without service mesh strategy: canary
action: deploy
```yaml traffic-split-method: smi
- uses: Azure/k8s-deploy@v5 percentage: 20
with: baseline-and-canary-replicas: 1
namespace: 'myapp' ```
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
image-pull-secret1
image-pull-secret2 ```yaml
manifests: | - uses: Azure/k8s-deploy@v3.1
deployment.yaml with:
service.yaml namespace: "myapp"
dir/manifestsDirectory images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
strategy: canary imagepullsecrets: |
action: deploy image-pull-secret1
percentage: 20 image-pull-secret2
``` manifests: |
deployment.yaml
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: service.yaml
dir/manifestsDirectory
```yaml strategy: canary
- uses: Azure/k8s-deploy@v5 traffic-split-method: smi
with: action: reject # substitute promote if you want to promote
namespace: 'myapp' ```
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | ### Blue-Green deployment with different route methods
image-pull-secret1
image-pull-secret2 ```yaml
manifests: | - uses: Azure/k8s-deploy@v3.1
deployment.yaml with:
service.yaml namespace: "myapp"
dir/manifestsDirectory images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
strategy: canary imagepullsecrets: |
action: promote # substitute reject if you want to reject image-pull-secret1
``` image-pull-secret2
manifests: |
### Canary deployment based on Service Mesh Interface deployment.yaml
service.yaml
```yaml ingress.yml
- uses: Azure/k8s-deploy@v5 strategy: blue-green
with: action: deploy
namespace: 'myapp' route-method: ingress # substitute with service/smi as per need
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' version-switch-buffer: 15
imagepullsecrets: | ```
image-pull-secret1
image-pull-secret2 To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
manifests: |
deployment.yaml ```yaml
service.yaml - uses: Azure/k8s-deploy@v3.1
dir/manifestsDirectory with:
strategy: canary namespace: "myapp"
action: deploy images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
traffic-split-method: smi imagepullsecrets: |
percentage: 20 image-pull-secret1
baseline-and-canary-replicas: 1 image-pull-secret2
``` manifests: |
deployment.yaml
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: service.yaml
ingress.yml
```yaml strategy: blue-green
- uses: Azure/k8s-deploy@v5 route-method: ingress # should be the same as the value when action was deploy
with: action: promote # substitute reject if you want to reject
namespace: 'myapp' ```
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} '
imagepullsecrets: | ## End to end workflows
image-pull-secret1
image-pull-secret2 Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters:
manifests: |
deployment.yaml ### Build container image and deploy to Azure Kubernetes Service cluster
service.yaml
dir/manifestsDirectory ```yaml
strategy: canary on: [push]
traffic-split-method: smi
action: reject # substitute promote if you want to promote jobs:
``` build:
runs-on: ubuntu-latest
### Blue-Green deployment with different route methods steps:
- uses: actions/checkout@master
```yaml
- uses: Azure/k8s-deploy@v5 - uses: Azure/docker-login@v1
with: with:
namespace: 'myapp' login-server: contoso.azurecr.io
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' username: ${{ secrets.REGISTRY_USERNAME }}
imagepullsecrets: | password: ${{ secrets.REGISTRY_PASSWORD }}
image-pull-secret1
image-pull-secret2 - run: |
manifests: | docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
deployment.yaml docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
service.yaml
ingress.yml - uses: azure/setup-kubectl@v2.0
strategy: blue-green
action: deploy # Set the target AKS cluster.
route-method: ingress # substitute with service/smi as per need - uses: Azure/aks-set-context@v1
version-switch-buffer: 15 with:
``` creds: "${{ secrets.AZURE_CREDENTIALS }}"
cluster-name: contoso
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used: resource-group: contoso-rg
```yaml - uses: Azure/k8s-create-secret@v1.1
- uses: Azure/k8s-deploy@v5 with:
with: container-registry-url: contoso.azurecr.io
namespace: 'myapp' container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
imagepullsecrets: | secret-name: demo-k8s-secret
image-pull-secret1
image-pull-secret2 - uses: Azure/k8s-deploy@v3.1
manifests: | with:
deployment.yaml action: deploy
service.yaml manifests: |
ingress.yml manifests/deployment.yml
strategy: blue-green manifests/service.yml
route-method: ingress # should be the same as the value when action was deploy images: |
action: promote # substitute reject if you want to reject demo.azurecr.io/k8sdemo:${{ github.sha }}
``` imagepullsecrets: |
demo-k8s-secret
## End to end workflows ```
Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters: ### Build container image and deploy to any Azure Kubernetes Service cluster
### Build container image and deploy to Azure Kubernetes Service cluster ```yaml
on: [push]
```yaml
on: [push] jobs:
build:
jobs: runs-on: ubuntu-latest
build: steps:
runs-on: ubuntu-latest - uses: actions/checkout@master
steps:
- uses: actions/checkout@v4 - uses: Azure/docker-login@v1
with:
- uses: Azure/docker-login@v1 login-server: contoso.azurecr.io
with: username: ${{ secrets.REGISTRY_USERNAME }}
login-server: contoso.azurecr.io password: ${{ secrets.REGISTRY_PASSWORD }}
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} - run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
- run: | docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} - uses: azure/setup-kubectl@v2.0
- uses: azure/setup-kubectl@v4 - uses: Azure/k8s-set-context@v2
with:
# Set the target AKS cluster. kubeconfig: ${{ secrets.KUBE_CONFIG }}
- uses: Azure/aks-set-context@v4
with: - uses: Azure/k8s-create-secret@v1.1
creds: '${{ secrets.AZURE_CREDENTIALS }}' with:
cluster-name: contoso container-registry-url: contoso.azurecr.io
resource-group: contoso-rg container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
- uses: Azure/k8s-create-secret@v4 secret-name: demo-k8s-secret
with:
container-registry-url: contoso.azurecr.io - uses: Azure/k8s-deploy@v3.1
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} with:
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} action: deploy
secret-name: demo-k8s-secret manifests: |
manifests/deployment.yml
- uses: Azure/k8s-deploy@v5 manifests/service.yml
with: images: |
action: deploy demo.azurecr.io/k8sdemo:${{ github.sha }}
manifests: | imagepullsecrets: |
manifests/deployment.yml demo-k8s-secret
manifests/service.yml ```
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} ### Build image and add `dockerfile-path` label to it
imagepullsecrets: |
demo-k8s-secret We can use this image in other workflows once built.
```
```yaml
### Build container image and deploy to any Azure Kubernetes Service cluster on: [push]
env:
```yaml NAMESPACE: demo-ns2
on: [push]
jobs:
jobs: build:
build: runs-on: ubuntu-latest
runs-on: ubuntu-latest steps:
steps: - uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: Azure/docker-login@v1
- uses: Azure/docker-login@v1 with:
with: login-server: contoso.azurecr.io
login-server: contoso.azurecr.io username: ${{ secrets.REGISTRY_USERNAME }}
username: ${{ secrets.REGISTRY_USERNAME }} password: ${{ secrets.REGISTRY_PASSWORD }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- run: |
- run: | docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} ```
- uses: azure/setup-kubectl@v4 ### Use bake action to get manifests deploying to a Kubernetes cluster
- uses: Azure/k8s-set-context@v4 ```yaml
with: on: [push]
kubeconfig: ${{ secrets.KUBE_CONFIG }} env:
NAMESPACE: demo-ns2
- uses: Azure/k8s-create-secret@v4
with: jobs:
container-registry-url: contoso.azurecr.io deploy:
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} runs-on: ubuntu-latest
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} steps:
secret-name: demo-k8s-secret - uses: actions/checkout@master
- uses: Azure/k8s-deploy@v4 - uses: Azure/docker-login@v1
with: with:
action: deploy login-server: contoso.azurecr.io
manifests: | username: ${{ secrets.REGISTRY_USERNAME }}
manifests/deployment.yml password: ${{ secrets.REGISTRY_PASSWORD }}
manifests/service.yml
images: | - uses: azure/setup-kubectl@v2.0
demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | # Set the target AKS cluster.
demo-k8s-secret - uses: Azure/aks-set-context@v1
``` with:
creds: "${{ secrets.AZURE_CREDENTIALS }}"
### Build image and add `dockerfile-path` label to it cluster-name: contoso
resource-group: contoso-rg
We can use this image in other workflows once built.
- uses: Azure/k8s-create-secret@v1.1
```yaml with:
on: [push] namespace: ${{ env.NAMESPACE }}
env: container-registry-url: contoso.azurecr.io
NAMESPACE: demo-ns2 container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
jobs: secret-name: demo-k8s-secret
build:
runs-on: ubuntu-latest - uses: azure/k8s-bake@v2
steps: with:
- uses: actions/checkout@v4 renderEngine: "helm"
helmChart: "./aks-helloworld/"
- uses: Azure/docker-login@v1 overrideFiles: "./aks-helloworld/values-override.yaml"
with: overrides: |
login-server: contoso.azurecr.io replicas:2
username: ${{ secrets.REGISTRY_USERNAME }} helm-version: "latest"
password: ${{ secrets.REGISTRY_PASSWORD }} id: bake
- run: | - uses: Azure/k8s-deploy@v1.2
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile with:
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} action: deploy
``` manifests: ${{ steps.bake.outputs.manifestsBundle }}
images: |
### Use bake action to get manifests deploying to a Kubernetes cluster contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
```yaml demo-k8s-secret
on: [push] ```
env:
NAMESPACE: demo-ns2 ## Traceability Fields Support
jobs: - Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests.
deploy: - Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability.
runs-on: ubuntu-latest - Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows.
steps:
- uses: actions/checkout@master ## Contributing
- uses: Azure/docker-login@v1 This project welcomes contributions and suggestions. Most contributions require you to agree to a
with: Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
login-server: contoso.azurecr.io the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
- uses: azure/setup-kubectl@v4 provided by the bot. You will only need to do this once across all repos using our CLA.
# Set the target AKS cluster. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
- uses: Azure/aks-set-context@v4 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
with: contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso
resource-group: contoso-rg
- uses: Azure/k8s-create-secret@v4
with:
namespace: ${{ env.NAMESPACE }}
container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret
- uses: azure/k8s-bake@v3
with:
renderEngine: 'helm'
helmChart: './aks-helloworld/'
overrideFiles: './aks-helloworld/values-override.yaml'
overrides: |
replicas:2
helm-version: 'latest'
id: bake
- uses: Azure/k8s-deploy@v5
with:
action: deploy
manifests: ${{ steps.bake.outputs.manifestsBundle }}
images: |
contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
demo-k8s-secret
```
## Traceability Fields Support
- Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests.
- Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability.
- Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Support
k8s-deploy is an open source project that is [**not** covered by the Microsoft Azure support policy](https://support.microsoft.com/en-us/help/2941892/support-for-linux-and-open-source-technology-in-azure). [Please search open issues here](https://github.com/Azure/k8s-deploy/issues), and if your issue isn't already represented please [open a new one](https://github.com/Azure/k8s-deploy/issues/new/choose). The project maintainers will respond to the best of their abilities.
+35 -35
View File
@@ -1,35 +1,35 @@
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK --> <!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
## Security ## Security
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/). Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>) of a security vulnerability, please report it to us as described below. If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
## Reporting Security Issues ## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155). **Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue * Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL) * The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue * Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue * Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible) * Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue * Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly. This information will help us triage your report more quickly.
## Preferred Languages ## Preferred Languages
We prefer all communications to be in English. We prefer all communications to be in English.
## Policy ## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
<!-- END MICROSOFT SECURITY.MD BLOCK --> <!-- END MICROSOFT SECURITY.MD BLOCK -->
+67 -92
View File
@@ -1,92 +1,67 @@
name: 'Deploy to Kubernetes cluster' name: "Deploy to Kubernetes cluster"
description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters' description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters"
inputs: inputs:
# Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action # Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action
# You also need to have kubectl installed (azure/setup-kubectl) # You also need to have kubectl installed (azure/setup-kubectl)
namespace: namespace:
description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.' description: "Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace."
required: false required: false
default: default manifests:
manifests: description: "Path to the manifest files which will be used for deployment."
description: 'Path to the manifest files which will be used for deployment.' required: true
required: true images:
images: description: "Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test"
description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test' required: false
required: false imagepullsecrets:
imagepullsecrets: description: "Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files"
description: 'Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files' required: false
required: false pull-images:
pull-images: description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations"
description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations" required: false
required: false default: true
default: true strategy:
strategy: description: "Deployment strategy to be used. Allowed values are none, canary and blue-green"
description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green' required: false
required: true default: "none"
default: 'basic' route-method:
route-method: description: "Route based on service, ingress or SMI for blue-green strategy"
description: 'Route based on service, ingress or SMI for blue-green strategy' required: false
required: false default: "service"
default: 'service' version-switch-buffer:
version-switch-buffer: description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)"
description: 'Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)' required: false
required: false default: 0
default: 0 traffic-split-method:
traffic-split-method: description: "Traffic split method to be used. Allowed values are pod and smi"
description: 'Traffic split method to be used. Allowed values are pod and smi' required: false
required: false default: "pod"
default: 'pod' baseline-and-canary-replicas:
traffic-split-annotations: description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)"
description: 'Annotations in the form of key/value pair to be added to TrafficSplit. Relevant only if deployement strategy is blue-green or canary' required: false
required: false default: 0
baseline-and-canary-replicas: percentage:
description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)' description: "Percentage of traffic redirect to canary deployment"
required: false required: false
default: '' default: 0
percentage: action:
description: 'Percentage of traffic redirect to canary deployment' description: "deploy, promote, or reject"
required: false required: true
default: 0 default: "deploy"
action: force:
description: 'deploy, promote, or reject' description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command"
required: true required: false
default: 'deploy' default: false
force: token:
description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command' description: "Github token"
required: false default: ${{ github.token }}
default: false required: true
token: annotate-namespace:
description: 'Github token' description: "Annotate the target namespace"
default: ${{ github.token }} required: false
required: true default: true
annotate-resources:
description: 'Annotate the resources. If set to false all annotations are skipped completely.' branding:
required: false color: "green"
default: true runs:
annotate-namespace: using: "node12"
description: 'Annotate the target namespace. Ignored when annotate-resources is set to false.' main: "lib/index.js"
required: false
default: true
private-cluster:
description: 'True if cluster is AKS private cluster'
required: false
default: false
resource-group:
description: 'Name of resource group - Only required if using private cluster'
required: false
name:
description: 'Resource group name - Only required if using private cluster'
required: false
skip-tls-verify:
description: True if the insecure-skip-tls-verify option should be used. Input should be 'true' or 'false'.
default: false
resource-type:
description: Either Microsoft.ContainerService/managedClusters or Microsoft.ContainerService/fleets'.
required: false
default: 'Microsoft.ContainerService/managedClusters'
branding:
color: 'green'
runs:
using: 'node20'
main: 'lib/index.js'
-6
View File
@@ -1,6 +0,0 @@
module.exports = {
presets: [
['@babel/preset-env', {targets: {node: 'current'}}],
'@babel/preset-typescript'
]
}
+9 -19
View File
@@ -1,20 +1,10 @@
module.exports = { module.exports = {
moduleFileExtensions: ['js', 'ts'], clearMocks: true,
testEnvironment: 'node', moduleFileExtensions: ['js', 'ts'],
testMatch: ['**/*.test.ts'], testEnvironment: 'node',
transform: { testMatch: ['**/*.test.ts'],
'\\.[jt]sx?$': 'babel-jest' transform: {
}, '^.+\\.ts$': 'ts-jest'
transformIgnorePatterns: [ },
'node_modules/(?!' + verbose: true
[ }
'@octokit',
'universal-user-agent',
'before-after-hook',
'minimist'
].join('|') +
')'
],
verbose: true,
testTimeout: 9000
}
-17991
View File
File diff suppressed because it is too large Load Diff
+10922 -8955
View File
File diff suppressed because it is too large Load Diff
+28 -38
View File
@@ -1,38 +1,28 @@
{ {
"name": "k8s-deploy-action", "name": "k8s-deploy-action",
"version": "5.0.0", "version": "0.0.0",
"author": "Deepak Sattiraju", "author": "Deepak Sattiraju",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"prebuild": "npm i @vercel/ncc", "build": "tsc --outDir ./lib --rootDir ./src",
"build": "ncc build src/run.ts -o lib", "test": "jest"
"test": "jest", },
"coverage": "jest --coverage=true", "dependencies": {
"format": "prettier --write .", "@actions/core": "^1.2.6",
"format-check": "prettier --check ." "@actions/exec": "^1.0.0",
}, "@actions/io": "^1.0.0",
"dependencies": { "@actions/tool-cache": "1.1.2",
"@actions/core": "^1.11.1", "@octokit/core": "^3.5.1",
"@actions/exec": "^1.0.0", "@octokit/plugin-retry": "^3.0.9",
"@actions/io": "^1.1.3", "@types/minipass": "^3.1.2",
"@actions/tool-cache": "2.0.2", "js-yaml": "3.13.1"
"@babel/preset-env": "^7.26.9", },
"@babel/preset-typescript": "^7.27.0", "devDependencies": {
"@octokit/core": "^6.1.4", "@types/jest": "^26.0.0",
"@octokit/plugin-retry": "^7.2.0", "@types/js-yaml": "^3.12.7",
"@types/minipass": "^3.3.5", "@types/node": "^12.20.41",
"js-yaml": "4.1.0", "jest": "^26.0.0",
"minimist": "^1.2.8" "ts-jest": "^25.5.1",
}, "typescript": "3.9.5"
"devDependencies": { }
"@types/jest": "^29.5.14", }
"@types/js-yaml": "^4.0.9",
"@types/minimist": "^1.2.5",
"@types/node": "^22.14.0",
"@vercel/ncc": "^0.38.3",
"jest": "^29.7.0",
"prettier": "^3.5.3",
"ts-jest": "^29.3.1",
"typescript": "5.8.3"
}
}
+75 -69
View File
@@ -1,79 +1,85 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper";
import { import {
annotateAndLabelResources, annotateAndLabelResources,
checkManifestStability, checkManifestStability,
deployManifests deployManifests,
} from '../strategyHelpers/deploymentHelper' } from "../strategyHelpers/deploymentHelper";
import {DeploymentStrategy} from '../types/deploymentStrategy' import { DeploymentStrategy } from "../types/deploymentStrategy";
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod' import { parseTrafficSplitMethod } from "../types/trafficSplitMethod";
import {ClusterType} from '../inputUtils' import { parseRouteStrategy } from "../types/routeStrategy";
export const ResourceTypeManagedCluster =
'Microsoft.ContainerService/managedClusters'
export const ResourceTypeFleet = 'Microsoft.ContainerService/fleets'
export async function deploy( export async function deploy(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[], manifestFilePaths: string[],
deploymentStrategy: DeploymentStrategy, deploymentStrategy: DeploymentStrategy
resourceType: ClusterType
) { ) {
// update manifests // update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths) const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths);
core.debug(`Input manifest files: ${inputManifestFiles}`) core.debug("Input manifest files: " + inputManifestFiles);
// deploy manifests // deploy manifests
core.startGroup('Deploying manifests') core.info("Deploying manifests");
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true}) core.getInput("traffic-split-method", { required: true })
) );
const deployedManifestFiles = await deployManifests( const deployedManifestFiles = await deployManifests(
inputManifestFiles, inputManifestFiles,
deploymentStrategy, deploymentStrategy,
kubectl, kubectl,
trafficSplitMethod trafficSplitMethod
) );
core.debug(`Deployed manifest files: ${deployedManifestFiles}`) core.debug("Deployed manifest files: " + deployedManifestFiles);
core.endGroup()
// check manifest stability // check manifest stability
core.startGroup('Checking manifest stability') core.info("Checking manifest stability");
const resourceTypes: Resource[] = getResources( const resourceTypes: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
]) ])
) );
await checkManifestStability(kubectl, resourceTypes);
await checkManifestStability(kubectl, resourceTypes, resourceType) if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
core.endGroup() core.info("Routing blue green");
const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true })
);
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy);
}
// print ingresses // print ingresses
core.startGroup('Printing ingresses') core.info("Printing ingresses");
const ingressResources: Resource[] = getResources(deployedManifestFiles, [ const ingressResources: Resource[] = getResources(deployedManifestFiles, [
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
]) ]);
for (const ingressResource of ingressResources) { for (const ingressResource of ingressResources) {
await kubectl.getResource( await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name, ingressResource.name
false, );
ingressResource.namespace }
)
}
core.endGroup()
// annotate resources // annotate resources
core.startGroup('Annotating resources') core.info("Annotating resources");
await annotateAndLabelResources( let allPods;
deployedManifestFiles, try {
kubectl, allPods = JSON.parse((await kubectl.getAllPods()).stdout);
resourceTypes } catch (e) {
) core.debug("Unable to parse pods: " + e);
core.endGroup() }
await annotateAndLabelResources(
deployedManifestFiles,
kubectl,
resourceTypes,
allPods
);
} }
+172 -228
View File
@@ -1,228 +1,172 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as deploy from "./deploy";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as PodCanaryHelper from '../strategyHelpers/canary/podCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import {annotateAndLabelResources} from '../strategyHelpers/deploymentHelper' import * as models from "../types/kubernetesTypes";
import * as models from '../types/kubernetesTypes' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import {
import { BlueGreenManifests,
deleteGreenObjects, deleteWorkloadsAndServicesWithLabel,
getManifestObjects, deleteWorkloadsWithLabel,
NONE_LABEL_VALUE getManifestObjects,
} from '../strategyHelpers/blueGreen/blueGreenHelper' GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
import {BlueGreenManifests} from '../types/blueGreenTypes' } from "../strategyHelpers/blueGreen/blueGreenHelper";
import {DeployResult} from '../types/deployResult' import {
promoteBlueGreenService,
import { routeBlueGreenService,
promoteBlueGreenIngress, } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
promoteBlueGreenService, import {
promoteBlueGreenSMI promoteBlueGreenIngress,
} from '../strategyHelpers/blueGreen/promote' routeBlueGreenIngress,
} from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
import { import {
routeBlueGreenService, cleanupSMI,
routeBlueGreenIngressUnchanged, promoteBlueGreenSMI,
routeBlueGreenSMI routeBlueGreenSMI,
} from '../strategyHelpers/blueGreen/route' } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
import { Kubectl, Resource } from "../types/kubectl";
import {cleanupSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper' import { DeploymentStrategy } from "../types/deploymentStrategy";
import {Kubectl, Resource} from '../types/kubectl' import {
import {DeploymentStrategy} from '../types/deploymentStrategy' parseTrafficSplitMethod,
import { TrafficSplitMethod,
parseTrafficSplitMethod, } from "../types/trafficSplitMethod";
TrafficSplitMethod import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' export async function promote(
import {ClusterType} from '../inputUtils' kubectl: Kubectl,
manifests: string[],
export async function promote( deploymentStrategy: DeploymentStrategy
kubectl: Kubectl, ) {
manifests: string[], switch (deploymentStrategy) {
deploymentStrategy: DeploymentStrategy, case DeploymentStrategy.CANARY:
resourceType: ClusterType await promoteCanary(kubectl, manifests);
) { break;
switch (deploymentStrategy) { case DeploymentStrategy.BLUE_GREEN:
case DeploymentStrategy.CANARY: await promoteBlueGreen(kubectl, manifests);
await promoteCanary(kubectl, manifests) break;
break default:
case DeploymentStrategy.BLUE_GREEN: throw Error("Invalid promote deployment strategy");
await promoteBlueGreen(kubectl, manifests, resourceType) }
break }
default:
throw Error('Invalid promote deployment strategy') async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
} let includeServices = false;
}
const trafficSplitMethod = parseTrafficSplitMethod(
async function promoteCanary(kubectl: Kubectl, manifests: string[]) { core.getInput("traffic-split-method", { required: true })
let includeServices = false );
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
const manifestFilesForDeployment: string[] = updateManifestFiles(manifests) includeServices = true;
const trafficSplitMethod = parseTrafficSplitMethod( // In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
core.getInput('traffic-split-method', {required: true}) // canary deployment, then update stable deployment and then redirect traffic to stable deployment
) core.info("Redirecting traffic to canary deployment");
let promoteResult: DeployResult await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
let filesToAnnotate: string[] kubectl,
if (trafficSplitMethod == TrafficSplitMethod.SMI) { manifests
includeServices = true );
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to core.info("Deploying input manifests with SMI canary strategy");
// canary deployment, then update stable deployment and then redirect traffic to stable deployment await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
core.startGroup('Redirecting traffic to canary deployment')
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment( core.info("Redirecting traffic to stable deployment");
kubectl, await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
manifests kubectl,
) manifests
core.endGroup() );
} else {
core.startGroup( core.info("Deploying input manifests");
'Deploying input manifests with SMI canary strategy from promote' await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
) }
promoteResult = await SMICanaryDeploymentHelper.deploySMICanary( core.info("Deleting canary and baseline workloads");
manifestFilesForDeployment, try {
kubectl, await canaryDeploymentHelper.deleteCanaryDeployment(
true kubectl,
) manifests,
includeServices
core.endGroup() );
} catch (ex) {
core.startGroup('Redirecting traffic to stable deployment') core.warning(
const stableRedirectManifests = "Exception occurred while deleting canary and baseline workloads: " + ex
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( );
kubectl, }
manifests }
)
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
filesToAnnotate = promoteResult.manifestFiles.concat( // update container images and pull secrets
stableRedirectManifests const inputManifestFiles: string[] = updateManifestFiles(manifests);
) const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles);
core.endGroup()
} else { const routeStrategy = parseRouteStrategy(
core.startGroup('Deploying input manifests from promote') core.getInput("route-method", { required: true })
promoteResult = await PodCanaryHelper.deployPodCanary( );
manifestFilesForDeployment,
kubectl, core.info("Deleting old deployment and making new one");
true let result;
) if (routeStrategy == RouteStrategy.INGRESS) {
filesToAnnotate = promoteResult.manifestFiles result = await promoteBlueGreenIngress(kubectl, manifestObjects);
core.endGroup() } else if (routeStrategy == RouteStrategy.SMI) {
} result = await promoteBlueGreenSMI(kubectl, manifestObjects);
} else {
core.startGroup('Deleting canary and baseline workloads') result = await promoteBlueGreenService(kubectl, manifestObjects);
try { }
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl, // checking stability of newly created deployments
manifests, core.info("Checking manifest stability");
includeServices const deployedManifestFiles = result.newFilePaths;
) const resources: Resource[] = getResources(
} catch (ex) { deployedManifestFiles,
core.warning( models.DEPLOYMENT_TYPES.concat([
`Exception occurred while deleting canary and baseline workloads: ${ex}` models.DiscoveryAndLoadBalancerResource.SERVICE,
) ])
} );
core.endGroup() await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
// annotate resources core.info(
core.startGroup('Annotating resources') "Routing to new deployments and deleting old workloads and services"
const resources: Resource[] = getResources( );
filesToAnnotate, if (routeStrategy == RouteStrategy.INGRESS) {
models.DEPLOYMENT_TYPES.concat([ await routeBlueGreenIngress(
models.DiscoveryAndLoadBalancerResource.SERVICE kubectl,
]) null,
) manifestObjects.serviceNameMap,
await annotateAndLabelResources(filesToAnnotate, kubectl, resources) manifestObjects.ingressEntityList
core.endGroup() );
} await deleteWorkloadsAndServicesWithLabel(
kubectl,
async function promoteBlueGreen( GREEN_LABEL_VALUE,
kubectl: Kubectl, manifestObjects.deploymentEntityList,
manifests: string[], manifestObjects.serviceEntityList
resourceType: ClusterType );
) { } else if (routeStrategy == RouteStrategy.SMI) {
// update container images and pull secrets await routeBlueGreenSMI(
const inputManifestFiles: string[] = updateManifestFiles(manifests) kubectl,
const manifestObjects: BlueGreenManifests = NONE_LABEL_VALUE,
getManifestObjects(inputManifestFiles) manifestObjects.serviceEntityList
);
const routeStrategy = parseRouteStrategy( await deleteWorkloadsWithLabel(
core.getInput('route-method', {required: true}) kubectl,
) GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
core.startGroup('Deleting old deployment and making new stable deployment') );
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
const {deployResult} = await (async () => { } else {
switch (routeStrategy) { await routeBlueGreenService(
case RouteStrategy.INGRESS: kubectl,
return await promoteBlueGreenIngress(kubectl, manifestObjects) NONE_LABEL_VALUE,
case RouteStrategy.SMI: manifestObjects.serviceEntityList
return await promoteBlueGreenSMI(kubectl, manifestObjects) );
default: await deleteWorkloadsWithLabel(
return await promoteBlueGreenService(kubectl, manifestObjects) kubectl,
} GREEN_LABEL_VALUE,
})() manifestObjects.deploymentEntityList
);
core.endGroup() }
}
// checking stability of newly created deployments
core.startGroup('Checking manifest stability')
const deployedManifestFiles = deployResult.manifestFiles
const resources: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE
])
)
await KubernetesManifestUtility.checkManifestStability(
kubectl,
resources,
resourceType
)
core.endGroup()
core.startGroup(
'Routing to new deployments and deleting old workloads and services'
)
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngressUnchanged(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
await deleteGreenObjects(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
)
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
} else {
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
}
core.endGroup()
// annotate resources
core.startGroup('Annotating resources')
await annotateAndLabelResources(deployedManifestFiles, kubectl, resources)
core.endGroup()
}
+68 -77
View File
@@ -1,77 +1,68 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
import {BlueGreenManifests} from '../types/blueGreenTypes' import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import { import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
rejectBlueGreenIngress, import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
rejectBlueGreenService, import { DeploymentStrategy } from "../types/deploymentStrategy";
rejectBlueGreenSMI import {
} from '../strategyHelpers/blueGreen/reject' parseTrafficSplitMethod,
import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper' TrafficSplitMethod,
import {DeploymentStrategy} from '../types/deploymentStrategy' } from "../types/trafficSplitMethod";
import { import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
parseTrafficSplitMethod,
TrafficSplitMethod export async function reject(
} from '../types/trafficSplitMethod' kubectl: Kubectl,
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' manifests: string[],
deploymentStrategy: DeploymentStrategy
export async function reject( ) {
kubectl: Kubectl, switch (deploymentStrategy) {
manifests: string[], case DeploymentStrategy.CANARY:
deploymentStrategy: DeploymentStrategy await rejectCanary(kubectl, manifests);
) { break;
switch (deploymentStrategy) { case DeploymentStrategy.BLUE_GREEN:
case DeploymentStrategy.CANARY: await rejectBlueGreen(kubectl, manifests);
await rejectCanary(kubectl, manifests) break;
break default:
case DeploymentStrategy.BLUE_GREEN: throw "Invalid delete deployment strategy";
await rejectBlueGreen(kubectl, manifests) }
break }
default:
throw 'Invalid delete deployment strategy' async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
} let includeServices = false;
}
const trafficSplitMethod = parseTrafficSplitMethod(
async function rejectCanary(kubectl: Kubectl, manifests: string[]) { core.getInput("traffic-split-method", { required: true })
let includeServices = false );
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
const trafficSplitMethod = parseTrafficSplitMethod( core.info("Rejecting deployment with SMI canary strategy");
core.getInput('traffic-split-method', {required: true}) includeServices = true;
) await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
if (trafficSplitMethod == TrafficSplitMethod.SMI) { kubectl,
core.startGroup('Rejecting deployment with SMI canary strategy') manifests
includeServices = true );
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( }
kubectl,
manifests core.info("Deleting baseline and canary workloads");
) await canaryDeploymentHelper.deleteCanaryDeployment(
core.endGroup() kubectl,
} manifests,
includeServices
core.startGroup('Deleting baseline and canary workloads') );
await canaryDeploymentHelper.deleteCanaryDeployment( }
kubectl,
manifests, async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
includeServices core.info("Rejecting deployment with blue green strategy");
)
core.endGroup() const routeStrategy = parseRouteStrategy(
} core.getInput("route-method", { required: true })
);
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) { if (routeStrategy == RouteStrategy.INGRESS) {
const routeStrategy = parseRouteStrategy( await rejectBlueGreenIngress(kubectl, manifests);
core.getInput('route-method', {required: true}) } else if (routeStrategy == RouteStrategy.SMI) {
) await rejectBlueGreenSMI(kubectl, manifests);
core.startGroup('Rejecting deployment with blue green strategy') } else {
core.info(`using routeMethod ${routeStrategy}`) await rejectBlueGreenService(kubectl, manifests);
const manifestObjects: BlueGreenManifests = getManifestObjects(manifests) }
}
if (routeStrategy == RouteStrategy.INGRESS) {
await rejectBlueGreenIngress(kubectl, manifestObjects)
} else if (routeStrategy == RouteStrategy.SMI) {
await rejectBlueGreenSMI(kubectl, manifestObjects)
} else {
await rejectBlueGreenService(kubectl, manifestObjects)
}
core.endGroup()
}
-34
View File
@@ -1,34 +0,0 @@
import {parseResourceTypeInput} from './inputUtils'
import {
ClusterType,
ResourceTypeFleet,
ResourceTypeManagedCluster
} from './actions/deploy'
describe('InputUtils', () => {
describe('parseResourceTypeInput', () => {
it('should extract fleet exact match resource type', () => {
expect(
parseResourceTypeInput('Microsoft.ContainerService/fleets')
).toEqual(ResourceTypeFleet)
})
it('should match fleet case-insensitively', () => {
expect(
parseResourceTypeInput('Microsoft.containerservice/fleets')
).toEqual(ResourceTypeFleet)
})
it('should match managed cluster case-insensitively', () => {
expect(
parseResourceTypeInput('Microsoft.containerservice/MAnaGedClusterS')
).toEqual(ResourceTypeManagedCluster)
})
it('should error on unexpected values', () => {
expect(() => {
parseResourceTypeInput('icrosoft.ContainerService/ManagedCluster')
}).toThrow()
expect(() => {
parseResourceTypeInput('wrong-value')
}).toThrow()
})
})
})
-32
View File
@@ -1,32 +0,0 @@
import * as core from '@actions/core'
import {parseAnnotations} from './types/annotations'
import {ResourceTypeFleet, ResourceTypeManagedCluster} from './actions/deploy'
export const inputAnnotations = parseAnnotations(
core.getInput('annotations', {required: false})
)
export function getBufferTime(): number {
const inputBufferTime = parseInt(
core.getInput('version-switch-buffer') || '0'
)
if (inputBufferTime < 0 || inputBufferTime > 300)
throw Error('Version switch buffer must be between 0 and 300 (inclusive)')
return inputBufferTime
}
export function parseResourceTypeInput(rawInput: string): ClusterType {
switch (rawInput.toLowerCase()) {
case ResourceTypeFleet.toLowerCase():
return ResourceTypeFleet
case ResourceTypeManagedCluster.toLowerCase():
return ResourceTypeManagedCluster
}
throw new Error(
`Invalid resource type: ${rawInput}. Supported resource types are: ${ResourceTypeManagedCluster} (default), ${ResourceTypeFleet}`
)
}
export type ClusterType =
| typeof ResourceTypeManagedCluster
| typeof ResourceTypeFleet
+56 -87
View File
@@ -1,87 +1,56 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {getKubectlPath, Kubectl} from './types/kubectl' import { getKubectlPath, Kubectl } from "./types/kubectl";
import { import { deploy } from "./actions/deploy";
deploy, import { promote } from "./actions/promote";
ResourceTypeFleet, import { reject } from "./actions/reject";
ResourceTypeManagedCluster import { Action, parseAction } from "./types/action";
} from './actions/deploy' import { parseDeploymentStrategy } from "./types/deploymentStrategy";
import {ClusterType} from './inputUtils' import { getFilesFromDirectories } from "./utilities/fileUtils";
import {promote} from './actions/promote'
import {reject} from './actions/reject' export async function run() {
import {Action, parseAction} from './types/action' // verify kubeconfig is set
import {parseDeploymentStrategy} from './types/deploymentStrategy' if (!process.env["KUBECONFIG"])
import {getFilesFromDirectoriesAndURLs} from './utilities/fileUtils' core.warning(
import {PrivateKubectl} from './types/privatekubectl' "KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action."
import {parseResourceTypeInput} from './inputUtils' );
export async function run() { // get inputs
// verify kubeconfig is set const action: Action | undefined = parseAction(
if (!process.env['KUBECONFIG']) core.getInput("action", { required: true })
core.warning( );
'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.' const strategy = parseDeploymentStrategy(core.getInput("strategy"));
) const manifestsInput = core.getInput("manifests", { required: true });
const manifestFilePaths = manifestsInput
// get inputs .split(/[\n,;]+/) // split into each individual manifest
const action: Action | undefined = parseAction( .map((manifest) => manifest.trim()) // remove surrounding whitespace
core.getInput('action', {required: true}) .filter((manifest) => manifest.length > 0); // remove any blanks
)
const strategy = parseDeploymentStrategy(core.getInput('strategy')) const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
const manifestsInput = core.getInput('manifests', {required: true}) // create kubectl
const manifestFilePaths = manifestsInput const kubectlPath = await getKubectlPath();
.split(/[\n,;]+/) // split into each individual manifest const namespace = core.getInput("namespace") || "default";
.map((manifest) => manifest.trim()) // remove surrounding whitespace const kubectl = new Kubectl(kubectlPath, namespace, true);
.filter((manifest) => manifest.length > 0) // remove any blanks
// run action
const fullManifestFilePaths = switch (action) {
await getFilesFromDirectoriesAndURLs(manifestFilePaths) case Action.DEPLOY: {
const kubectlPath = await getKubectlPath() await deploy(kubectl, fullManifestFilePaths, strategy);
const namespace = core.getInput('namespace') || 'default' break;
const isPrivateCluster = }
core.getInput('private-cluster').toLowerCase() === 'true' case Action.PROMOTE: {
const resourceGroup = core.getInput('resource-group') || '' await promote(kubectl, fullManifestFilePaths, strategy);
const resourceName = core.getInput('name') || '' break;
const skipTlsVerify = core.getBooleanInput('skip-tls-verify') }
case Action.REJECT: {
let resourceType: ClusterType await reject(kubectl, fullManifestFilePaths, strategy);
try { break;
// included in the trycatch to allow raw input to go out of scope after parsing }
const resourceTypeInput = core.getInput('resource-type') default: {
resourceType = parseResourceTypeInput(resourceTypeInput) throw Error(
} catch (e) { 'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
core.setFailed(e) );
return }
} }
}
const kubectl = isPrivateCluster
? new PrivateKubectl( run().catch(core.setFailed);
kubectlPath,
namespace,
skipTlsVerify,
resourceGroup,
resourceName
)
: new Kubectl(kubectlPath, namespace, skipTlsVerify)
// run action
switch (action) {
case Action.DEPLOY: {
await deploy(kubectl, fullManifestFilePaths, strategy, resourceType)
break
}
case Action.PROMOTE: {
await promote(kubectl, fullManifestFilePaths, strategy, resourceType)
break
}
case Action.REJECT: {
await reject(kubectl, fullManifestFilePaths, strategy)
break
}
default: {
throw Error(
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
)
}
}
}
run().catch(core.setFailed)
@@ -1,196 +0,0 @@
import {
deployWithLabel,
deleteGreenObjects,
fetchResource,
getDeploymentMatchLabels,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
isServiceRouted
} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import {K8sObject} from '../../types/k8sObject'
import * as manifestUpdateUtils from '../../utilities/manifestUpdateUtils'
import {ExecOutput} from '@actions/exec'
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('bluegreenhelper functions', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(['test/unit/manifests/test-ingress.yml'])
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly deletes services and workloads according to label', async () => {
jest.spyOn(bgHelper, 'deleteObjects').mockReturnValue({} as Promise<void>)
const value = await deleteGreenObjects(
kubectl,
[].concat(
testObjects.deploymentEntityList,
testObjects.serviceEntityList
)
)
expect(value).toHaveLength(2)
expect(value).toContainEqual({
name: 'nginx-service-green',
kind: 'Service'
})
expect(value).toContainEqual({
name: 'nginx-deployment-green',
kind: 'Deployment'
})
})
test('parses objects correctly from one file (getManifestObjects)', () => {
expect(testObjects.deploymentEntityList[0].kind).toBe('Deployment')
expect(testObjects.serviceEntityList[0].kind).toBe('Service')
expect(testObjects.ingressEntityList[0].kind).toBe('Ingress')
expect(
testObjects.deploymentEntityList[0].spec.selector.matchLabels.app
).toBe('nginx')
})
test('parses other kinds of objects (getManifestObjects)', () => {
const otherObjectsCollection = getManifestObjects([
'test/unit/manifests/anomaly-objects-test.yml'
])
expect(
otherObjectsCollection.unroutedServiceEntityList[0].metadata.name
).toBe('unrouted-service')
expect(otherObjectsCollection.otherObjects[0].metadata.name).toBe(
'foobar-rollout'
)
})
test('correctly classifies routed services', () => {
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(true)
testObjects.serviceEntityList[0].spec.selector.app = 'fakeapp'
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(false)
})
test('correctly makes labeled workloads', async () => {
const cwlResult: BlueGreenDeployment = await deployWithLabel(
kubectl,
testObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
expect(cwlResult.deployResult.manifestFiles[0]).toBe('')
})
test('correctly makes new blue green object (getNewBlueGreenObject and addBlueGreenLabelsAndAnnotations)', () => {
const modifiedDeployment = getNewBlueGreenObject(
testObjects.deploymentEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedDeployment.metadata.name).toBe('nginx-deployment-green')
expect(modifiedDeployment.metadata.labels['k8s.deploy.color']).toBe(
'green'
)
const modifiedSvc = getNewBlueGreenObject(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedSvc.metadata.name).toBe('nginx-service-green')
expect(modifiedSvc.metadata.labels['k8s.deploy.color']).toBe('green')
})
test('correctly fetches k8s objects', async () => {
const mockExecOutput = {
stderr: '',
stdout: JSON.stringify(testObjects.deploymentEntityList[0]),
exitCode: 0
}
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
const fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched.metadata.name).toBe('nginx-deployment')
})
test('exits when fails to fetch k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
let fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched).toBe(null)
jest.spyOn(kubectl, 'getResource').mockImplementation()
fetched = await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
expect(fetched).toBe(null)
})
test('returns null when fetch fails to unset k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(manifestUpdateUtils, 'UnsetClusterSpecificDetails')
.mockImplementation(() => {
throw new Error('test error')
})
expect(
await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
).toBe(null)
})
test('gets deployment labels', () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
const mockPodObject: K8sObject = {
kind: 'Pod',
metadata: {name: 'testPod', labels: mockLabels},
spec: {}
}
expect(
getDeploymentMatchLabels(mockPodObject)[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(GREEN_LABEL_VALUE)
expect(
getDeploymentMatchLabels(testObjects.deploymentEntityList[0])['app']
).toBe('nginx')
})
})
+298 -219
View File
@@ -1,276 +1,355 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import { Kubectl } from "../../types/kubectl";
import {DeployResult} from '../../types/deployResult'
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import { import {
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload KubernetesWorkload,
} from '../../types/kubernetesTypes' } from "../../types/kubernetesTypes";
import * as fileHelper from "../../utilities/fileUtils";
import { routeBlueGreenService } from "./serviceBlueGreenHelper";
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
import { import {
BlueGreenDeployment, UnsetClusterSpecificDetails,
BlueGreenManifests updateObjectLabels,
} from '../../types/blueGreenTypes' updateSelectorLabels,
import * as fileHelper from '../../utilities/fileUtils' } from "../../utilities/manifestUpdateUtils";
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils' import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import {checkForErrors} from '../../utilities/kubectlUtils' import { checkForErrors } from "../../utilities/kubectlUtils";
import { import { sleep } from "../../utilities/timeUtils";
UnsetClusterSpecificDetails, import { RouteStrategy } from "../../types/routeStrategy";
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
export const GREEN_LABEL_VALUE = 'green' export const GREEN_LABEL_VALUE = "green";
export const NONE_LABEL_VALUE = 'None' export const NONE_LABEL_VALUE = "None";
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color' export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color";
export const GREEN_SUFFIX = '-green' export const GREEN_SUFFIX = "-green";
export const STABLE_SUFFIX = '-stable' export const STABLE_SUFFIX = "-stable";
export async function deleteGreenObjects( export interface BlueGreenManifests {
kubectl: Kubectl, serviceEntityList: any[];
toDelete: K8sObject[] serviceNameMap: Map<string, string>;
): Promise<K8sDeleteObject[]> { unroutedServiceEntityList: any[];
// const resourcesToDelete: K8sDeleteObject[] = [] deploymentEntityList: any[];
const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => { ingressEntityList: any[];
return { otherObjects: any[];
name: getBlueGreenResourceName(obj.metadata.name, GREEN_SUFFIX),
kind: obj.kind,
namespace: obj.metadata.namespace
}
})
core.debug(`deleting green objects: ${JSON.stringify(resourcesToDelete)}`)
await deleteObjects(kubectl, resourcesToDelete)
return resourcesToDelete
} }
export async function deleteObjects( export async function routeBlueGreen(
kubectl: Kubectl, kubectl: Kubectl,
deleteList: K8sDeleteObject[] inputManifestFiles: string[],
routeStrategy: RouteStrategy
) { ) {
// delete services and deployments // sleep for buffer time
for (const delObject of deleteList) { const bufferTime: number = parseInt(
try { core.getInput("version-switch-buffer") || "0"
const result = await kubectl.delete([delObject.kind, delObject.name]) );
checkForErrors([result]) if (bufferTime < 0 || bufferTime > 300)
} catch (ex) { throw Error("Version switch buffer must be between 0 and 300 (inclusive)");
core.debug(`failed to delete object ${delObject.name}: ${ex}`) const startSleepDate = new Date();
} core.info(
} `Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
);
await sleep(bufferTime * 1000 * 60);
const endSleepDate = new Date();
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
);
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles);
core.debug("Manifest objects: " + JSON.stringify(manifestObjects));
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
} else {
await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
}
}
export async function deleteWorkloadsWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[]
) {
const resourcesToDelete = [];
deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete new green deployments
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteWorkloadsAndServicesWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[],
serviceEntityList: any[]
) {
// need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
const resourcesToDelete = [];
deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete green labels
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// delete services and deployments
for (const delObject of deleteList) {
try {
const result = await kubectl.delete([delObject.kind, delObject.name]);
checkForErrors([result]);
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
}
} }
// other common functions // other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests { export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList: K8sObject[] = [] const deploymentEntityList = [];
const serviceEntityList: K8sObject[] = [] const routedServiceEntityList = [];
const routedServiceEntityList: K8sObject[] = [] const unroutedServiceEntityList = [];
const unroutedServiceEntityList: K8sObject[] = [] const ingressEntityList = [];
const ingressEntityList: K8sObject[] = [] const otherEntitiesList = [];
const otherEntitiesList: K8sObject[] = [] const serviceNameMap = new Map<string, string>();
const serviceNameMap = new Map<string, string>()
// Manifest objects per type. All resources should be parsed and filePaths.forEach((filePath: string) => {
// organized before we can check if services are “routed” or not. const fileContents = fs.readFileSync(filePath).toString();
filePaths.forEach((filePath: string) => { yaml.safeLoadAll(fileContents, (inputObject) => {
try { if (!!inputObject) {
const fileContents = fs.readFileSync(filePath).toString() const kind = inputObject.kind;
yaml.loadAll(fileContents, (inputObject: any) => { const name = inputObject.metadata.name;
if (!!inputObject) {
const kind = inputObject.kind if (isDeploymentEntity(kind)) {
if (isDeploymentEntity(kind)) { deploymentEntityList.push(inputObject);
deploymentEntityList.push(inputObject) } else if (isServiceEntity(kind)) {
} else if (isServiceEntity(kind)) { if (isServiceRouted(inputObject, deploymentEntityList)) {
serviceEntityList.push(inputObject) routedServiceEntityList.push(inputObject);
} else if (isIngressEntity(kind)) { serviceNameMap.set(
ingressEntityList.push(inputObject) name,
} else { getBlueGreenResourceName(name, GREEN_SUFFIX)
otherEntitiesList.push(inputObject) );
} } else {
} unroutedServiceEntityList.push(inputObject);
}) }
} catch (error) { } else if (isIngressEntity(kind)) {
core.error(`Error processing file ${filePath}: ${error.message}`) ingressEntityList.push(inputObject);
throw error } else {
otherEntitiesList.push(inputObject);
}
} }
}) });
});
serviceEntityList.forEach((inputObject: any) => { return {
if (isServiceRouted(inputObject, deploymentEntityList)) { serviceEntityList: routedServiceEntityList,
const name = inputObject.metadata.name serviceNameMap: serviceNameMap,
routedServiceEntityList.push(inputObject) unroutedServiceEntityList: unroutedServiceEntityList,
serviceNameMap.set(name, getBlueGreenResourceName(name, GREEN_SUFFIX)) deploymentEntityList: deploymentEntityList,
} else { ingressEntityList: ingressEntityList,
unroutedServiceEntityList.push(inputObject) otherObjects: otherEntitiesList,
} };
})
return {
serviceEntityList: routedServiceEntityList,
serviceNameMap: serviceNameMap,
unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList
}
} }
export function isServiceRouted( export function isServiceRouted(
serviceObject: any[], serviceObject: any[],
deploymentEntityList: any[] deploymentEntityList: any[]
): boolean { ): boolean {
const serviceSelector: any = getServiceSelector(serviceObject) let shouldBeRouted: boolean = false;
const serviceSelector: any = getServiceSelector(serviceObject);
return ( if (serviceSelector) {
serviceSelector && if (
deploymentEntityList.some((depObject) => { deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets // finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject) const matchLabels: any = getDeploymentMatchLabels(depObject);
return ( return (
matchLabels && matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels) isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
) );
}) })
) ) {
shouldBeRouted = true;
}
}
return shouldBeRouted;
} }
export async function deployWithLabel( export async function createWorkloadsWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deploymentObjectList: any[], deploymentObjectList: any[],
nextLabel: string nextLabel: string
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = deploymentObjectList.map((inputObject) => const newObjectsList = [];
getNewBlueGreenObject(inputObject, nextLabel) deploymentObjectList.forEach((inputObject) => {
) // creating deployment with label
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel);
core.debug(
"New blue-green object is: " + JSON.stringify(newBlueGreenObject)
);
newObjectsList.push(newBlueGreenObject);
});
core.debug( const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
`objects deployed with label are ${JSON.stringify(newObjectsList)}` const result = await kubectl.apply(manifestFiles);
)
const deployResult = await deployObjects(kubectl, newObjectsList) return { result: result, newFilePaths: manifestFiles };
return {deployResult, objects: newObjectsList}
} }
export function getNewBlueGreenObject( export function getNewBlueGreenObject(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Updating name only if label is green label is given // Updating name only if label is green label is given
if (labelValue === GREEN_LABEL_VALUE) { if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
GREEN_SUFFIX GREEN_SUFFIX
) );
} }
// Adding labels and annotations // Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export function addBlueGreenLabelsAndAnnotations( export function addBlueGreenLabelsAndAnnotations(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
) { ) {
//creating the k8s.deploy.color label //creating the k8s.deploy.color label
const newLabels = new Map<string, string>() const newLabels = new Map<string, string>();
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
// updating object labels and selector labels // updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false) updateObjectLabels(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false) updateSelectorLabels(inputObject, newLabels, false);
// updating spec labels if it is not a service // updating spec labels if it is a service
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false) updateSpecLabels(inputObject, newLabels, false);
} }
} }
export function getBlueGreenResourceName(name: string, suffix: string) { export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}` return `${name}${suffix}`;
} }
export function getDeploymentMatchLabels(deploymentObject: any): any { export function getDeploymentMatchLabels(deploymentObject: any): any {
if ( if (
deploymentObject?.kind?.toUpperCase() == deploymentObject?.kind?.toUpperCase() ==
KubernetesWorkload.POD.toUpperCase() && KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels deploymentObject?.metadata?.labels
) { ) {
return deploymentObject.metadata.labels return deploymentObject.metadata.labels;
} else if (deploymentObject?.spec?.selector?.matchLabels) { } else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels return deploymentObject.spec.selector.matchLabels;
} }
} }
export function getServiceSelector(serviceObject: any): any { export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) { if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector return serviceObject.spec.selector;
} }
} }
export function isServiceSelectorSubsetOfMatchLabel( export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any, serviceSelector: any,
matchLabels: any matchLabels: any
): boolean { ): boolean {
const serviceSelectorMap = new Map() const serviceSelectorMap = new Map();
const matchLabelsMap = new Map() const matchLabelsMap = new Map();
JSON.parse(JSON.stringify(serviceSelector), (key, value) => { JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value) serviceSelectorMap.set(key, value);
}) });
JSON.parse(JSON.stringify(matchLabels), (key, value) => { JSON.parse(JSON.stringify(matchLabels), (key, value) => {
matchLabelsMap.set(key, value) matchLabelsMap.set(key, value);
}) });
let isMatch = true let isMatch = true;
serviceSelectorMap.forEach((value, key) => { serviceSelectorMap.forEach((value, key) => {
if ( if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value)
!!key && isMatch = false;
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value });
)
isMatch = false
})
return isMatch return isMatch;
} }
export async function fetchResource( export async function fetchResource(
kubectl: Kubectl, kubectl: Kubectl,
kind: string, kind: string,
name: string, name: string
namespace?: string ) {
): Promise<K8sObject> { const result = await kubectl.getResource(kind, name);
const result = await kubectl.getResource(kind, name, false, namespace) if (result == null || !!result.stderr) {
if (result == null || !!result.stderr) { return null;
return null }
}
if (!!result.stdout) { if (!!result.stdout) {
const resource = JSON.parse(result.stdout) as K8sObject const resource = JSON.parse(result.stdout);
try { try {
UnsetClusterSpecificDetails(resource) UnsetClusterSpecificDetails(resource);
return resource return resource;
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while Parsing ${resource} in Json object: ${ex}` `Exception occurred while Parsing ${resource} in Json object: ${ex}`
) );
} }
} }
}
export async function deployObjects(
kubectl: Kubectl,
objectsList: any[]
): Promise<DeployResult> {
const manifestFiles = fileHelper.writeObjectsToFile(objectsList)
const execResult = await kubectl.apply(manifestFiles)
return {execResult, manifestFiles}
} }
@@ -1,75 +0,0 @@
import {getManifestObjects} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployBlueGreen, deployBlueGreenIngress} from './deploy'
import * as routeTester from './route'
import {Kubectl} from '../../types/kubectl'
import {RouteStrategy} from '../../types/routeStrategy'
import * as TSutils from '../../utilities/trafficSplitUtils'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
describe('deploy tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('correctly determines deploy type and acts accordingly', async () => {
const kubectl = new Kubectl('')
const mockBgDeployment: BlueGreenDeployment = {
deployResult: {
execResult: {exitCode: 0, stderr: '', stdout: ''},
manifestFiles: []
},
objects: []
}
jest
.spyOn(routeTester, 'routeBlueGreenForDeploy')
.mockImplementation(() => Promise.resolve(mockBgDeployment))
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(2)
const result = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(result.objects.length).toBe(2)
const smiResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects.length).toBe(6)
})
test('correctly deploys blue/green ingress', async () => {
const kc = new Kubectl('')
const value = await deployBlueGreenIngress(kc, ingressFilepath)
const nol = value.objects.map((obj) => {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service-green')
}
if (obj.kind === 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment-green')
}
})
})
})
-159
View File
@@ -1,159 +0,0 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {RouteStrategy} from '../../types/routeStrategy'
import {
deployWithLabel,
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {setupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenForDeploy} from './route'
import {DeployResult} from '../../types/deployResult'
export async function deployBlueGreen(
kubectl: Kubectl,
files: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
const blueGreenDeployment = await (async () => {
switch (routeStrategy) {
case RouteStrategy.INGRESS:
return await deployBlueGreenIngress(kubectl, files)
case RouteStrategy.SMI:
return await deployBlueGreenSMI(kubectl, files)
default:
return await deployBlueGreenService(kubectl, files)
}
})()
core.startGroup('Routing blue green')
const routeDeployment = await routeBlueGreenForDeploy(
kubectl,
files,
routeStrategy
)
core.endGroup()
blueGreenDeployment.objects.push(...routeDeployment.objects)
blueGreenDeployment.deployResult.manifestFiles.push(
...routeDeployment.deployResult.manifestFiles
)
return blueGreenDeployment
}
export async function deployBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create services and other objects
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.serviceEntityList,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
const otherObjDeployment: DeployResult = await deployObjects(
kubectl,
newObjectsList
)
// make extraservices and trafficsplit
const smiAndSvcDeployment = await setupSMI(
kubectl,
manifestObjects.serviceEntityList
)
// create new deloyments
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
blueGreenDeployment.objects.push(...newObjectsList)
blueGreenDeployment.objects.push(...smiAndSvcDeployment.objects)
blueGreenDeployment.deployResult.manifestFiles.push(
...otherObjDeployment.manifestFiles
)
blueGreenDeployment.deployResult.manifestFiles.push(
...smiAndSvcDeployment.deployResult.manifestFiles
)
return blueGreenDeployment
}
export async function deployBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const servicesAndDeployments = [].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
const workloadDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
servicesAndDeployments,
GREEN_LABEL_VALUE
)
const otherObjects = [].concat(
manifestObjects.otherObjects,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, otherObjects)
core.debug(
`new objects after processing services and other objects: \n
${JSON.stringify(servicesAndDeployments)}`
)
return {
deployResult: workloadDeployment.deployResult,
objects: [].concat(workloadDeployment.objects, otherObjects)
}
}
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
// create other non deployment and non service entities
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, newObjectsList)
// returning deployment details to check for rollout stability
return {
deployResult: blueGreenDeployment.deployResult,
objects: [].concat(blueGreenDeployment.objects, newObjectsList)
}
}
@@ -1,123 +0,0 @@
import {getManifestObjects, GREEN_LABEL_VALUE} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted,
validateIngresses
} from './ingressBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
const betaFilepath = ['test/unit/manifests/test-ingress.yml']
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('ingress blue green helpers', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('it should correctly classify ingresses', () => {
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
testObjects.ingressEntityList[0].spec.rules[0].http.paths = {}
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(false)
expect(
isIngressRouted(
getManifestObjects(betaFilepath).ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
})
test('it should correctly update ingresses', () => {
const updatedIng = getUpdatedBlueGreenIngress(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.name).toBe('nginx-ingress')
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
const oldIngObjects = getManifestObjects(betaFilepath)
const oldIng = getUpdatedBlueGreenIngress(
oldIngObjects.ingressEntityList[0],
oldIngObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
})
test('it should validate ingresses', async () => {
// what if nothing gets returned from fetchResource?
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
let validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test valid ingress
let mockIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service-green'
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
mockIngress.metadata.labels = mockLabels
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockIngress))
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(true)
// test invalid labels
mockIngress.metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL] =
bgHelper.NONE_LABEL_VALUE
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service'
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test missing fields
mockIngress = {}
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
})
})
@@ -1,121 +1,229 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sIngress} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
GREEN_LABEL_VALUE, BlueGreenManifests,
fetchResource createWorkloadsWithLabel,
} from './blueGreenHelper' deleteWorkloadsAndServicesWithLabel,
import {Kubectl} from '../../types/kubectl' fetchResource,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
import * as core from "@actions/core";
const BACKEND = 'backend' const BACKEND = "BACKEND";
export function getUpdatedBlueGreenIngress( export async function deployBlueGreenIngress(
inputObject: any, kubectl: Kubectl,
serviceNameMap: Map<string, string>, filePaths: string[]
type: string ) {
): K8sIngress { // get all kubernetes objects defined in manifest files
const newObject = JSON.parse(JSON.stringify(inputObject)) const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type)
// update ingress labels // create deployments with green label value
if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') { const result = createWorkloadsWithLabel(
return updateIngressBackendBetaV1(newObject, serviceNameMap) kubectl,
} manifestObjects.deploymentEntityList,
return updateIngressBackend(newObject, serviceNameMap) GREEN_LABEL_VALUE
);
// create new services and other objects
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
} }
export function updateIngressBackendBetaV1( export async function promoteBlueGreenIngress(
inputObject: any, kubectl: Kubectl,
serviceNameMap: Map<string, string> manifestObjects
): any { ) {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { //checking if anything to promote
if (key.toLowerCase() === BACKEND) { if (
const {serviceName} = value !validateIngressesState(
if (serviceNameMap.has(serviceName)) { kubectl,
// update service name with corresponding bluegreen name only if service is provied in given manifests manifestObjects.ingressEntityList,
value.serviceName = serviceNameMap.get(serviceName) manifestObjects.serviceNameMap
} )
) {
throw "Ingress not in promote state";
}
// create stable deployments with new configuration
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
// create stable services with new configuration
const newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route ingress to stables services
await routeBlueGreenIngress(
kubectl,
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
// delete green services and deployments
await deleteWorkloadsAndServicesWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
);
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
nextLabel: string,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
) {
let newObjectsList = [];
if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
);
} else {
ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
inputObject,
serviceNameMap,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenIngressObject);
} else {
newObjectsList.push(inputObject);
} }
});
}
return value core.debug("New objects: " + JSON.stringify(newObjectsList));
}) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
return inputObject export function validateIngressesState(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): boolean {
let areIngressesTargetingNewServices: boolean = true;
ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
);
if (!!existingIngress) {
const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL];
// if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false;
} else {
// no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false;
}
}
});
return areIngressesTargetingNewServices;
}
function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false;
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
if (key === "serviceName" && serviceNameMap.has(value)) {
isIngressRouted = true;
}
return value;
});
return isIngressRouted;
}
export function getUpdatedBlueGreenIngress(
inputObject: any,
serviceNameMap: Map<string, string>,
type: string
): object {
if (!type) {
return inputObject;
}
const newObject = JSON.parse(JSON.stringify(inputObject));
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type);
// update ingress labels
return updateIngressBackend(newObject, serviceNameMap);
} }
export function updateIngressBackend( export function updateIngressBackend(
inputObject: any, inputObject: any,
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): any { ): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if ( if (key.toUpperCase() === BACKEND) {
key.toLowerCase() === BACKEND && const { serviceName } = value;
serviceNameMap.has(value.service.name) if (serviceNameMap.has(serviceName)) {
) { // update service name with corresponding bluegreen name only if service is provied in given manifests
value.service.name = serviceNameMap.get(value.service.name) value.serviceName = serviceNameMap.get(serviceName);
} }
return value }
})
return inputObject return value;
} });
export function isIngressRouted( return inputObject;
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
isIngressRouted =
isIngressRouted ||
(key === 'service' &&
value.hasOwnProperty('name') &&
serviceNameMap.has(value.name))
isIngressRouted =
isIngressRouted || (key === 'serviceName' && serviceNameMap.has(value))
return value
})
return isIngressRouted
}
export async function validateIngresses(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): Promise<{areValid: boolean; invalidIngresses: string[]}> {
let areValid: boolean = true
const invalidIngresses = []
for (const inputObject of ingressEntityList) {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name,
inputObject?.metadata?.namespace
)
const isValid =
!!existingIngress &&
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL] ===
GREEN_LABEL_VALUE
if (!isValid) {
core.debug(
`Invalid ingress detected (must be in green state): ${JSON.stringify(
inputObject
)}`
)
invalidIngresses.push(inputObject.metadata.name)
}
// to be valid, ingress should exist and should be green
areValid = areValid && isValid
}
}
return {areValid, invalidIngresses}
} }
@@ -1,158 +0,0 @@
import * as core from '@actions/core'
import {getManifestObjects} from './blueGreenHelper'
import {
promoteBlueGreenIngress,
promoteBlueGreenService,
promoteBlueGreenSMI
} from './promote'
import {TrafficSplitObject} from '../../types/k8sObject'
import * as servicesTester from './serviceBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {MAX_VAL, MIN_VAL, TRAFFIC_SPLIT_OBJECT} from './smiBlueGreenHelper'
import * as smiTester from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('promote tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('promote blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
const value = await promoteBlueGreenIngress(kubectl, testObjects)
const objects = value.objects
expect(objects).toHaveLength(2)
for (const obj of objects) {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service')
} else if (obj.kind == 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment')
}
expect(obj.metadata.labels['k8s.deploy.color']).toBe('None')
}
})
test('fail to promote invalid blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
await expect(
promoteBlueGreenIngress(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockLabels},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
let value = await promoteBlueGreenService(kubectl, testObjects)
expect(value.objects).toHaveLength(1)
expect(
value.objects[0].metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL]
).toBe(bgHelper.NONE_LABEL_VALUE)
expect(value.objects[0].metadata.name).toBe('nginx-deployment')
})
test('fail to promote invalid blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
jest
.spyOn(servicesTester, 'validateServicesState')
.mockImplementationOnce(() => Promise.resolve(false))
await expect(
promoteBlueGreenService(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green SMI', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
const deployResult = await promoteBlueGreenSMI(kubectl, testObjects)
expect(deployResult.objects).toHaveLength(1)
expect(deployResult.objects[0].metadata.name).toBe('nginx-deployment')
expect(
deployResult.objects[0].metadata.labels[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(bgHelper.NONE_LABEL_VALUE)
})
test('promote blue/green SMI with bad trafficsplit', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest
.spyOn(smiTester, 'validateTrafficSplitsState')
.mockImplementation(() => Promise.resolve(false))
expect(promoteBlueGreenSMI(kubectl, testObjects)).rejects.toThrowError()
})
})
-81
View File
@@ -1,81 +0,0 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployWithLabel, NONE_LABEL_VALUE} from './blueGreenHelper'
import {validateIngresses} from './ingressBlueGreenHelper'
import {validateServicesState} from './serviceBlueGreenHelper'
import {validateTrafficSplitsState} from './smiBlueGreenHelper'
export async function promoteBlueGreenIngress(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
//checking if anything to promote
const {areValid, invalidIngresses} = await validateIngresses(
kubectl,
manifestObjects.ingressEntityList,
manifestObjects.serviceNameMap
)
if (!areValid) {
throw new Error(
`Ingresses are not in promote state: ${invalidIngresses.toString()}`
)
}
// create stable deployments with new configuration
const result: BlueGreenDeployment = await deployWithLabel(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
),
NONE_LABEL_VALUE
)
// create stable services with new configuration
return result
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw new Error('Found services not in promote state')
}
// creating stable deployments with new configurations
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
export async function promoteBlueGreenSMI(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl,
manifestObjects.serviceEntityList
))
) {
throw Error('Not in promote state SMI')
}
// create stable deployments with new configuration
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
@@ -1,66 +0,0 @@
import {getManifestObjects} from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenRejectResult} from '../../types/blueGreenTypes'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {
rejectBlueGreenIngress,
rejectBlueGreenService,
rejectBlueGreenSMI
} from './reject'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('reject tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('reject blue/green ingress', async () => {
const value = await rejectBlueGreenIngress(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(2)
for (const obj of deleteResult) {
if (obj.kind == 'Service') {
expect(obj.name).toBe('nginx-service-green')
}
if (obj.kind == 'Deployment') {
expect(obj.name).toBe('nginx-deployment-green')
}
}
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-ingress')
})
test('reject blue/green service', async () => {
const value = await rejectBlueGreenService(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(1)
expect(deleteResult[0].name).toBe('nginx-deployment-green')
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-service')
})
test('reject blue/green SMI', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const rejectResult = await rejectBlueGreenSMI(kubectl, testObjects)
expect(rejectResult.deleteResult).toHaveLength(2)
})
})
-81
View File
@@ -1,81 +0,0 @@
import {K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests,
BlueGreenRejectResult
} from '../../types/blueGreenTypes'
import {deleteGreenObjects, NONE_LABEL_VALUE} from './blueGreenHelper'
import {routeBlueGreenSMI} from './route'
import {cleanupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenIngressUnchanged, routeBlueGreenService} from './route'
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// get all kubernetes objects defined in manifest files
// route ingress to stables services
const routeResult = await routeBlueGreenIngressUnchanged(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
// delete green services and deployments
const deleteResult = await deleteGreenObjects(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route to stable objects
const routeResult = await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete new deployments with green suffix
const deleteResult = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenSMI(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route trafficsplit to stable deployments
const routeResult = await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete rejected new bluegreen deployments
const deletedObjects = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
// delete trafficsplit and extra services
const cleanupResult = await cleanupSMI(
kubectl,
manifestObjects.serviceEntityList
)
return {routeResult, deleteResult: [].concat(deletedObjects, cleanupResult)}
}
-119
View File
@@ -1,119 +0,0 @@
import * as core from '@actions/core'
import {K8sIngress, TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {getBufferTime} from '../../inputUtils'
import * as inputUtils from '../../inputUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import {
routeBlueGreenIngress,
routeBlueGreenService,
routeBlueGreenForDeploy
} from './route'
jest.mock('../../types/kubectl')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kc = new Kubectl('')
describe('route function tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly prepares blue/green ingresses for deployment', async () => {
const unroutedIngCopy: K8sIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
unroutedIngCopy.metadata.name = 'nginx-ingress-unrouted'
unroutedIngCopy.spec.rules[0].http.paths[0].backend.service.name =
'fake-service'
testObjects.ingressEntityList.push(unroutedIngCopy)
const value = await routeBlueGreenIngress(
kc,
testObjects.serviceNameMap,
testObjects.ingressEntityList
)
expect(value.objects).toHaveLength(2)
expect(value.objects[0].metadata.name).toBe('nginx-ingress')
expect(
(value.objects[0] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('nginx-service-green')
expect(value.objects[1].metadata.name).toBe('nginx-ingress-unrouted')
// unrouted services shouldn't get their service name changed
expect(
(value.objects[1] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('fake-service')
})
test('correctly prepares blue/green services for deployment', async () => {
const value = await routeBlueGreenService(
kc,
GREEN_LABEL_VALUE,
testObjects.serviceEntityList
)
expect(value.objects).toHaveLength(1)
expect(value.objects[0].metadata.name).toBe('nginx-service')
expect(value.objects[0].metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('correctly identifies route pattern and acts accordingly', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(1)
expect(ingressResult.objects[0].metadata.name).toBe('nginx-ingress')
const serviceResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(serviceResult.objects.length).toBe(1)
expect(serviceResult.objects[0].metadata.name).toBe('nginx-service')
const smiResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects).toHaveLength(1)
expect(smiResult.objects[0].metadata.name).toBe(
'nginx-service-trafficsplit'
)
expect(
(smiResult.objects as TrafficSplitObject[])[0].spec.backends
).toHaveLength(2)
})
})
-141
View File
@@ -1,141 +0,0 @@
import {sleep} from '../../utilities/timeUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted
} from './ingressBlueGreenHelper'
import {getUpdatedBlueGreenService} from './serviceBlueGreenHelper'
import {createTrafficSplitObject} from './smiBlueGreenHelper'
import * as core from '@actions/core'
import {K8sObject, TrafficSplitObject} from '../../types/k8sObject'
import {getBufferTime} from '../../inputUtils'
export async function routeBlueGreenForDeploy(
kubectl: Kubectl,
inputManifestFiles: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
// sleep for buffer time
const bufferTime: number = getBufferTime()
const startSleepDate = new Date()
core.info(
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
)
await sleep(bufferTime * 1000 * 60)
const endSleepDate = new Date()
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
)
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles)
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
return await routeBlueGreenIngress(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
} else if (routeStrategy == RouteStrategy.SMI) {
return await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
} else {
return await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
}
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
// const newObjectsList = []
const newObjectsList: K8sObject[] = ingressEntityList.map((obj) => {
if (isIngressRouted(obj, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
obj,
serviceNameMap,
GREEN_LABEL_VALUE
)
return newBlueGreenIngressObject
} else {
core.debug(`unrouted ingress detected ${obj.metadata.name}`)
return obj
}
})
const deployResult = await deployObjects(kubectl, newObjectsList)
return {deployResult, objects: newObjectsList}
}
export async function routeBlueGreenIngressUnchanged(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = serviceEntityList.map((serviceObject) =>
getUpdatedBlueGreenService(serviceObject, nextLabel)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenSMI(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
// let tsObjects: TrafficSplitObject[] = []
const tsObjects: TrafficSplitObject[] = await Promise.all(
serviceEntityList.map(async (serviceObject) => {
const tsObject: TrafficSplitObject = await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
)
return tsObject
})
)
const deployResult = await deployObjects(kubectl, tsObjects)
return {deployResult, objects: tsObjects}
}
@@ -1,65 +0,0 @@
import * as core from '@actions/core'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {
getServiceSpecLabel,
getUpdatedBlueGreenService,
validateServicesState
} from './serviceBlueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('blue/green service helper tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('getUpdatedBlueGreenService', () => {
const newService = getUpdatedBlueGreenService(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(newService.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
expect(newService.spec.selector[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateServicesState', async () => {
const mockLabels = new Map<string, string>()
mockLabels[BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
const mockSelectors = new Map<string, string>()
mockSelectors[BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockSelectors},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
expect(
await validateServicesState(kubectl, testObjects.serviceEntityList)
).toBe(true)
})
test('getServiceSpecLabel', () => {
testObjects.serviceEntityList[0].spec.selector[BLUE_GREEN_VERSION_LABEL] =
GREEN_LABEL_VALUE
expect(getServiceSpecLabel(testObjects.serviceEntityList[0])).toBe(
GREEN_LABEL_VALUE
)
})
})
@@ -1,50 +1,146 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sServiceObject} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import {Kubectl} from '../../types/kubectl'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
fetchResource, BlueGreenManifests,
GREEN_LABEL_VALUE createWorkloadsWithLabel,
} from './blueGreenHelper' deleteWorkloadsWithLabel,
fetchResource,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create other non deployment and non service entities
const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
if (manifestFiles.length > 0) await kubectl.apply(manifestFiles);
// returning deployment details to check for rollout stability
return result;
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
) {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw "Not inP promote state";
}
// creating stable deployments with new configurations
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route to stable objects
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
);
// delete new deployments with green suffix
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
) {
const newObjectsList = [];
serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject,
nextLabel
);
newObjectsList.push(newBlueGreenServiceObject);
});
// configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
// add green labels to configure existing service // add green labels to configure existing service
export function getUpdatedBlueGreenService( function getUpdatedBlueGreenService(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sServiceObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Adding labels and annotations. // Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export async function validateServicesState( export async function validateServicesState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let areServicesGreen: boolean = true let areServicesGreen: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
// finding the existing routed service // finding the existing routed service
const existingService = await fetchResource( const existingService = await fetchResource(
kubectl, kubectl,
serviceObject.kind, serviceObject.kind,
serviceObject.metadata.name, serviceObject.metadata.name
serviceObject?.metadata?.namespace );
)
let isServiceGreen = if (!!existingService) {
!!existingService && const currentLabel: string = getServiceSpecLabel(existingService);
getServiceSpecLabel(existingService as K8sServiceObject) == if (currentLabel != GREEN_LABEL_VALUE) {
GREEN_LABEL_VALUE // service should be targeting deployments with green label
areServicesGreen = areServicesGreen && isServiceGreen areServicesGreen = false;
} }
} else {
// service targeting deployment doesn't exist
areServicesGreen = false;
}
}
return areServicesGreen return areServicesGreen;
} }
export function getServiceSpecLabel(inputObject: K8sServiceObject): string { export function getServiceSpecLabel(inputObject: any): string {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL] if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL];
}
return "";
} }
@@ -1,200 +0,0 @@
import * as core from '@actions/core'
import {TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
import {
cleanupSMI,
createTrafficSplitObject,
getGreenSMIServiceResource,
getStableSMIServiceResource,
MAX_VAL,
MIN_VAL,
setupSMI,
TRAFFIC_SPLIT_OBJECT,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX,
validateTrafficSplitsState
} from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
jest.mock('../../types/kubectl')
const kc = new Kubectl('')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
describe('SMI Helper tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve(''))
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('setupSMI tests', async () => {
const smiResults = await setupSMI(kc, testObjects.serviceEntityList)
let found = 0
for (const obj of smiResults.objects) {
if (obj.metadata.name === 'nginx-service-stable') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(obj.spec.selector.app).toBe('nginx')
found++
}
if (obj.metadata.name === 'nginx-service-green') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
found++
}
if (obj.metadata.name === 'nginx-service-trafficsplit') {
found++
// expect stable weight to be max val
const casted = obj as TrafficSplitObject
expect(casted.spec.backends).toHaveLength(2)
for (const be of casted.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
}
}
expect(found).toBe(3)
})
test('createTrafficSplitObject tests', async () => {
const noneTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
NONE_LABEL_VALUE
)
expect(noneTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (let be of noneTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
const greenTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
GREEN_LABEL_VALUE
)
expect(greenTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (const be of greenTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MIN_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MAX_VAL)
}
}
})
test('getSMIServiceResource test', () => {
const stableResult = getStableSMIServiceResource(
testObjects.serviceEntityList[0]
)
const greenResult = getGreenSMIServiceResource(
testObjects.serviceEntityList[0]
)
expect(stableResult.metadata.name).toBe('nginx-service-stable')
expect(stableResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(greenResult.metadata.name).toBe('nginx-service-green')
expect(greenResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateTrafficSplitsState', async () => {
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
let valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(true)
const mockTsCopy = JSON.parse(JSON.stringify(mockTsObject))
mockTsCopy.spec.backends[0].weight = MAX_VAL
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsCopy))
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
})
test('cleanupSMI test', async () => {
const deleteObjects = await cleanupSMI(kc, testObjects.serviceEntityList)
expect(deleteObjects).toHaveLength(1)
expect(deleteObjects[0].name).toBe('nginx-service-green')
expect(deleteObjects[0].kind).toBe('Service')
})
})
@@ -1,195 +1,272 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {Kubectl} from '../../types/kubectl' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as fileHelper from "../../utilities/fileUtils";
import { import {
deleteObjects, BlueGreenManifests,
deployObjects, createWorkloadsWithLabel,
fetchResource, deleteObjects,
getBlueGreenResourceName, deleteWorkloadsWithLabel,
getNewBlueGreenObject, fetchResource,
GREEN_LABEL_VALUE, getBlueGreenResourceName,
GREEN_SUFFIX, getManifestObjects,
NONE_LABEL_VALUE, getNewBlueGreenObject,
STABLE_SUFFIX GREEN_LABEL_VALUE,
} from './blueGreenHelper' GREEN_SUFFIX,
import {BlueGreenDeployment} from '../../types/blueGreenTypes' NONE_LABEL_VALUE,
import { STABLE_SUFFIX,
K8sDeleteObject, } from "./blueGreenHelper";
K8sObject,
TrafficSplitObject
} from '../../types/k8sObject'
import {DeployResult} from '../../types/deployResult'
import {inputAnnotations} from '../../inputUtils'
export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit' const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit";
export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit' const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export const MIN_VAL = 0 const MIN_VAL = 0;
export const MAX_VAL = 100 const MAX_VAL = 100;
export async function setupSMI( export async function deployBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] filePaths: string[]
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = [] // get all kubernetes objects defined in manifest files
const trafficObjectList = [] const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
serviceEntityList.forEach((serviceObject) => { // create services and other objects
// create a trafficsplit for service const newObjectsList = manifestObjects.otherObjects
trafficObjectList.push(serviceObject) .concat(manifestObjects.serviceEntityList)
// set up the services for trafficsplit .concat(manifestObjects.ingressEntityList)
const newStableService = getStableSMIServiceResource(serviceObject) .concat(manifestObjects.unroutedServiceEntityList);
const newGreenService = getGreenSMIServiceResource(serviceObject) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
newObjectsList.push(newStableService) await kubectl.apply(manifestFiles);
newObjectsList.push(newGreenService)
})
const tsObjects: TrafficSplitObject[] = [] // make extraservices and trafficsplit
// route to stable service await setupSMI(kubectl, manifestObjects.serviceEntityList);
for (const svc of trafficObjectList) {
const tsObject = await createTrafficSplitObject(
kubectl,
svc.metadata.name,
NONE_LABEL_VALUE
)
tsObjects.push(tsObject as TrafficSplitObject)
}
const objectsToDeploy = [].concat(newObjectsList, tsObjects) // create new deloyments
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
}
// create services export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
const smiDeploymentResult: DeployResult = await deployObjects( // checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl, kubectl,
objectsToDeploy manifestObjects.serviceEntityList
) ))
) {
throw Error("Not in promote state SMI");
}
return { // create stable deployments with new configuration
objects: objectsToDeploy, return await createWorkloadsWithLabel(
deployResult: smiDeploymentResult kubectl,
} manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
} }
let trafficSplitAPIVersion = '' export async function rejectBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
export async function createTrafficSplitObject( // route trafficsplit to stable deploymetns
kubectl: Kubectl, await routeBlueGreenSMI(
name: string, kubectl,
nextLabel: string NONE_LABEL_VALUE,
): Promise<TrafficSplitObject> { manifestObjects.serviceEntityList
// cache traffic split api version );
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion =
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
// retrieve annotations for TS object // delete rejected new bluegreen deployments
const annotations = inputAnnotations await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
// decide weights based on nextlabel // delete trafficsplit and extra services
const stableWeight: number = await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL
const trafficSplitObject: TrafficSplitObject = {
apiVersion: trafficSplitAPIVersion,
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
annotations: annotations,
labels: new Map<string, string>()
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight
}
]
}
}
return trafficSplitObject
} }
export function getStableSMIServiceResource(inputObject: K8sObject): K8sObject { export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObjectsList = [];
// adding stable suffix to service name const trafficObjectList = [];
newObject.metadata.name = getBlueGreenResourceName(
serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service
trafficObjectList.push(serviceObject);
// set up the services for trafficsplit
const newStableService = getSMIServiceResource(
serviceObject,
STABLE_SUFFIX
);
const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX);
newObjectsList.push(newStableService);
newObjectsList.push(newGreenService);
});
// create services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// route to stable service
trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject(
kubectl,
inputObject.metadata.name,
NONE_LABEL_VALUE
);
});
}
let trafficSplitAPIVersion = "";
async function createTrafficSplitObject(
kubectl: Kubectl,
name: string,
nextLabel: string
): Promise<any> {
// cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
);
// decide weights based on nextlabel
const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL;
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL;
const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: "TrafficSplit",
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight,
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight,
},
],
},
});
// create traffic split object
const trafficSplitManifestFile = fileHelper.writeManifestToFile(
trafficSplitObject,
TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
);
await kubectl.apply(trafficSplitManifestFile);
}
export function getSMIServiceResource(
inputObject: any,
suffix: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject));
if (suffix === STABLE_SUFFIX) {
// adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
) );
return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE) return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE);
} else {
// green label will be added for these
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE);
}
} }
export function getGreenSMIServiceResource(inputObject: K8sObject): K8sObject { export async function routeBlueGreenSMI(
const newObject = JSON.parse(JSON.stringify(inputObject)) kubectl: Kubectl,
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE) nextLabel: string,
serviceEntityList: any[]
) {
for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label
await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
);
}
} }
export async function validateTrafficSplitsState( export async function validateTrafficSplitsState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let trafficSplitsInRightState: boolean = true let trafficSplitsInRightState: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name const name = serviceObject.metadata.name;
let trafficSplitObject = await fetchResource( let trafficSplitObject = await fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX), getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
serviceObject?.metadata?.namespace );
)
core.debug( if (!trafficSplitObject) {
`ts object extracted was ${JSON.stringify(trafficSplitObject)}` // no traffic split exits
) trafficSplitsInRightState = false;
if (!trafficSplitObject) { }
core.debug(`no traffic split exits for ${name}`)
trafficSplitsInRightState = false trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
continue trafficSplitObject.spec.backends.forEach((element) => {
// checking if trafficsplit in right state to deploy
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
} }
trafficSplitObject.spec.backends.forEach((element) => { if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) {
// checking if trafficsplit in right state to deploy if (element.weight != MIN_VAL) trafficSplitsInRightState = false;
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) { }
trafficSplitsInRightState = });
trafficSplitsInRightState && element.weight == MAX_VAL }
}
if ( return trafficSplitsInRightState;
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MIN_VAL
}
})
}
return trafficSplitsInRightState
} }
export async function cleanupSMI( export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
kubectl: Kubectl, const deleteList = [];
serviceEntityList: any[]
): Promise<K8sDeleteObject[]> {
const deleteList: K8sDeleteObject[] = []
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
GREEN_SUFFIX TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
), ),
kind: serviceObject.kind, kind: TRAFFIC_SPLIT_OBJECT,
namespace: serviceObject?.metadata?.namespace });
})
})
// delete all objects deleteList.push({
await deleteObjects(kubectl, deleteList) name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX),
kind: serviceObject.kind,
});
return deleteList deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
STABLE_SUFFIX
),
kind: serviceObject.kind,
});
});
// delete all objects
await deleteObjects(kubectl, deleteList);
} }
+196 -243
View File
@@ -1,243 +1,196 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import {
import { isDeploymentEntity,
isDeploymentEntity, isServiceEntity,
isServiceEntity, KubernetesWorkload,
KubernetesWorkload } from "../../types/kubernetesTypes";
} from '../../types/kubernetesTypes' import * as utils from "../../utilities/manifestUpdateUtils";
import * as utils from '../../utilities/manifestUpdateUtils' import {
import { updateObjectAnnotations,
updateObjectAnnotations, updateObjectLabels,
updateObjectLabels, updateSelectorLabels,
updateSelectorLabels } from "../../utilities/manifestUpdateUtils";
} from '../../utilities/manifestUpdateUtils' import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils' import { checkForErrors } from "../../utilities/kubectlUtils";
import {checkForErrors} from '../../utilities/kubectlUtils'
export const CANARY_VERSION_LABEL = "workflow/version";
export const CANARY_VERSION_LABEL = 'workflow/version' const BASELINE_SUFFIX = "-baseline";
const BASELINE_SUFFIX = '-baseline' export const BASELINE_LABEL_VALUE = "baseline";
export const BASELINE_LABEL_VALUE = 'baseline' const CANARY_SUFFIX = "-canary";
const CANARY_SUFFIX = '-canary' export const CANARY_LABEL_VALUE = "canary";
export const CANARY_LABEL_VALUE = 'canary' export const STABLE_SUFFIX = "-stable";
export const STABLE_SUFFIX = '-stable' export const STABLE_LABEL_VALUE = "stable";
export const STABLE_LABEL_VALUE = 'stable'
export async function deleteCanaryDeployment(
export async function deleteCanaryDeployment( kubectl: Kubectl,
kubectl: Kubectl, manifestFilePaths: string[],
manifestFilePaths: string[], includeServices: boolean
includeServices: boolean ) {
): Promise<string[]> { if (manifestFilePaths == null || manifestFilePaths.length == 0) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) { throw new Error("Manifest file not found");
throw new Error('Manifest files for deleting canary deployment not found') }
}
await cleanUpCanary(kubectl, manifestFilePaths, includeServices);
const deletedFiles = await cleanUpCanary( }
kubectl,
manifestFilePaths, export function markResourceAsStable(inputObject: any): object {
includeServices if (isResourceMarkedAsStable(inputObject)) {
) return inputObject;
return deletedFiles }
}
const newObject = JSON.parse(JSON.stringify(inputObject));
export function markResourceAsStable(inputObject: any): object { addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE);
if (isResourceMarkedAsStable(inputObject)) { return newObject;
return inputObject }
}
export function isResourceMarkedAsStable(inputObject: any): boolean {
const newObject = JSON.parse(JSON.stringify(inputObject)) return (
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE) inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
return newObject );
} }
export function isResourceMarkedAsStable(inputObject: any): boolean { export function getStableResource(inputObject: any): object {
return ( const replicaCount = specContainsReplicas(inputObject.kind)
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE ? inputObject.metadata.replicas
) : 0;
}
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
export function getStableResource(inputObject: any): object { }
const replicaCount = specContainsReplicas(inputObject.kind)
? inputObject.spec.replicas export function getNewBaselineResource(
: 0 stableObject: any,
replicas?: number
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE) ): object {
} return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE);
}
export function getNewBaselineResource(
stableObject: any, export function getNewCanaryResource(
replicas?: number inputObject: any,
): object { replicas?: number
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE) ): object {
} return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE);
}
export function getNewCanaryResource(
inputObject: any, export async function fetchResource(
replicas?: number kubectl: Kubectl,
): object { kind: string,
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE) name: string
} ) {
const result = await kubectl.getResource(kind, name);
export async function fetchResource(
kubectl: Kubectl, if (!result || result?.stderr) {
kind: string, return null;
name: string }
) {
let result: ExecOutput if (result.stdout) {
try { const resource = JSON.parse(result.stdout);
result = await kubectl.getResource(kind, name)
} catch (e) { try {
core.debug(`detected error while fetching resources: ${e}`) utils.UnsetClusterSpecificDetails(resource);
} return resource;
} catch (ex) {
if (!result || result?.stderr) { core.debug(
return null `Exception occurred while Parsing ${resource} in JSON object: ${ex}`
} );
}
if (result.stdout) { }
const resource = JSON.parse(result.stdout) }
try { export function getCanaryResourceName(name: string) {
utils.UnsetClusterSpecificDetails(resource) return name + CANARY_SUFFIX;
return resource }
} catch (ex) {
core.debug( export function getBaselineResourceName(name: string) {
`Exception occurred while parsing ${resource} in JSON object: ${ex}` return name + BASELINE_SUFFIX;
) }
}
} export function getStableResourceName(name: string) {
} return name + STABLE_SUFFIX;
}
export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX function getNewCanaryObject(
} inputObject: any,
replicas: number,
export function getBaselineResourceName(name: string) { type: string
return name + BASELINE_SUFFIX ): object {
} const newObject = JSON.parse(JSON.stringify(inputObject));
export function getStableResourceName(name: string) { // Updating name
return name + STABLE_SUFFIX if (type === CANARY_LABEL_VALUE) {
} newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name);
} else if (type === STABLE_LABEL_VALUE) {
export function getBaselineDeploymentFromStableDeployment( newObject.metadata.name = getStableResourceName(inputObject.metadata.name);
inputObject: any, } else {
replicaCount: number newObject.metadata.name = getBaselineResourceName(
): object { inputObject.metadata.name
// TODO: REFACTOR TO MAKE EVERYTHING TYPE SAFE );
const oldName = inputObject.metadata.name }
const newName =
oldName.substring(0, oldName.length - STABLE_SUFFIX.length) + addCanaryLabelsAndAnnotations(newObject, type);
BASELINE_SUFFIX
if (specContainsReplicas(newObject.kind)) {
const newObject = getNewCanaryObject( newObject.spec.replicas = replicas;
inputObject, }
replicaCount,
BASELINE_LABEL_VALUE return newObject;
) as any }
newObject.metadata.name = newName
function specContainsReplicas(kind: string) {
return newObject return (
} kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
function getNewCanaryObject( !isServiceEntity(kind)
inputObject: any, );
replicas: number, }
type: string
): object { function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newLabels = new Map<string, string>();
newLabels[CANARY_VERSION_LABEL] = type;
// Updating name
if (type === CANARY_LABEL_VALUE) { updateObjectLabels(inputObject, newLabels, false);
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name) updateObjectAnnotations(inputObject, newLabels, false);
} else if (type === STABLE_LABEL_VALUE) { updateSelectorLabels(inputObject, newLabels, false);
newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
} else { if (!isServiceEntity(inputObject.kind)) {
newObject.metadata.name = getBaselineResourceName( updateSpecLabels(inputObject, newLabels, false);
inputObject.metadata.name }
) }
}
async function cleanUpCanary(
addCanaryLabelsAndAnnotations(newObject, type) kubectl: Kubectl,
files: string[],
if (specContainsReplicas(newObject.kind)) { includeServices: boolean
newObject.spec.replicas = replicas ) {
} const deleteObject = async function (kind, name) {
try {
return newObject const result = await kubectl.delete([kind, name]);
} checkForErrors([result]);
} catch (ex) {
function specContainsReplicas(kind: string) { // Ignore failures of delete if it doesn't exist
return ( }
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && };
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
!isServiceEntity(kind) for (const filePath of files) {
) const fileContents = fs.readFileSync(filePath).toString();
}
const parsedYaml = yaml.safeLoadAll(fileContents);
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) { for (const inputObject of parsedYaml) {
const newLabels = new Map<string, string>() const name = inputObject.metadata.name;
newLabels[CANARY_VERSION_LABEL] = type const kind = inputObject.kind;
updateObjectLabels(inputObject, newLabels, false) if (
updateObjectAnnotations(inputObject, newLabels, false) isDeploymentEntity(kind) ||
updateSelectorLabels(inputObject, newLabels, false) (includeServices && isServiceEntity(kind))
) {
if (!isServiceEntity(inputObject.kind)) { const canaryObjectName = getCanaryResourceName(name);
updateSpecLabels(inputObject, newLabels, false) const baselineObjectName = getBaselineResourceName(name);
}
} await deleteObject(kind, canaryObjectName);
await deleteObject(kind, baselineObjectName);
async function cleanUpCanary( }
kubectl: Kubectl, }
files: string[], }
includeServices: boolean }
): Promise<string[]> {
const deleteObject = async function (
kind: string,
name: string,
namespace: string | undefined
) {
try {
const result = await kubectl.delete([kind, name], namespace)
checkForErrors([result])
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
}
const deletedFiles: string[] = []
for (const filePath of files) {
try {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml: any[] = yaml.loadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
const namespace: string | undefined =
inputObject?.metadata?.namespace
if (
isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind))
) {
deletedFiles.push(filePath)
const canaryObjectName = getCanaryResourceName(name)
const baselineObjectName = getBaselineResourceName(name)
await deleteObject(kind, canaryObjectName, namespace)
await deleteObject(kind, baselineObjectName, namespace)
}
}
} catch (error) {
core.error(`Failed to process file ${filePath}: ${error.message}`)
throw error
}
}
return deletedFiles
}
+90 -109
View File
@@ -1,109 +1,90 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import {isDeploymentEntity} from '../../types/kubernetesTypes' import { isDeploymentEntity } from "../../types/kubernetesTypes";
import {getReplicaCount} from '../../utilities/manifestUpdateUtils' import { getReplicaCount } from "../../utilities/manifestUpdateUtils";
import {DeployResult} from '../../types/deployResult'
import {K8sObject} from '../../types/k8sObject' export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
const newObjectsList = [];
export async function deployPodCanary( const percentage = parseInt(core.getInput("percentage"));
filePaths: string[],
kubectl: Kubectl, if (percentage < 0 || percentage > 100)
onlyDeployStable: boolean = false throw Error("Percentage must be between 0 and 100");
): Promise<DeployResult> {
const newObjectsList = [] for (const filePath of filePaths) {
const percentage = parseInt(core.getInput('percentage', {required: true})) const fileContents = fs.readFileSync(filePath).toString();
const parsedYaml = yaml.safeLoadAll(fileContents);
if (percentage < 0 || percentage > 100) for (const inputObject of parsedYaml) {
throw Error('Percentage must be between 0 and 100') const name = inputObject.metadata.name;
const kind = inputObject.kind;
for (const filePath of filePaths) {
try { if (isDeploymentEntity(kind)) {
const fileContents = fs.readFileSync(filePath, 'utf8') core.debug("Calculating replica count for canary");
const parsedYaml = yaml.loadAll(fileContents) const canaryReplicaCount = calculateReplicaCountForCanary(
for (const inputObject of parsedYaml) { inputObject,
if ( percentage
inputObject && );
typeof inputObject === 'object' && core.debug("Replica count is " + canaryReplicaCount);
'metadata' in inputObject &&
'kind' in inputObject && // Get stable object
'spec' in inputObject && core.debug("Querying stable object");
typeof inputObject.metadata === 'object' && const stableObject = await canaryDeploymentHelper.fetchResource(
'name' in inputObject.metadata && kubectl,
typeof inputObject.metadata.name === 'string' && kind,
typeof inputObject.kind === 'string' name
) { );
const obj = inputObject as K8sObject
const name = obj.metadata.name if (!stableObject) {
const kind = obj.kind core.debug("Stable object not found. Creating canary object");
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
if (!onlyDeployStable && isDeploymentEntity(kind)) { inputObject,
core.debug('Calculating replica count for canary') canaryReplicaCount
const canaryReplicaCount = calculateReplicaCountForCanary( );
obj, newObjectsList.push(newCanaryObject);
percentage } else {
) core.debug(
core.debug('Replica count is ' + canaryReplicaCount) "Creating canary and baseline objects. Stable object found: " +
JSON.stringify(stableObject)
const newCanaryObject = );
canaryDeploymentHelper.getNewCanaryResource(
obj, const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
canaryReplicaCount inputObject,
) canaryReplicaCount
newObjectsList.push(newCanaryObject) );
core.debug("New canary object: " + JSON.stringify(newCanaryObject));
// if there's already a stable object, deploy baseline as well
const stableObject = const newBaselineObject =
await canaryDeploymentHelper.fetchResource( canaryDeploymentHelper.getNewBaselineResource(
kubectl, stableObject,
kind, canaryReplicaCount
name );
) core.debug(
if (stableObject) { "New baseline object: " + JSON.stringify(newBaselineObject)
core.debug( );
`Stable object found for ${kind} ${name}. Creating baseline objects`
) newObjectsList.push(newCanaryObject);
const newBaselineObject = newObjectsList.push(newBaselineObject);
canaryDeploymentHelper.getNewBaselineResource( }
stableObject, } else {
canaryReplicaCount // update non deployment entity as it is
) newObjectsList.push(inputObject);
core.debug( }
'New baseline object: ' + }
JSON.stringify(newBaselineObject) }
)
newObjectsList.push(newBaselineObject) core.debug("New objects list: " + JSON.stringify(newObjectsList));
} const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
} else { const forceDeployment = core.getInput("force").toLowerCase() === "true";
// deploy non deployment entity or regular deployments for promote as they are
newObjectsList.push(obj) const result = await kubectl.apply(manifestFiles, forceDeployment);
} return { result, newFilePaths: manifestFiles };
} }
}
} catch (error) { function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
core.error( const inputReplicaCount = getReplicaCount(inputObject);
`Failed to parse YAML file at ${filePath}: ${error.message}` return Math.round((inputReplicaCount * percentage) / 100);
) }
throw error
}
}
core.debug('New objects list: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const execResult = await kubectl.apply(manifestFiles, forceDeployment)
return {execResult, manifestFiles}
}
export function calculateReplicaCountForCanary(
inputObject: any,
percentage: number
) {
const inputReplicaCount = getReplicaCount(inputObject)
return Math.max(1, Math.round((inputReplicaCount * percentage) / 100))
}
+319 -383
View File
@@ -1,383 +1,319 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import * as podCanaryHelper from './podCanaryHelper' import {
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes' isDeploymentEntity,
import {checkForErrors} from '../../utilities/kubectlUtils' isServiceEntity,
import {inputAnnotations} from '../../inputUtils' } from "../../types/kubernetesTypes";
import {DeployResult} from '../../types/deployResult' import { checkForErrors } from "../../utilities/kubectlUtils";
import {K8sObject} from '../../types/k8sObject'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout' const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
export async function deploySMICanary( const canaryReplicaCount = parseInt(
filePaths: string[], core.getInput("baseline-and-canary-replicas")
kubectl: Kubectl, );
onlyDeployStable: boolean = false if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
): Promise<DeployResult> { throw Error("Baseline-and-canary-replicas must be between 0 and 100");
const canaryReplicasInput = core.getInput('baseline-and-canary-replicas')
let canaryReplicaCount const newObjectsList = [];
let calculateReplicas = true filePaths.forEach((filePath: string) => {
if (canaryReplicasInput !== '') { const fileContents = fs.readFileSync(filePath).toString();
canaryReplicaCount = parseInt(canaryReplicasInput) yaml.safeLoadAll(fileContents, (inputObject) => {
calculateReplicas = false const name = inputObject.metadata.name;
core.debug( const kind = inputObject.kind;
`read replica count ${canaryReplicaCount} from input: ${canaryReplicasInput}`
) if (isDeploymentEntity(kind)) {
} const stableObject = canaryDeploymentHelper.fetchResource(
kubectl,
if (canaryReplicaCount < 0 && canaryReplicaCount > 100) kind,
throw Error('Baseline-and-canary-replicas must be between 0 and 100') name
);
const newObjectsList = []
for await (const filePath of filePaths) { if (!stableObject) {
try { core.debug("Stable object not found. Creating only canary object");
const fileContents = fs.readFileSync(filePath).toString() const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
const inputObjects: K8sObject[] = yaml.loadAll( inputObject,
fileContents canaryReplicaCount
) as K8sObject[] );
for (const inputObject of inputObjects) { newObjectsList.push(newCanaryObject);
const name = inputObject.metadata.name } else {
const kind = inputObject.kind if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) {
throw Error(`StableSpecSelectorNotExist : ${name}`);
if (!onlyDeployStable && isDeploymentEntity(kind)) { }
if (calculateReplicas) {
// calculate for each object core.debug(
const percentage = parseInt( "Stable object found. Creating canary and baseline objects"
core.getInput('percentage', {required: true}) );
) const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
canaryReplicaCount = inputObject,
podCanaryHelper.calculateReplicaCountForCanary( canaryReplicaCount
inputObject, );
percentage const newBaselineObject =
) canaryDeploymentHelper.getNewBaselineResource(
core.debug(`calculated replica count ${canaryReplicaCount}`) stableObject,
} canaryReplicaCount
);
core.debug('Creating canary object') newObjectsList.push(newCanaryObject);
const newCanaryObject = newObjectsList.push(newBaselineObject);
canaryDeploymentHelper.getNewCanaryResource( }
inputObject, } else {
canaryReplicaCount // Update non deployment entity as it is
) newObjectsList.push(inputObject);
newObjectsList.push(newCanaryObject) }
});
const stableObject = await canaryDeploymentHelper.fetchResource( });
kubectl,
kind, const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList);
canaryDeploymentHelper.getStableResourceName(name) const forceDeployment = core.getInput("force").toLowerCase() === "true";
) const result = await kubectl.apply(newFilePaths, forceDeployment);
if (stableObject) { await createCanaryService(kubectl, filePaths);
core.debug( return { result, newFilePaths };
`Stable object found for ${kind} ${name}. Creating baseline objects` }
)
const newBaselineObject = async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment( const newObjectsList = [];
stableObject, const trafficObjectsList = [];
canaryReplicaCount
) for (const filePath of filePaths) {
newObjectsList.push(newBaselineObject) const fileContents = fs.readFileSync(filePath).toString();
} const parsedYaml = yaml.safeLoadAll(fileContents);
} else if (isDeploymentEntity(kind)) { for (const inputObject of parsedYaml) {
core.debug( const name = inputObject.metadata.name;
`creating stable deployment with ${inputObject.spec.replicas} replicas` const kind = inputObject.kind;
)
const stableDeployment = if (isServiceEntity(kind)) {
canaryDeploymentHelper.getStableResource(inputObject) const newCanaryServiceObject =
newObjectsList.push(stableDeployment) canaryDeploymentHelper.getNewCanaryResource(inputObject);
} else { newObjectsList.push(newCanaryServiceObject);
// Update non deployment entity or stable deployment as it is
newObjectsList.push(inputObject) const newBaselineServiceObject =
} canaryDeploymentHelper.getNewBaselineResource(inputObject);
} newObjectsList.push(newBaselineServiceObject);
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`) const stableObject = await canaryDeploymentHelper.fetchResource(
throw error kubectl,
} kind,
} canaryDeploymentHelper.getStableResourceName(name)
core.debug( );
`deploying canary objects with SMI: \n ${JSON.stringify(newObjectsList)}` if (!stableObject) {
) const newStableServiceObject =
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList) canaryDeploymentHelper.getStableResource(inputObject);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' newObjectsList.push(newStableServiceObject);
const result = await kubectl.apply(newFilePaths, forceDeployment)
const svcDeploymentFiles = await createCanaryService(kubectl, filePaths) core.debug("Creating the traffic object for service: " + name);
newFilePaths.push(...svcDeploymentFiles) const trafficObject = await createTrafficSplitManifestFile(
return {execResult: result, manifestFiles: newFilePaths} kubectl,
} name,
0,
async function createCanaryService( 0,
kubectl: Kubectl, 1000
filePaths: string[] );
): Promise<string[]> {
const newObjectsList = [] trafficObjectsList.push(trafficObject);
const trafficObjectsList: string[] = [] } else {
let updateTrafficObject = true;
for (const filePath of filePaths) { const trafficObject = await canaryDeploymentHelper.fetchResource(
try { kubectl,
const fileContents = fs.readFileSync(filePath).toString() TRAFFIC_SPLIT_OBJECT,
const parsedYaml: K8sObject[] = yaml.loadAll( getTrafficSplitResourceName(name)
fileContents );
) as K8sObject[]
if (trafficObject) {
for (const inputObject of parsedYaml) { const trafficJObject = JSON.parse(JSON.stringify(trafficObject));
const name = inputObject.metadata.name if (trafficJObject?.spec?.backends) {
const kind = inputObject.kind trafficJObject.spec.backends.forEach((s) => {
if (
if (isServiceEntity(kind)) { s.service ===
core.debug(`Creating services for ${kind} ${name}`) canaryDeploymentHelper.getCanaryResourceName(name) &&
const newCanaryServiceObject = s.weight === "1000m"
canaryDeploymentHelper.getNewCanaryResource(inputObject) ) {
newObjectsList.push(newCanaryServiceObject) core.debug("Update traffic objcet not required");
updateTrafficObject = false;
const newBaselineServiceObject = }
canaryDeploymentHelper.getNewBaselineResource(inputObject) });
newObjectsList.push(newBaselineServiceObject) }
}
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl, if (updateTrafficObject) {
kind, core.debug(
canaryDeploymentHelper.getStableResourceName(name) "Stable service object present so updating the traffic object for service: " +
) name
if (!stableObject) { );
const newStableServiceObject = trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
canaryDeploymentHelper.getStableResource(inputObject) }
newObjectsList.push(newStableServiceObject) }
}
core.debug('Creating the traffic object for service: ' + name) }
const trafficObject = await createTrafficSplitManifestFile( }
kubectl,
name, const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
0, manifestFiles.push(...trafficObjectsList);
0, const forceDeployment = core.getInput("force").toLowerCase() === "true";
1000
) const result = await kubectl.apply(manifestFiles, forceDeployment);
checkForErrors([result]);
trafficObjectsList.push(trafficObject) }
} else {
let updateTrafficObject = true export async function redirectTrafficToCanaryDeployment(
const trafficObject = kubectl: Kubectl,
await canaryDeploymentHelper.fetchResource( manifestFilePaths: string[]
kubectl, ) {
TRAFFIC_SPLIT_OBJECT, await adjustTraffic(kubectl, manifestFilePaths, 0, 1000);
getTrafficSplitResourceName(name) }
)
export async function redirectTrafficToStableDeployment(
if (trafficObject) { kubectl: Kubectl,
const trafficJObject = JSON.parse( manifestFilePaths: string[]
JSON.stringify(trafficObject) ) {
) await adjustTraffic(kubectl, manifestFilePaths, 1000, 0);
if (trafficJObject?.spec?.backends) { }
trafficJObject.spec.backends.forEach((s) => {
if ( async function adjustTraffic(
s.service === kubectl: Kubectl,
canaryDeploymentHelper.getCanaryResourceName( manifestFilePaths: string[],
name stableWeight: number,
) && canaryWeight: number
s.weight === '1000m' ) {
) { if (!manifestFilePaths || manifestFilePaths?.length == 0) {
core.debug('Update traffic objcet not required') return;
updateTrafficObject = false }
}
}) const trafficSplitManifests = [];
} for (const filePath of manifestFilePaths) {
} const fileContents = fs.readFileSync(filePath).toString();
const parsedYaml = yaml.safeLoadAll(fileContents);
if (updateTrafficObject) { for (const inputObject of parsedYaml) {
core.debug( const name = inputObject.metadata.name;
'Stable service object present so updating the traffic object for service: ' + const kind = inputObject.kind;
name
) if (isServiceEntity(kind)) {
trafficObjectsList.push( trafficSplitManifests.push(
await updateTrafficSplitObject(kubectl, name) await createTrafficSplitManifestFile(
) kubectl,
} name,
} stableWeight,
} 0,
} canaryWeight
} catch (error) { )
core.error(`Failed to process file at ${filePath}: ${error.message}`) );
throw error }
} }
} }
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList) if (trafficSplitManifests.length <= 0) {
manifestFiles.push(...trafficObjectsList) return;
const forceDeployment = core.getInput('force').toLowerCase() === 'true' }
const result = await kubectl.apply(manifestFiles, forceDeployment) const forceDeployment = core.getInput("force").toLowerCase() === "true";
checkForErrors([result]) const result = await kubectl.apply(trafficSplitManifests, forceDeployment);
return manifestFiles checkForErrors([result]);
} }
export async function redirectTrafficToCanaryDeployment( async function updateTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[] serviceName: string
) { ): Promise<string> {
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000) const percentage = parseInt(core.getInput("percentage"));
} if (percentage < 0 || percentage > 100)
throw Error("Percentage must be between 0 and 100");
export async function redirectTrafficToStableDeployment(
kubectl: Kubectl, const percentageWithMuliplier = percentage * 10;
manifestFilePaths: string[] const baselineAndCanaryWeight = percentageWithMuliplier / 2;
): Promise<string[]> { const stableDeploymentWeight = 1000 - percentageWithMuliplier;
return await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
} core.debug(
"Creating the traffic object with canary weight: " +
async function adjustTraffic( baselineAndCanaryWeight +
kubectl: Kubectl, ",baseling weight: " +
manifestFilePaths: string[], baselineAndCanaryWeight +
stableWeight: number, ",stable: " +
canaryWeight: number stableDeploymentWeight
) { );
if (!manifestFilePaths || manifestFilePaths?.length == 0) { return await createTrafficSplitManifestFile(
return kubectl,
} serviceName,
stableDeploymentWeight,
const trafficSplitManifests = [] baselineAndCanaryWeight,
for (const filePath of manifestFilePaths) { baselineAndCanaryWeight
try { );
const fileContents = fs.readFileSync(filePath).toString() }
const parsedYaml: K8sObject[] = yaml.loadAll(
fileContents async function createTrafficSplitManifestFile(
) as K8sObject[] kubectl: Kubectl,
serviceName: string,
for (const inputObject of parsedYaml) { stableWeight: number,
const name = inputObject.metadata.name baselineWeight: number,
const kind = inputObject.kind canaryWeight: number
): Promise<string> {
if (isServiceEntity(kind)) { const smiObjectString = await getTrafficSplitObject(
trafficSplitManifests.push( kubectl,
await createTrafficSplitManifestFile( serviceName,
kubectl, stableWeight,
name, baselineWeight,
stableWeight, canaryWeight
0, );
canaryWeight const manifestFile = fileHelper.writeManifestToFile(
) smiObjectString,
) TRAFFIC_SPLIT_OBJECT,
} serviceName
} );
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`) if (!manifestFile) {
throw error throw new Error("Unable to create traffic split manifest file");
} }
}
return manifestFile;
if (trafficSplitManifests.length <= 0) { }
return
} let trafficSplitAPIVersion = "";
const forceDeployment = core.getInput('force').toLowerCase() === 'true' async function getTrafficSplitObject(
const result = await kubectl.apply(trafficSplitManifests, forceDeployment) kubectl: Kubectl,
checkForErrors([result]) name: string,
return trafficSplitManifests stableWeight: number,
} baselineWeight: number,
canaryWeight: number
async function updateTrafficSplitObject( ): Promise<string> {
kubectl: Kubectl, // cached version
serviceName: string if (!trafficSplitAPIVersion) {
): Promise<string> { trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
const percentage = parseInt(core.getInput('percentage', {required: true})) kubectl
if (percentage < 0 || percentage > 100) );
throw Error('Percentage must be between 0 and 100') }
const percentageWithMuliplier = percentage * 10 return JSON.stringify({
const baselineAndCanaryWeight = percentageWithMuliplier / 2 apiVersion: trafficSplitAPIVersion,
const stableDeploymentWeight = 1000 - percentageWithMuliplier kind: "TrafficSplit",
metadata: {
core.debug( name: getTrafficSplitResourceName(name),
'Creating the traffic object with canary weight: ' + },
baselineAndCanaryWeight + spec: {
', baseline weight: ' + backends: [
baselineAndCanaryWeight + {
', stable weight: ' + service: canaryDeploymentHelper.getStableResourceName(name),
stableDeploymentWeight weight: stableWeight,
) },
return await createTrafficSplitManifestFile( {
kubectl, service: canaryDeploymentHelper.getBaselineResourceName(name),
serviceName, weight: baselineWeight,
stableDeploymentWeight, },
baselineAndCanaryWeight, {
baselineAndCanaryWeight service: canaryDeploymentHelper.getCanaryResourceName(name),
) weight: canaryWeight,
} },
],
async function createTrafficSplitManifestFile( service: name,
kubectl: Kubectl, },
serviceName: string, });
stableWeight: number, }
baselineWeight: number,
canaryWeight: number function getTrafficSplitResourceName(name: string) {
): Promise<string> { return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX;
const smiObjectString = await getTrafficSplitObject( }
kubectl,
serviceName,
stableWeight,
baselineWeight,
canaryWeight
)
const manifestFile = fileHelper.writeManifestToFile(
smiObjectString,
TRAFFIC_SPLIT_OBJECT,
serviceName
)
if (!manifestFile) {
throw new Error('Unable to create traffic split manifest file')
}
return manifestFile
}
let trafficSplitAPIVersion = ''
async function getTrafficSplitObject(
kubectl: Kubectl,
name: string,
stableWeight: number,
baselineWeight: number,
canaryWeight: number
): Promise<string> {
// cached version
if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion =
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
}
return JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: 'TrafficSplit',
metadata: {
name: getTrafficSplitResourceName(name),
annotations: inputAnnotations
},
spec: {
backends: [
{
service: canaryDeploymentHelper.getStableResourceName(name),
weight: stableWeight
},
{
service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight
},
{
service: canaryDeploymentHelper.getCanaryResourceName(name),
weight: canaryWeight
}
],
service: name
}
})
}
function getTrafficSplitResourceName(name: string) {
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
}
+218 -298
View File
@@ -1,298 +1,218 @@
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as canaryDeploymentHelper from './canary/canaryHelper' import * as canaryDeploymentHelper from "./canary/canaryHelper";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import {isDeploymentEntity} from '../types/kubernetesTypes' import { isDeploymentEntity } from "../types/kubernetesTypes";
import * as fileHelper from '../utilities/fileUtils' import * as fileHelper from "../utilities/fileUtils";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {deployPodCanary} from './canary/podCanaryHelper' import { deployPodCanary } from "./canary/podCanaryHelper";
import {deploySMICanary} from './canary/smiCanaryHelper' import { deploySMICanary } from "./canary/smiCanaryHelper";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import {deployBlueGreen} from './blueGreen/deploy' import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper";
import {DeploymentStrategy} from '../types/deploymentStrategy' import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper";
import * as core from '@actions/core' import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper";
import { import { DeploymentStrategy } from "../types/deploymentStrategy";
parseTrafficSplitMethod, import * as core from "@actions/core";
TrafficSplitMethod import {
} from '../types/trafficSplitMethod' parseTrafficSplitMethod,
import {parseRouteStrategy} from '../types/routeStrategy' TrafficSplitMethod,
import {ExecOutput} from '@actions/exec' } from "../types/trafficSplitMethod";
import { import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
getWorkflowAnnotationKeyLabel, import { ExecOutput } from "@actions/exec";
getWorkflowAnnotations, import {
cleanLabel getWorkflowAnnotationKeyLabel,
} from '../utilities/workflowAnnotationUtils' getWorkflowAnnotations,
import { } from "../utilities/workflowAnnotationUtils";
annotateChildPods, import {
checkForErrors, annotateChildPods,
getLastSuccessfulRunSha checkForErrors,
} from '../utilities/kubectlUtils' getLastSuccessfulRunSha,
import { } from "../utilities/kubectlUtils";
getWorkflowFilePath, import {
normalizeWorkflowStrLabel getWorkflowFilePath,
} from '../utilities/githubUtils' normalizeWorkflowStrLabel,
import {getDeploymentConfig} from '../utilities/dockerUtils' } from "../utilities/githubUtils";
import {DeployResult} from '../types/deployResult' import { getDeploymentConfig } from "../utilities/dockerUtils";
import {ClusterType} from '../inputUtils'
export async function deployManifests(
export async function deployManifests( files: string[],
files: string[], deploymentStrategy: DeploymentStrategy,
deploymentStrategy: DeploymentStrategy, kubectl: Kubectl,
kubectl: Kubectl, trafficSplitMethod: TrafficSplitMethod
trafficSplitMethod: TrafficSplitMethod ): Promise<string[]> {
): Promise<string[]> { switch (deploymentStrategy) {
switch (deploymentStrategy) { case DeploymentStrategy.CANARY: {
case DeploymentStrategy.CANARY: { const { result, newFilePaths } =
const canaryDeployResult: DeployResult = trafficSplitMethod == TrafficSplitMethod.SMI
trafficSplitMethod == TrafficSplitMethod.SMI ? await deploySMICanary(files, kubectl)
? await deploySMICanary(files, kubectl) : await deployPodCanary(files, kubectl);
: await deployPodCanary(files, kubectl)
checkForErrors([result]);
checkForErrors([canaryDeployResult.execResult]) return newFilePaths;
return canaryDeployResult.manifestFiles }
}
case DeploymentStrategy.BLUE_GREEN: {
case DeploymentStrategy.BLUE_GREEN: { const routeStrategy = parseRouteStrategy(
const routeStrategy = parseRouteStrategy( core.getInput("route-method", { required: true })
core.getInput('route-method', {required: true}) );
)
const blueGreenDeployment = await deployBlueGreen( const { result, newFilePaths } = await Promise.resolve(
kubectl, (routeStrategy == RouteStrategy.INGRESS &&
files, deployBlueGreenIngress(kubectl, files)) ||
routeStrategy (routeStrategy == RouteStrategy.SMI &&
) deployBlueGreenSMI(kubectl, files)) ||
core.debug( deployBlueGreenService(kubectl, files)
`objects deployed for ${routeStrategy}: ${JSON.stringify( );
blueGreenDeployment.objects
)} ` checkForErrors([result]);
) return newFilePaths;
}
checkForErrors([blueGreenDeployment.deployResult.execResult])
const deployedManifestFiles = case undefined: {
blueGreenDeployment.deployResult.manifestFiles core.warning("Deployment strategy is not recognized.");
core.debug( }
`from blue-green service, deployed manifest files are ${deployedManifestFiles}` default: {
) const trafficSplitMethod = parseTrafficSplitMethod(
return deployedManifestFiles core.getInput("traffic-split-method", { required: true })
} );
case DeploymentStrategy.BASIC: { const forceDeployment = core.getInput("force").toLowerCase() === "true";
const trafficSplitMethod = parseTrafficSplitMethod( if (trafficSplitMethod === TrafficSplitMethod.SMI) {
core.getInput('traffic-split-method', {required: true}) const updatedManifests = appendStableVersionLabelToResource(files);
)
const result = await kubectl.apply(updatedManifests, forceDeployment);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' checkForErrors([result]);
if (trafficSplitMethod === TrafficSplitMethod.SMI) { } else {
const updatedManifests = appendStableVersionLabelToResource(files) const result = await kubectl.apply(files, forceDeployment);
checkForErrors([result]);
const result = await kubectl.apply( }
updatedManifests,
forceDeployment return files;
) }
checkForErrors([result]) }
} else { }
const result = await kubectl.apply(files, forceDeployment)
checkForErrors([result]) function appendStableVersionLabelToResource(files: string[]): string[] {
} const manifestFiles = [];
const newObjectsList = [];
return files
} files.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString();
default: {
throw new Error('Deployment strategy is not recognized.') yaml.safeLoadAll(fileContents, function (inputObject) {
} const { kind } = inputObject;
}
} if (isDeploymentEntity(kind)) {
const updatedObject =
function appendStableVersionLabelToResource(files: string[]): string[] { canaryDeploymentHelper.markResourceAsStable(inputObject);
const manifestFiles = [] newObjectsList.push(updatedObject);
const newObjectsList = [] } else {
manifestFiles.push(filePath);
files.forEach((filePath: string) => { }
try { });
const fileContents = fs.readFileSync(filePath).toString() });
yaml.loadAll(fileContents, function (inputObject) { const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const kind = (inputObject as {kind: string}).kind manifestFiles.push(...updatedManifestFiles);
if (isDeploymentEntity(kind)) { return manifestFiles;
const updatedObject = }
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject) export async function checkManifestStability(
} else { kubectl: Kubectl,
manifestFiles.push(filePath) resources: Resource[]
} ): Promise<void> {
}) await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
} catch (error) { }
core.error(`Failed to parse file at ${filePath}: ${error.message}`)
throw error export async function annotateAndLabelResources(
} files: string[],
}) kubectl: Kubectl,
resourceTypes: Resource[],
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList) allPods: any
manifestFiles.push(...updatedManifestFiles) ) {
const githubToken = core.getInput("token");
return manifestFiles const workflowFilePath = await getWorkflowFilePath(githubToken);
}
const deploymentConfig = await getDeploymentConfig();
export async function checkManifestStability( const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath);
kubectl: Kubectl,
resources: Resource[], await annotateResources(
resourceType: ClusterType files,
): Promise<void> { kubectl,
await KubernetesManifestUtility.checkManifestStability( resourceTypes,
kubectl, allPods,
resources, annotationKeyLabel,
resourceType workflowFilePath,
) deploymentConfig
} );
await labelResources(files, kubectl, annotationKeyLabel);
export async function annotateAndLabelResources( }
files: string[],
kubectl: Kubectl, async function annotateResources(
resourceTypes: Resource[] files: string[],
) { kubectl: Kubectl,
const defaultWorkflowFileName = 'k8s-deploy-failed-workflow-annotation' resourceTypes: Resource[],
const githubToken = core.getInput('token') allPods: any,
let workflowFilePath annotationKey: string,
try { workflowFilePath: string,
workflowFilePath = await getWorkflowFilePath(githubToken) deploymentConfig: DeploymentConfig
} catch (ex) { ) {
core.warning(`Failed to extract workflow file name: ${ex}`) const annotateResults: ExecOutput[] = [];
workflowFilePath = defaultWorkflowFileName const namespace = core.getInput("namespace") || "default";
} const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl,
const deploymentConfig = await getDeploymentConfig() namespace,
const annotationKeyLabel = getWorkflowAnnotationKeyLabel() annotationKey
);
const shouldAnnotateResources = !(
core.getInput('annotate-resources').toLowerCase() === 'false' const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
) lastSuccessSha,
workflowFilePath,
if (shouldAnnotateResources) { deploymentConfig
await annotateResources( )}`;
files,
kubectl, const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false");
resourceTypes, if (annotateNamespace) {
annotationKeyLabel, annotateResults.push(
workflowFilePath, await kubectl.annotate("namespace", namespace, annotationKeyValStr)
deploymentConfig );
).catch((err) => core.warning(`Failed to annotate resources: ${err} `)) }
} annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr));
await labelResources(files, kubectl, annotationKeyLabel).catch((err) => for (const resource of resourceTypes) {
core.warning(`Failed to label resources: ${err}`) if (
) resource.type.toLowerCase() !==
} models.KubernetesWorkload.POD.toLowerCase()
) {
async function annotateResources( (
files: string[], await annotateChildPods(
kubectl: Kubectl, kubectl,
resourceTypes: Resource[], resource.type,
annotationKey: string, resource.name,
workflowFilePath: string, annotationKeyValStr,
deploymentConfig: DeploymentConfig allPods
) { )
const annotateResults: ExecOutput[] = [] ).forEach((execResult) => annotateResults.push(execResult));
const namespace = core.getInput('namespace') || 'default' }
const lastSuccessSha = await getLastSuccessfulRunSha( }
kubectl,
namespace, checkForErrors(annotateResults, true);
annotationKey }
)
async function labelResources(
if (core.isDebug()) { files: string[],
try { kubectl: Kubectl,
core.debug(`files getting annotated are ${JSON.stringify(files)}`) label: string
for (const filePath of files) { ) {
core.debug('printing objects getting annotated...') const labels = [
const fileContents = fs.readFileSync(filePath).toString() `workflowFriendlyName=${normalizeWorkflowStrLabel(
const inputObjects = yaml.loadAll(fileContents) process.env.GITHUB_WORKFLOW
for (const inputObject of inputObjects) { )}`,
core.debug(`object: ${JSON.stringify(inputObject)}`) `workflow=${label}`,
} ];
}
} catch (error) { checkForErrors([await kubectl.labelFiles(files, labels)], true);
core.error(`Failed to load and parse files: ${error.message}`) }
throw error
}
}
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
lastSuccessSha,
workflowFilePath,
deploymentConfig
)}`
const annotateNamespace = !(
core.getInput('annotate-namespace').toLowerCase() === 'false'
)
if (annotateNamespace) {
annotateResults.push(
await kubectl.annotate(
'namespace',
namespace,
annotationKeyValStr,
namespace
)
)
}
for (const file of files) {
try {
const annotateResult = await kubectl.annotateFiles(
file,
annotationKeyValStr,
namespace
)
annotateResults.push(annotateResult)
} catch (e) {
core.warning(`failed to annotate resource: ${e}`)
}
}
for (const resource of resourceTypes) {
if (
resource.type.toLowerCase() !==
models.KubernetesWorkload.POD.toLowerCase()
) {
;(
await annotateChildPods(
kubectl,
resource.type,
resource.name,
resource.namespace,
annotationKeyValStr
)
).forEach((execResult) => annotateResults.push(execResult))
}
}
checkForErrors(annotateResults, true)
}
async function labelResources(
files: string[],
kubectl: Kubectl,
label: string
) {
const labels = [
`workflowFriendlyName=${cleanLabel(
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
)}`,
`workflow=${cleanLabel(label)}`
]
const labelResults = []
for (const file of files) {
try {
const labelResult = await kubectl.labelFiles(file, labels)
labelResults.push(labelResult)
} catch (e) {
core.warning(`failed to annotate resource: ${e}`)
}
}
checkForErrors(labelResults, true)
}
+19 -19
View File
@@ -1,22 +1,22 @@
import {Action, parseAction} from './action' import { Action, parseAction } from "./action";
describe('Action type', () => { describe("Action type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(Action) const vals = <any>Object.values(Action);
expect(vals.includes('deploy')).toBe(true) expect(vals.includes("deploy")).toBe(true);
expect(vals.includes('promote')).toBe(true) expect(vals.includes("promote")).toBe(true);
expect(vals.includes('reject')).toBe(true) expect(vals.includes("reject")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseAction('deploy')).toBe(Action.DEPLOY) expect(parseAction("deploy")).toBe(Action.DEPLOY);
expect(parseAction('Deploy')).toBe(Action.DEPLOY) expect(parseAction("Deploy")).toBe(Action.DEPLOY);
expect(parseAction('DEPLOY')).toBe(Action.DEPLOY) expect(parseAction("DEPLOY")).toBe(Action.DEPLOY);
expect(parseAction('deploY')).toBe(Action.DEPLOY) expect(parseAction("deploY")).toBe(Action.DEPLOY);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction('invalid')).toBe(undefined) expect(parseAction("invalid")).toBe(undefined);
expect(parseAction('unsupportedType')).toBe(undefined) expect(parseAction("unsupportedType")).toBe(undefined);
}) });
}) });
+8 -8
View File
@@ -1,7 +1,7 @@
export enum Action { export enum Action {
DEPLOY = 'deploy', DEPLOY = "deploy",
PROMOTE = 'promote', PROMOTE = "promote",
REJECT = 'reject' REJECT = "reject",
} }
/** /**
@@ -10,8 +10,8 @@ export enum Action {
* @returns The Action enum or undefined if it can't be parsed * @returns The Action enum or undefined if it can't be parsed
*/ */
export const parseAction = (str: string): Action | undefined => export const parseAction = (str: string): Action | undefined =>
Action[ Action[
Object.keys(Action).filter( Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase() (k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof Action )[0] as keyof typeof Action
] ];
-8
View File
@@ -1,8 +0,0 @@
export function parseAnnotations(str: string) {
if (str == '') {
return new Map<string, string>()
} else {
const annotation = JSON.parse(str)
return new Map<string, string>(annotation)
}
}
-21
View File
@@ -1,21 +0,0 @@
import {DeployResult} from './deployResult'
import {K8sObject, K8sDeleteObject} from './k8sObject'
export interface BlueGreenDeployment {
deployResult: DeployResult
objects: K8sObject[]
}
export interface BlueGreenManifests {
serviceEntityList: K8sObject[]
serviceNameMap: Map<string, string>
unroutedServiceEntityList: K8sObject[]
deploymentEntityList: K8sObject[]
ingressEntityList: K8sObject[]
otherObjects: K8sObject[]
}
export interface BlueGreenRejectResult {
deleteResult: K8sDeleteObject[]
routeResult: BlueGreenDeployment
}
-6
View File
@@ -1,6 +0,0 @@
import {ExecOutput} from '@actions/exec'
export interface DeployResult {
execResult: ExecOutput
manifestFiles: string[]
}
+3 -3
View File
@@ -1,5 +1,5 @@
export interface DeploymentConfig { export interface DeploymentConfig {
manifestFilePaths: string[] manifestFilePaths: string[];
helmChartFilePaths: string[] helmChartFilePaths: string[];
dockerfilePaths: any dockerfilePaths: any;
} }
+25 -23
View File
@@ -1,25 +1,27 @@
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy' import {
DeploymentStrategy,
parseDeploymentStrategy,
} from "./deploymentStrategy";
describe('Deployment strategy type', () => { describe("Deployment strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(DeploymentStrategy) const vals = <any>Object.values(DeploymentStrategy);
expect(vals.includes('canary')).toBe(true) expect(vals.includes("canary")).toBe(true);
expect(vals.includes('blue-green')).toBe(true) expect(vals.includes("blue-green")).toBe(true);
expect(vals.includes('basic')).toBe(true) });
})
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseDeploymentStrategy('blue-green')).toBe( expect(parseDeploymentStrategy("blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('Blue-green')).toBe( expect(parseDeploymentStrategy("Blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe( expect(parseDeploymentStrategy("BLUE-GREEN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('blue-greeN')).toBe( expect(parseDeploymentStrategy("blue-greeN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
}) });
}) });
+9 -10
View File
@@ -1,7 +1,6 @@
export enum DeploymentStrategy { export enum DeploymentStrategy {
BASIC = 'basic', CANARY = "canary",
CANARY = 'canary', BLUE_GREEN = "blue-green",
BLUE_GREEN = 'blue-green'
} }
/** /**
@@ -10,11 +9,11 @@ export enum DeploymentStrategy {
* @returns The DeploymentStrategy enum or undefined if it can't be parsed * @returns The DeploymentStrategy enum or undefined if it can't be parsed
*/ */
export const parseDeploymentStrategy = ( export const parseDeploymentStrategy = (
str: string str: string
): DeploymentStrategy | undefined => ): DeploymentStrategy | undefined =>
DeploymentStrategy[ DeploymentStrategy[
Object.keys(DeploymentStrategy).filter( Object.keys(DeploymentStrategy).filter(
(k) => (k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase() DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy )[0] as keyof typeof DeploymentStrategy
] ];
+82 -82
View File
@@ -1,98 +1,98 @@
import {DockerExec} from './docker' import { DockerExec } from "./docker";
import * as actions from '@actions/exec' import * as actions from "@actions/exec";
const dockerPath = 'dockerPath' const dockerPath = "dockerPath";
const image = 'image' const image = "image";
const args = ['arg1', 'arg2', 'arg3'] const args = ["arg1", "arg2", "arg3"];
describe('Docker class', () => { describe("Docker class", () => {
const docker = new DockerExec(dockerPath) const docker = new DockerExec(dockerPath);
describe('with a success exec return', () => { describe("with a success exec return", () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''} const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await docker.pull(image, args) await docker.pull(image, args);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{silent: false} { silent: false }
) );
}) });
test('pulls an image silently', async () => { test("pulls an image silently", async () => {
await docker.pull(image, args, true) await docker.pull(image, args, true);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{silent: true} { silent: true }
) );
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await docker.inspect(image, args) const result = await docker.inspect(image, args);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{silent: false} { silent: false }
) );
}) });
test('inspects a docker image silently', async () => { test("inspects a docker image silently", async () => {
const result = await docker.inspect(image, args, true) const result = await docker.inspect(image, args, true);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{silent: true} { silent: true }
) );
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 3, stdout: '', stderr: ''} const execReturn = { exitCode: 3, stdout: "", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'} const execReturn = { exitCode: 0, stdout: "", stderr: "Output" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
}) });
+32 -32
View File
@@ -1,32 +1,32 @@
import {getExecOutput} from '@actions/exec' import { getExecOutput } from "@actions/exec";
export class DockerExec { export class DockerExec {
private readonly dockerPath: string private readonly dockerPath: string;
constructor(dockerPath: string) { constructor(dockerPath: string) {
this.dockerPath = dockerPath this.dockerPath = dockerPath;
} }
public async pull(image: string, args: string[], silent?: boolean) { public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(['pull', image, ...args], silent) const result = await this.execute(["pull", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) { if (result.stderr != "" || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`) throw new Error(`docker images pull failed: ${result.stderr}`);
} }
} }
public async inspect( public async inspect(
image: string, image: string,
args: string[], args: string[],
silent: boolean = false silent: boolean = false
): Promise<string> { ): Promise<string> {
const result = await this.execute(['inspect', image, ...args], silent) const result = await this.execute(["inspect", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) if (result.stderr != "" || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`) throw new Error(`docker inspect failed: ${result.stderr}`);
return result.stdout return result.stdout;
} }
private async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, {silent}) return await getExecOutput(this.dockerPath, args, { silent });
} }
} }
-48
View File
@@ -1,48 +0,0 @@
export interface Succeeded<T> {
readonly succeeded: true
readonly result: T
}
export interface Failed {
readonly succeeded: false
readonly error: string
}
export type Errorable<T> = Succeeded<T> | Failed
export function succeeded<T>(e: Errorable<T>): e is Succeeded<T> {
return e.succeeded
}
export function failed<T>(e: Errorable<T>): e is Failed {
return !e.succeeded
}
export function map<T, U>(e: Errorable<T>, fn: (t: T) => U): Errorable<U> {
if (failed(e)) {
return {succeeded: false, error: e.error}
}
return {succeeded: true, result: fn(e.result)}
}
export function combine<T>(es: Errorable<T>[]): Errorable<T[]> {
const failures = es.filter(failed)
if (failures.length > 0) {
return {
succeeded: false,
error: failures.map((f) => f.error).join('\n')
}
}
return {
succeeded: true,
result: es.map((e) => (e as Succeeded<T>).result)
}
}
export function getErrorMessage(error: unknown) {
if (error instanceof Error) {
return error.message
}
return String(error)
}
+29 -31
View File
@@ -1,40 +1,38 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {Octokit} from '@octokit/core' import { Octokit } from "@octokit/core";
import {Endpoints} from '@octokit/types' import { Endpoints } from "@octokit/types";
import {retry} from '@octokit/plugin-retry' import { retry } from "@octokit/plugin-retry";
export const OkStatusCode = 200 export const OkStatusCode = 200;
const RetryOctokit = Octokit.plugin(retry) const RetryOctokit = Octokit.plugin(retry);
const RETRY_COUNT = 5 const RETRY_COUNT = 5;
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows' const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows";
type responseType = type responseType =
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response'] Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
export class GitHubClient { export class GitHubClient {
private readonly repository: string private readonly repository: string;
private readonly token: string private readonly token: string;
constructor(repository: string, token: string) { constructor(repository: string, token: string) {
this.repository = repository this.repository = repository;
this.token = token this.token = token;
} }
// prettier-ignore public async getWorkflows(): Promise<responseType> {
public async getWorkflows(): Promise<responseType> { const octokit = new RetryOctokit({
const octokit = new RetryOctokit({ auth: this.token,
auth: this.token, request: { retries: RETRY_COUNT },
request: {retries: RETRY_COUNT}, });
baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com", const [owner, repo] = this.repository.split("/");
core.debug(`Getting workflows for repo: ${this.repository}`);
return Promise.resolve(
await octokit.request(requestUrl, {
owner,
repo,
}) })
const [owner, repo] = this.repository.split('/') );
}
core.debug(`Getting workflows for repo: ${this.repository}`)
return Promise.resolve(
await octokit.request(requestUrl, {
owner,
repo
})
)
}
} }
-59
View File
@@ -1,59 +0,0 @@
export interface K8sObject {
metadata: {
name: string
labels: Map<string, string>
namespace?: string
}
kind: string
spec: any
}
export interface K8sServiceObject extends K8sObject {
spec: {
selector: Map<string, string>
}
}
export interface K8sDeleteObject {
name: string
kind: string
namespace?: string
}
export interface K8sIngress extends K8sObject {
spec: {
rules: [
{
http: {
paths: [
{
backend: {
service: {
name: string
}
}
}
]
}
}
]
}
}
export interface TrafficSplitObject extends K8sObject {
apiVersion: string
metadata: {
name: string
labels: Map<string, string>
annotations: Map<string, string>
}
spec: {
service: string
backends: TrafficSplitBackend[]
}
}
export interface TrafficSplitBackend {
service: string
weight: number
}
+318 -524
View File
@@ -1,537 +1,331 @@
import {getKubectlPath, Kubectl} from './kubectl' import { getKubectlPath, Kubectl } from "./kubectl";
import * as exec from '@actions/exec' import * as exec from "@actions/exec";
import * as io from '@actions/io' import * as io from "@actions/io";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import { config } from "process";
describe('Kubectl path', () => { describe("Kubectl path", () => {
const version = '1.1' const version = "1.1";
const path = 'path' const path = "path";
it('gets the kubectl path', async () => { it("gets the kubectl path", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('gets the kubectl path with version', async () => { it("gets the kubectl path with version", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version) jest.spyOn(core, "getInput").mockImplementationOnce(() => version);
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path) jest.spyOn(toolCache, "find").mockImplementationOnce(() => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('throws if kubectl not found', async () => { it("throws if kubectl not found", async () => {
// without version // without version
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
// with verision // with verision
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
}) });
}) });
const kubectlPath = 'kubectlPath' const kubectlPath = "kubectlPath";
const testNamespace = 'testNamespace' const namespace = "namespace";
const defaultNamespace = 'default' describe("Kubectl class", () => {
const otherNamespace = 'otherns' const kubectl = new Kubectl(kubectlPath, namespace);
describe('Kubectl class', () => {
describe('with a success exec return in testNamespace', () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => { describe("with a success exec return", () => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => { const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
return execReturn
})
})
it('applies a configuration with a single config path', async () => { beforeEach(() => {
const configPaths = 'configPaths' jest.spyOn(exec, "getExecOutput").mockImplementation(async () => {
const result = await kubectl.apply(configPaths) return execReturn;
expect(result).toBe(execReturn) });
expect(exec.getExecOutput).toBeCalledWith( });
kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace],
{silent: false}
)
})
it('applies a configuration with multiple config paths', async () => { it("applies a configuration with a single config path", async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3'] const configPaths = "configPaths";
const result = await kubectl.apply(configPaths) const result = await kubectl.apply(configPaths);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'apply',
'-f',
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--namespace',
testNamespace
],
{silent: false}
)
})
it('applies a configuration with force when specified', async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3']
const result = await kubectl.apply(configPaths, true)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'apply',
'-f',
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--force',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('describes a resource', async () => {
const resourceType = 'type'
const resourceName = 'name'
const result = await kubectl.describe(resourceType, resourceName)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{silent: false}
)
// overrided ns
const silent = false
await kubectl.describe(
resourceType,
resourceName,
silent,
otherNamespace
)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
otherNamespace
],
{silent}
)
})
it('describes a resource silently', async () => {
const resourceType = 'type'
const resourceName = 'name'
const result = await kubectl.describe(resourceType, resourceName, true)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{silent: true}
)
// overrided ns
const silent = false
await kubectl.describe(
resourceType,
resourceName,
silent,
otherNamespace
)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
otherNamespace
],
{silent}
)
})
it('annotates resource', async () => {
const resourceType = 'type'
const resourceName = 'name'
const annotation = 'annotation'
const result = await kubectl.annotate(
resourceType,
resourceName,
annotation
)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
resourceType,
resourceName,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
// override ns
await kubectl.annotate(
resourceType,
resourceName,
annotation,
otherNamespace
)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
resourceType,
resourceName,
annotation,
'--overwrite',
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('annotates files with single file', async () => {
const file = 'file'
const annotation = 'annotation'
const result = await kubectl.annotateFiles(file, annotation)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
file,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
// override ns
await kubectl.annotateFiles(file, annotation, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
file,
annotation,
'--overwrite',
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('annotates files with mulitple files', async () => {
const files = ['file1', 'file2', 'file3']
const annotation = 'annotation'
const result = await kubectl.annotateFiles(files, annotation)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
files.join(','),
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
// override ns
await kubectl.annotateFiles(files, annotation, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
files.join(','),
annotation,
'--overwrite',
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('labels files with single file', async () => {
const file = 'file'
const labels = ['label1', 'label2']
const result = await kubectl.labelFiles(file, labels)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
file,
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
await kubectl.labelFiles(file, labels, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
file,
...labels,
'--overwrite',
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('labels files with multiple files', async () => {
const files = ['file1', 'file2', 'file3']
const labels = ['label1', 'label2']
const result = await kubectl.labelFiles(files, labels)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
files.join(','),
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
await kubectl.labelFiles(files, labels, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
files.join(','),
...labels,
'--overwrite',
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('gets all pods', async () => {
expect(await kubectl.getAllPods()).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['get', 'pods', '-o', 'json', '--namespace', testNamespace],
{silent: true}
)
})
it('checks rollout status', async () => {
const resourceType = 'type'
const name = 'name'
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
execReturn
)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'rollout',
'status',
`${resourceType}/${name}`,
'--namespace',
testNamespace
],
{silent: false}
)
// override ns
await kubectl.checkRolloutStatus(resourceType, name, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'rollout',
'status',
`${resourceType}/${name}`,
'--namespace',
otherNamespace
],
{silent: false}
)
})
it('gets resource', async () => {
const resourceType = 'type'
const name = 'name'
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'get',
`${resourceType}/${name}`,
'-o',
'json',
'--namespace',
testNamespace
],
{silent: false}
)
// override ns
const silent = true
await kubectl.getResource(resourceType, name, silent, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'get',
`${resourceType}/${name}`,
'-o',
'json',
'--namespace',
otherNamespace
],
{silent}
)
})
it('executes a command', async () => {
// no args
const command = 'command'
expect(await kubectl.executeCommand(command)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, '--namespace', testNamespace],
{silent: false}
)
// with args
const args = 'args'
expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, args, '--namespace', testNamespace],
{silent: false}
)
})
it('deletes with single argument', async () => {
const arg = 'argument'
expect(await kubectl.delete(arg)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', arg, '--namespace', testNamespace],
{silent: false}
)
// override ns
await kubectl.delete(arg, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', arg, '--namespace', otherNamespace],
{silent: false}
)
})
it('deletes with multiple arguments', async () => {
const args = ['argument1', 'argument2', 'argument3']
expect(await kubectl.delete(args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', ...args, '--namespace', testNamespace],
{silent: false}
)
// override ns
await kubectl.delete(args, otherNamespace)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', ...args, '--namespace', otherNamespace],
{silent: false}
)
})
})
it('gets new replica sets', async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const newReplicaSetName = 'newreplicaset'
const name = 'name'
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra',
stderr: ''
}
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
return describeReturn
})
const deployment = 'deployment'
const result = await kubectl.getNewReplicaSet(deployment)
expect(result).toBe(name)
})
it('executes with constructor flags', async () => {
const skipTls = true
const kubectl = new Kubectl(kubectlPath, testNamespace, skipTls)
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return {exitCode: 0, stderr: '', stdout: ''}
})
const command = 'command'
kubectl.executeCommand(command)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[command, '--insecure-skip-tls-verify', '--namespace', testNamespace], ["apply", "-f", configPaths, "--namespace", namespace],
{silent: false} { silent: false }
) );
});
const kubectlNoFlags = new Kubectl(kubectlPath) it("applies a configuration with multiple config paths", async () => {
kubectlNoFlags.executeCommand(command) const configPaths = ["configPath1", "configPath2", "configPath3"];
expect(exec.getExecOutput).toBeCalledWith(kubectlPath, [command], { const result = await kubectl.apply(configPaths);
silent: false expect(result).toBe(execReturn);
}) expect(exec.getExecOutput).toBeCalledWith(
}) kubectlPath,
}) [
"apply",
"-f",
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
"--namespace",
namespace,
],
{ silent: false }
);
});
it("applies a configuration with force when specified", async () => {
const configPaths = ["configPath1", "configPath2", "configPath3"];
const result = await kubectl.apply(configPaths, true);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"apply",
"-f",
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
"--force",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("describes a resource", async () => {
const resourceType = "type";
const resourceName = "name";
const result = await kubectl.describe(resourceType, resourceName);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["describe", resourceType, resourceName, "--namespace", namespace],
{ silent: false }
);
});
it("describes a resource silently", async () => {
const resourceType = "type";
const resourceName = "name";
const result = await kubectl.describe(resourceType, resourceName, true);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["describe", resourceType, resourceName, "--namespace", namespace],
{ silent: true }
);
});
it("annotates resource", async () => {
const resourceType = "type";
const resourceName = "name";
const annotation = "annotation";
const result = await kubectl.annotate(
resourceType,
resourceName,
annotation
);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"annotate",
resourceType,
resourceName,
annotation,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("annotates files with single file", async () => {
const file = "file";
const annotation = "annotation";
const result = await kubectl.annotateFiles(file, annotation);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"annotate",
"-f",
file,
annotation,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("annotates files with mulitple files", async () => {
const files = ["file1", "file2", "file3"];
const annotation = "annotation";
const result = await kubectl.annotateFiles(files, annotation);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"annotate",
"-f",
files.join(","),
annotation,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("labels files with single file", async () => {
const file = "file";
const labels = ["label1", "label2"];
const result = await kubectl.labelFiles(file, labels);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"label",
"-f",
file,
...labels,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("labels files with multiple files", async () => {
const files = ["file1", "file2", "file3"];
const labels = ["label1", "label2"];
const result = await kubectl.labelFiles(files, labels);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"label",
"-f",
files.join(","),
...labels,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("gets all pods", async () => {
expect(await kubectl.getAllPods()).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["get", "pods", "-o", "json", "--namespace", namespace],
{ silent: true }
);
});
it("checks rollout status", async () => {
const resourceType = "type";
const name = "name";
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
execReturn
);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"rollout",
"status",
`${resourceType}/${name}`,
"--namespace",
namespace,
],
{ silent: false }
);
});
it("gets resource", async () => {
const resourceType = "type";
const name = "name";
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"get",
`${resourceType}/${name}`,
"-o",
"json",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("executes a command", async () => {
// no args
const command = "command";
expect(await kubectl.executeCommand(command)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, "--namespace", namespace],
{ silent: false }
);
// with args
const args = "args";
expect(await kubectl.executeCommand(command, args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, args, "--namespace", namespace],
{ silent: false }
);
});
it("deletes with single argument", async () => {
const arg = "argument";
expect(await kubectl.delete(arg)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["delete", arg, "--namespace", namespace],
{ silent: false }
);
});
it("deletes with multiple arguments", async () => {
const args = ["argument1", "argument2", "argument3"];
expect(await kubectl.delete(args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["delete", ...args, "--namespace", namespace],
{ silent: false }
);
});
});
it("gets new replica sets", async () => {
const newReplicaSetName = "newreplicaset";
const name = "name";
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + " " + "extra",
stderr: "",
};
jest.spyOn(exec, "getExecOutput").mockImplementationOnce(async () => {
return describeReturn;
});
const deployment = "deployment";
const result = await kubectl.getNewReplicaSet(deployment);
expect(result).toBe(name);
});
});
+168 -232
View File
@@ -1,232 +1,168 @@
import {ExecOutput, getExecOutput} from '@actions/exec' import { ExecOutput, getExecOutput } from "@actions/exec";
import {createInlineArray} from '../utilities/arrayUtils' import { createInlineArray } from "../utilities/arrayUtils";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import * as io from '@actions/io' import * as io from "@actions/io";
export interface Resource { export interface Resource {
name: string name: string;
type: string type: string;
namespace?: string }
}
export class Kubectl {
export class Kubectl { private readonly kubectlPath: string;
protected readonly kubectlPath: string private readonly namespace: string;
protected readonly namespace: string private readonly ignoreSSLErrors: boolean;
protected readonly ignoreSSLErrors: boolean
protected readonly resourceGroup: string constructor(
protected readonly name: string kubectlPath: string,
protected isPrivateCluster: boolean namespace: string = "default",
ignoreSSLErrors: boolean = false
constructor( ) {
kubectlPath: string, this.kubectlPath = kubectlPath;
namespace: string = '', this.ignoreSSLErrors = !!ignoreSSLErrors;
ignoreSSLErrors: boolean = false, this.namespace = namespace;
resourceGroup: string = '', }
name: string = ''
) { public async apply(
this.kubectlPath = kubectlPath configurationPaths: string | string[],
this.ignoreSSLErrors = !!ignoreSSLErrors force: boolean = false
this.namespace = namespace ): Promise<ExecOutput> {
this.resourceGroup = resourceGroup try {
this.name = name if (!configurationPaths || configurationPaths?.length === 0)
} throw Error("Configuration paths must exist");
public async apply( const applyArgs: string[] = [
configurationPaths: string | string[], "apply",
force: boolean = false "-f",
): Promise<ExecOutput> { createInlineArray(configurationPaths),
try { ];
if (!configurationPaths || configurationPaths?.length === 0) if (force) applyArgs.push("--force");
throw Error('Configuration paths must exist')
return await this.execute(applyArgs);
const applyArgs: string[] = [ } catch (err) {
'apply', core.debug("Kubectl apply failed:" + err);
'-f', }
createInlineArray(configurationPaths) }
]
if (force) applyArgs.push('--force') public async describe(
resourceType: string,
return await this.execute(applyArgs.concat(this.getFlags())) resourceName: string,
} catch (err) { silent: boolean = false
core.debug('Kubectl apply failed:' + err) ): Promise<ExecOutput> {
} return await this.execute(["describe", resourceType, resourceName], silent);
} }
public async describe( public async getNewReplicaSet(deployment: string) {
resourceType: string, const result = await this.describe("deployment", deployment, true);
resourceName: string,
silent: boolean = false, let newReplicaSet = "";
namespace?: string if (result?.stdout) {
): Promise<ExecOutput> { const stdout = result.stdout.split("\n");
return await this.execute( stdout.forEach((line: string) => {
['describe', resourceType, resourceName].concat( const newreplicaset = "newreplicaset";
this.getFlags(namespace) if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
), newReplicaSet = line
silent .substring(newreplicaset.length)
) .trim()
} .split(" ")[0];
});
public async getNewReplicaSet(deployment: string, namespace?: string) { }
const result = await this.describe(
'deployment', return newReplicaSet;
deployment, }
true,
namespace public async annotate(
) resourceType: string,
resourceName: string,
let newReplicaSet = '' annotation: string
if (result?.stdout) { ): Promise<ExecOutput> {
const stdout = result.stdout.split('\n') const args = [
core.debug('stdout from getNewReplicaSet is ' + JSON.stringify(stdout)) "annotate",
stdout.forEach((line: string) => { resourceType,
const newreplicaset = 'newreplicaset' resourceName,
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) { annotation,
core.debug( "--overwrite",
`found string of interest for replicaset, line is ${line}` ];
) return await this.execute(args);
core.debug( }
`substring is ${line.substring(newreplicaset.length).trim()}`
) public async annotateFiles(
newReplicaSet = line files: string | string[],
.substring(newreplicaset.length) annotation: string
.trim() ): Promise<ExecOutput> {
.split(' ')[0] const args = [
} "annotate",
}) "-f",
} createInlineArray(files),
annotation,
return newReplicaSet "--overwrite",
} ];
return await this.execute(args);
public async annotate( }
resourceType: string,
resourceName: string, public async labelFiles(
annotation: string, files: string | string[],
namespace?: string labels: string[]
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
'annotate', "label",
resourceType, "-f",
resourceName, createInlineArray(files),
annotation, ...labels,
'--overwrite' "--overwrite",
].concat(this.getFlags(namespace)) ];
return await this.execute(args) return await this.execute(args);
} }
public async annotateFiles( public async getAllPods(): Promise<ExecOutput> {
files: string | string[], return await this.execute(["get", "pods", "-o", "json"], true);
annotation: string, }
namespace?: string
): Promise<ExecOutput> { public async checkRolloutStatus(
const filesToAnnotate = createInlineArray(files) resourceType: string,
core.debug(`annotating ${filesToAnnotate} with annotation ${annotation}`) name: string
const args = [ ): Promise<ExecOutput> {
'annotate', return await this.execute(["rollout", "status", `${resourceType}/${name}`]);
'-f', }
filesToAnnotate,
annotation, public async getResource(
'--overwrite' resourceType: string,
].concat(this.getFlags(namespace)) name: string
return await this.execute(args) ): Promise<ExecOutput> {
} return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]);
}
public async labelFiles(
files: string | string[], public executeCommand(command: string, args?: string) {
labels: string[], if (!command) throw new Error("Command must be defined");
namespace?: string return args ? this.execute([command, args]) : this.execute([command]);
): Promise<ExecOutput> { }
const args = [
'label', public delete(args: string | string[]) {
'-f', if (typeof args === "string") return this.execute(["delete", args]);
createInlineArray(files), return this.execute(["delete", ...args]);
...labels, }
'--overwrite'
].concat(this.getFlags(namespace)) private async execute(args: string[], silent: boolean = false) {
return await this.execute(args) if (this.ignoreSSLErrors) {
} args.push("--insecure-skip-tls-verify");
}
public async getAllPods(): Promise<ExecOutput> { args = args.concat(["--namespace", this.namespace]);
return await this.execute(
['get', 'pods', '-o', 'json'].concat(this.getFlags()), core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`);
true return await getExecOutput(this.kubectlPath, args, { silent });
) }
} }
public async checkRolloutStatus( export async function getKubectlPath() {
resourceType: string, const version = core.getInput("kubectl-version");
name: string, const kubectlPath = version
namespace?: string ? toolCache.find("kubectl", version)
): Promise<ExecOutput> { : await io.which("kubectl", true);
return await this.execute( if (!kubectlPath)
['rollout', 'status', `${resourceType}/${name}`].concat( throw Error(
this.getFlags(namespace) "kubectl not found. You must install it before running this action"
) );
)
} return kubectlPath;
}
public async getResource(
resourceType: string,
name: string,
silentFailure: boolean = false,
namespace?: string
): Promise<ExecOutput> {
core.debug(
'fetching resource of type ' + resourceType + ' and name ' + name
)
return await this.execute(
['get', `${resourceType}/${name}`, '-o', 'json'].concat(
this.getFlags(namespace)
),
silentFailure
)
}
public executeCommand(command: string, args?: string) {
if (!command) throw new Error('Command must be defined')
const a = args ? [args] : []
return this.execute([command, ...a.concat(this.getFlags())])
}
public delete(args: string | string[], namespace?: string) {
if (typeof args === 'string')
return this.execute(['delete', args].concat(this.getFlags(namespace)))
return this.execute(['delete', ...args.concat(this.getFlags(namespace))])
}
protected async execute(args: string[], silent: boolean = false) {
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
return await getExecOutput(this.kubectlPath, args, {
silent
})
}
protected getFlags(namespaceOverride?: string): string[] {
const flags = []
if (this.ignoreSSLErrors) {
flags.push('--insecure-skip-tls-verify')
}
const ns = namespaceOverride || this.namespace
if (ns) {
flags.push('--namespace', ns)
}
return flags
}
}
export async function getKubectlPath() {
const version = core.getInput('kubectl-version')
const kubectlPath = version
? toolCache.find('kubectl', version)
: await io.which('kubectl', true)
if (!kubectlPath)
throw Error(
'kubectl not found. You must install it before running this action'
)
return kubectlPath
}
+100 -102
View File
@@ -1,117 +1,115 @@
import { import {
DEPLOYMENT_TYPES, DEPLOYMENT_TYPES,
DiscoveryAndLoadBalancerResource, DiscoveryAndLoadBalancerResource,
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
ResourceKindNotDefinedError, ResourceKindNotDefinedError,
ServiceTypes, ServiceTypes,
WORKLOAD_TYPES, WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS WORKLOAD_TYPES_WITH_ROLLOUT_STATUS,
} from './kubernetesTypes' } from "./kubernetesTypes";
describe('Kubernetes types', () => { describe("Kubernetes types", () => {
it('contains kubernetes workloads', () => { it("contains kubernetes workloads", () => {
expect(KubernetesWorkload.POD).toBe('Pod') expect(KubernetesWorkload.POD).toBe("Pod");
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset') expect(KubernetesWorkload.REPLICASET).toBe("Replicaset");
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment') expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment");
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet') expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet");
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet') expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet");
expect(KubernetesWorkload.JOB).toBe('job') expect(KubernetesWorkload.JOB).toBe("job");
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob') expect(KubernetesWorkload.CRON_JOB).toBe("cronjob");
}) });
it('contains discovery and load balancer resources', () => { it("contains discovery and load balancer resources", () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service') expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service");
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress') expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress");
}) });
it('contains service types', () => { it("contains service types", () => {
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer') expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer");
expect(ServiceTypes.NODE_PORT).toBe('NodePort') expect(ServiceTypes.NODE_PORT).toBe("NodePort");
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP') expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP");
}) });
it('contains deployment types', () => { it("contains deployment types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true) expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types', () => { it("contains workload types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true) expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types with rollout status', () => { it("contains workload types with rollout status", () => {
const expected = ['deployment', 'daemonset', 'statefulset'] const expected = ["deployment", "daemonset", "statefulset"];
expect( expect(
expected.every((val) => expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val))
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val) ).toBe(true);
) });
).toBe(true)
})
it('checks if kind is deployment entity', () => { it("checks if kind is deployment entity", () => {
// throws on no kind // throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow( expect(() => isDeploymentEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isDeploymentEntity('deployment')).toBe(true) expect(isDeploymentEntity("deployment")).toBe(true);
expect(isDeploymentEntity('Deployment')).toBe(true) expect(isDeploymentEntity("Deployment")).toBe(true);
expect(isDeploymentEntity('deploymenT')).toBe(true) expect(isDeploymentEntity("deploymenT")).toBe(true);
expect(isDeploymentEntity('DEPLOYMENT')).toBe(true) expect(isDeploymentEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is workload entity', () => { it("checks if kind is workload entity", () => {
// throws on no kind // throws on no kind
expect(() => isWorkloadEntity(undefined)).toThrow( expect(() => isWorkloadEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isWorkloadEntity('deployment')).toBe(true) expect(isWorkloadEntity("deployment")).toBe(true);
expect(isWorkloadEntity('Deployment')).toBe(true) expect(isWorkloadEntity("Deployment")).toBe(true);
expect(isWorkloadEntity('deploymenT')).toBe(true) expect(isWorkloadEntity("deploymenT")).toBe(true);
expect(isWorkloadEntity('DEPLOYMENT')).toBe(true) expect(isWorkloadEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is service entity', () => { it("checks if kind is service entity", () => {
// throws on no kind // throws on no kind
expect(() => isServiceEntity(undefined)).toThrow( expect(() => isServiceEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isServiceEntity('service')).toBe(true) expect(isServiceEntity("service")).toBe(true);
expect(isServiceEntity('Service')).toBe(true) expect(isServiceEntity("Service")).toBe(true);
expect(isServiceEntity('servicE')).toBe(true) expect(isServiceEntity("servicE")).toBe(true);
expect(isServiceEntity('SERVICE')).toBe(true) expect(isServiceEntity("SERVICE")).toBe(true);
}) });
it('checks if kind is ingress entity', () => { it("checks if kind is ingress entity", () => {
// throws on no kind // throws on no kind
expect(() => isIngressEntity(undefined)).toThrow( expect(() => isIngressEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isIngressEntity('ingress')).toBe(true) expect(isIngressEntity("ingress")).toBe(true);
expect(isIngressEntity('Ingress')).toBe(true) expect(isIngressEntity("Ingress")).toBe(true);
expect(isIngressEntity('ingresS')).toBe(true) expect(isIngressEntity("ingresS")).toBe(true);
expect(isIngressEntity('INGRESS')).toBe(true) expect(isIngressEntity("INGRESS")).toBe(true);
}) });
}) });
+81 -81
View File
@@ -1,81 +1,81 @@
export class KubernetesWorkload { export class KubernetesWorkload {
public static POD: string = 'Pod' public static POD: string = "Pod";
public static REPLICASET: string = 'Replicaset' public static REPLICASET: string = "Replicaset";
public static DEPLOYMENT: string = 'Deployment' public static DEPLOYMENT: string = "Deployment";
public static STATEFUL_SET: string = 'StatefulSet' public static STATEFUL_SET: string = "StatefulSet";
public static DAEMON_SET: string = 'DaemonSet' public static DAEMON_SET: string = "DaemonSet";
public static JOB: string = 'job' public static JOB: string = "job";
public static CRON_JOB: string = 'cronjob' public static CRON_JOB: string = "cronjob";
} }
export class DiscoveryAndLoadBalancerResource { export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = 'service' public static SERVICE: string = "service";
public static INGRESS: string = 'ingress' public static INGRESS: string = "ingress";
} }
export class ServiceTypes { export class ServiceTypes {
public static LOAD_BALANCER: string = 'LoadBalancer' public static LOAD_BALANCER: string = "LoadBalancer";
public static NODE_PORT: string = 'NodePort' public static NODE_PORT: string = "NodePort";
public static CLUSTER_IP: string = 'ClusterIP' public static CLUSTER_IP: string = "ClusterIP";
} }
export const DEPLOYMENT_TYPES: string[] = [ export const DEPLOYMENT_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
export const WORKLOAD_TYPES: string[] = [ export const WORKLOAD_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [ export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
'deployment', "deployment",
'daemonset', "daemonset",
'statefulset' "statefulset",
] ];
export function isDeploymentEntity(kind: string): boolean { export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return DEPLOYMENT_TYPES.some((type: string) => { return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase() return type.toLowerCase() === kind.toLowerCase();
}) });
} }
export function isWorkloadEntity(kind: string): boolean { export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return WORKLOAD_TYPES.some( return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase() (type: string) => type.toLowerCase() === kind.toLowerCase()
) );
} }
export function isServiceEntity(kind: string): boolean { export function isServiceEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'service' === kind.toLowerCase() return "service" === kind.toLowerCase();
} }
export function isIngressEntity(kind: string): boolean { export function isIngressEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'ingress' === kind.toLowerCase() return "ingress" === kind.toLowerCase();
} }
export const ResourceKindNotDefinedError = Error('Resource kind not defined') export const ResourceKindNotDefinedError = Error("Resource kind not defined");
export const NullInputObjectError = Error('Null inputObject') export const NullInputObjectError = Error("Null inputObject");
export const InputObjectKindNotDefinedError = Error( export const InputObjectKindNotDefinedError = Error(
'Input object kind not defined' "Input object kind not defined"
) );
export const InputObjectMetadataNotDefinedError = Error( export const InputObjectMetadataNotDefinedError = Error(
'Input object metatada not defined' "Input object metatada not defined"
) );
-61
View File
@@ -1,61 +0,0 @@
import * as fileUtils from '../utilities/fileUtils'
import fs from 'node:fs'
import {
PrivateKubectl,
extractFileNames,
replaceFileNamesWithShallowNamesRelativeToTemp
} from './privatekubectl'
import * as exec from '@actions/exec'
describe('Private kubectl', () => {
const testString = `kubectl annotate -f /tmp/testdir/test.yml,/tmp/test2.yml,/tmp/testdir/subdir/test3.yml -f /tmp/test4.yml --filename /tmp/test5.yml actions.github.com/k8s-deploy={"run":"3498366832","repository":"jaiveerk/k8s-deploy","workflow":"Minikube Integration Tests - private cluster","workflowFileName":"run-integration-tests-private.yml","jobName":"run-integration-test","createdBy":"jaiveerk","runUri":"https://github.com/jaiveerk/k8s-deploy/actions/runs/3498366832","commit":"c63b323186ea1320a31290de6dcc094c06385e75","lastSuccessRunCommit":"NA","branch":"refs/heads/main","deployTimestamp":1668787848577,"dockerfilePaths":{"nginx:1.14.2":""},"manifestsPaths":["https://github.com/jaiveerk/k8s-deploy/blob/c63b323186ea1320a31290de6dcc094c06385e75/test/integration/test.yml"],"helmChartPaths":[],"provider":"GitHub"} --overwrite --namespace test-3498366832`
const mockKube = new PrivateKubectl(
'kubectlPath',
'namespace',
true,
'resourceGroup',
'resourceName'
)
const spy = jest
.spyOn(fileUtils, 'getTempDirectory')
.mockImplementation(() => {
return '/tmp'
})
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
return 'test contents'
})
it('should extract filenames correctly', () => {
expect(extractFileNames(testString)).toEqual([
'/tmp/testdir/test.yml',
'/tmp/test2.yml',
'/tmp/testdir/subdir/test3.yml',
'/tmp/test4.yml',
'/tmp/test5.yml'
])
})
it('should replace filenames with shallow names for relative locations in tmp correctly', () => {
expect(
replaceFileNamesWithShallowNamesRelativeToTemp(testString)
).toEqual(
`kubectl annotate -f testdir-test.yml,test2.yml,testdir-subdir-test3.yml -f test4.yml --filename test5.yml actions.github.com/k8s-deploy={"run":"3498366832","repository":"jaiveerk/k8s-deploy","workflow":"Minikube Integration Tests - private cluster","workflowFileName":"run-integration-tests-private.yml","jobName":"run-integration-test","createdBy":"jaiveerk","runUri":"https://github.com/jaiveerk/k8s-deploy/actions/runs/3498366832","commit":"c63b323186ea1320a31290de6dcc094c06385e75","lastSuccessRunCommit":"NA","branch":"refs/heads/main","deployTimestamp":1668787848577,"dockerfilePaths":{"nginx:1.14.2":""},"manifestsPaths":["https://github.com/jaiveerk/k8s-deploy/blob/c63b323186ea1320a31290de6dcc094c06385e75/test/integration/test.yml"],"helmChartPaths":[],"provider":"GitHub"} --overwrite --namespace test-3498366832`
)
})
test('Should throw well defined Error on error from Azure', async () => {
const errorMsg = 'An error message'
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return {exitCode: 1, stdout: '', stderr: errorMsg}
})
await expect(mockKube.executeCommand('az', 'test')).rejects.toThrow(
Error(
`Call to private cluster failed. Command: 'kubectl az test --insecure-skip-tls-verify --namespace namespace', errormessage: ${errorMsg}`
)
)
})
})
-169
View File
@@ -1,169 +0,0 @@
import {Kubectl} from './kubectl'
import minimist from 'minimist'
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
import * as core from '@actions/core'
import fs from 'node:fs'
import * as path from 'path'
import {getTempDirectory} from '../utilities/fileUtils'
export class PrivateKubectl extends Kubectl {
protected async execute(args: string[], silent: boolean = false) {
args.unshift('kubectl')
let kubectlCmd = args.join(' ')
let addFileFlag = false
let eo = <ExecOptions>{
silent: true,
failOnStdErr: false,
ignoreReturnCode: true
}
if (this.containsFilenames(kubectlCmd)) {
kubectlCmd = replaceFileNamesWithShallowNamesRelativeToTemp(kubectlCmd)
addFileFlag = true
}
if (this.resourceGroup === '') {
throw Error('Resource group must be specified for private cluster')
}
if (this.name === '') {
throw Error('Cluster name must be specified for private cluster')
}
const privateClusterArgs = [
'aks',
'command',
'invoke',
'--resource-group',
this.resourceGroup,
'--name',
this.name,
'--command',
`${kubectlCmd}`
]
if (addFileFlag) {
const tempDirectory = getTempDirectory()
eo.cwd = path.join(tempDirectory, 'manifests')
privateClusterArgs.push(...['--file', '.'])
}
core.debug(
`private cluster Kubectl run with invoke command: ${kubectlCmd}`
)
const allArgs = [...privateClusterArgs, '-o', 'json']
core.debug(`full form of az command: az ${allArgs.join(' ')}`)
const runOutput = await getExecOutput('az', allArgs, eo)
core.debug(
`from kubectl private cluster command got run output ${JSON.stringify(
runOutput
)}`
)
if (runOutput.exitCode !== 0) {
throw Error(
`Call to private cluster failed. Command: '${kubectlCmd}', errormessage: ${runOutput.stderr}`
)
}
const runObj: {logs: string; exitCode: number} = JSON.parse(
runOutput.stdout
)
if (!silent) core.info(runObj.logs)
if (runObj.exitCode !== 0) {
throw Error(`failed private cluster Kubectl command: ${kubectlCmd}`)
}
return {
exitCode: runObj.exitCode,
stdout: runObj.logs,
stderr: ''
} as ExecOutput
}
private containsFilenames(str: string) {
return str.includes('-f ') || str.includes('filename ')
}
}
function createTempManifestsDirectory(): string {
const manifestsDirPath = path.join(getTempDirectory(), 'manifests')
if (!fs.existsSync(manifestsDirPath)) {
fs.mkdirSync(manifestsDirPath, {recursive: true})
}
return manifestsDirPath
}
export function replaceFileNamesWithShallowNamesRelativeToTemp(
kubectlCmd: string
) {
let filenames = extractFileNames(kubectlCmd)
core.debug(`filenames originally provided in kubectl command: ${filenames}`)
let relativeShallowNames = filenames.map((filename) => {
const relativeName = path.relative(getTempDirectory(), filename)
const relativePathElements = relativeName.split(path.sep)
const shallowName = relativePathElements.join('-')
// make manifests dir in temp if it doesn't already exist
const manifestsTempDir = createTempManifestsDirectory()
const shallowPath = path.join(manifestsTempDir, shallowName)
core.debug(
`moving contents from ${filename} to shallow location at ${shallowPath}`
)
core.debug(`reading contents from ${filename}`)
const contents = fs.readFileSync(filename).toString()
core.debug(`writing contents to new path ${shallowPath}`)
fs.writeFileSync(shallowPath, contents)
return shallowName
})
let result = kubectlCmd
if (filenames.length != relativeShallowNames.length) {
throw Error(
'replacing filenames with relative path from temp dir, ' +
filenames.length +
' filenames != ' +
relativeShallowNames.length +
'basenames'
)
}
for (let index = 0; index < filenames.length; index++) {
result = result.replace(filenames[index], relativeShallowNames[index])
}
return result
}
export function extractFileNames(strToParse: string) {
const fileNames: string[] = []
const argv = minimist(strToParse.split(' '))
const fArg = 'f'
const filenameArg = 'filename'
fileNames.push(...extractFilesFromMinimist(argv, fArg))
fileNames.push(...extractFilesFromMinimist(argv, filenameArg))
return fileNames
}
export function extractFilesFromMinimist(argv, arg: string): string[] {
if (!argv[arg]) {
return []
}
const toReturn: string[] = []
if (typeof argv[arg] === 'string') {
toReturn.push(...argv[arg].split(','))
} else {
for (const value of argv[arg] as string[]) {
toReturn.push(...value.split(','))
}
}
return toReturn
}
+19 -19
View File
@@ -1,22 +1,22 @@
import {parseRouteStrategy, RouteStrategy} from './routeStrategy' import { parseRouteStrategy, RouteStrategy } from "./routeStrategy";
describe('Route strategy type', () => { describe("Route strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(RouteStrategy) const vals = <any>Object.values(RouteStrategy);
expect(vals.includes('ingress')).toBe(true) expect(vals.includes("ingress")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
expect(vals.includes('service')).toBe(true) expect(vals.includes("service")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseRouteStrategy('ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('Ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("Ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('ingresS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingresS")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('INGRESS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("INGRESS")).toBe(RouteStrategy.INGRESS);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy('invalid')).toBe(undefined) expect(parseRouteStrategy("invalid")).toBe(undefined);
expect(parseRouteStrategy('unsupportedType')).toBe(undefined) expect(parseRouteStrategy("unsupportedType")).toBe(undefined);
}) });
}) });
+8 -8
View File
@@ -1,12 +1,12 @@
export enum RouteStrategy { export enum RouteStrategy {
INGRESS = 'ingress', INGRESS = "ingress",
SMI = 'smi', SMI = "smi",
SERVICE = 'service' SERVICE = "service",
} }
export const parseRouteStrategy = (str: string): RouteStrategy | undefined => export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
RouteStrategy[ RouteStrategy[
Object.keys(RouteStrategy).filter( Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase() (k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy )[0] as keyof typeof RouteStrategy
] ];
+21 -18
View File
@@ -1,21 +1,24 @@
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod' import {
parseTrafficSplitMethod,
TrafficSplitMethod,
} from "./trafficSplitMethod";
describe('Traffic split method type', () => { describe("Traffic split method type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(TrafficSplitMethod) const vals = <any>Object.values(TrafficSplitMethod);
expect(vals.includes('pod')).toBe(true) expect(vals.includes("pod")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseTrafficSplitMethod('pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('Pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("Pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('poD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("poD")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('POD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("POD")).toBe(TrafficSplitMethod.POD);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod('invalid')).toBe(undefined) expect(parseTrafficSplitMethod("invalid")).toBe(undefined);
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined) expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined);
}) });
}) });
+9 -9
View File
@@ -1,6 +1,6 @@
export enum TrafficSplitMethod { export enum TrafficSplitMethod {
POD = 'pod', POD = "pod",
SMI = 'smi' SMI = "smi",
} }
/** /**
@@ -9,11 +9,11 @@ export enum TrafficSplitMethod {
* @returns The TrafficSplitMethod enum or undefined if it can't be parsed * @returns The TrafficSplitMethod enum or undefined if it can't be parsed
*/ */
export const parseTrafficSplitMethod = ( export const parseTrafficSplitMethod = (
str: string str: string
): TrafficSplitMethod | undefined => ): TrafficSplitMethod | undefined =>
TrafficSplitMethod[ TrafficSplitMethod[
Object.keys(TrafficSplitMethod).filter( Object.keys(TrafficSplitMethod).filter(
(k) => (k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase() TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod )[0] as keyof typeof TrafficSplitMethod
] ];
+10 -10
View File
@@ -1,12 +1,12 @@
import {createInlineArray} from './arrayUtils' import { createInlineArray } from "./arrayUtils";
describe('array utilities', () => { describe("array utilities", () => {
it('creates an inline array', () => { it("creates an inline array", () => {
const strings = ['str1', 'str2', 'str3'] const strings = ["str1", "str2", "str3"];
expect(createInlineArray(strings)).toBe(strings.join(',')) expect(createInlineArray(strings)).toBe(strings.join(","));
const string = 'str1' const string = "str1";
expect(createInlineArray([string])).toBe(string) expect(createInlineArray([string])).toBe(string);
expect(createInlineArray(string)).toBe(string) expect(createInlineArray(string)).toBe(string);
}) });
}) });
+6 -6
View File
@@ -1,6 +1,6 @@
export function createInlineArray(str: string | string[]): string { export function createInlineArray(str: string | string[]): string {
if (typeof str === 'string') { if (typeof str === "string") {
return str return str;
} }
return str.join(',') return str.join(",");
} }
+13 -13
View File
@@ -1,15 +1,15 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {checkDockerPath} from './dockerUtils' import { checkDockerPath } from "./dockerUtils";
describe('docker utilities', () => { describe("docker utilities", () => {
it('checks if docker is installed', async () => { it("checks if docker is installed", async () => {
// docker installed // docker installed
const path = 'path' const path = "path";
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(() => checkDockerPath()).not.toThrow() expect(() => checkDockerPath()).not.toThrow();
// docker not installed // docker not installed
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => checkDockerPath()).rejects.toThrow() await expect(() => checkDockerPath()).rejects.toThrow();
}) });
}) });
+59 -63
View File
@@ -1,79 +1,75 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import * as core from '@actions/core' import * as core from "@actions/core";
import {DockerExec} from '../types/docker' import { DockerExec } from "../types/docker";
import {getNormalizedPath} from './githubUtils' import { getNormalizedPath } from "./githubUtils";
export async function getDeploymentConfig(): Promise<DeploymentConfig> { export async function getDeploymentConfig(): Promise<DeploymentConfig> {
let helmChartPaths: string[] = let helmChartPaths: string[] =
process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') || process.env?.HELM_CHART_PATHS?.split(";").filter((path) => path != "") ||
[] [];
helmChartPaths = helmChartPaths.map((helmchart) => helmChartPaths = helmChartPaths.map((helmchart) =>
getNormalizedPath(helmchart.trim()) getNormalizedPath(helmchart.trim())
) );
let inputManifestFiles: string[] = let inputManifestFiles: string[] =
core core
.getInput('manifests') .getInput("manifests")
.split(/[\n,;]+/) .split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || [] .filter((manifest) => manifest.trim().length > 0) || [];
if (helmChartPaths?.length == 0) { if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) => inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile) getNormalizedPath(manifestFile)
) );
} }
const imageNames = const imageNames = core.getInput("images").split("\n") || [];
core const imageDockerfilePathMap: { [id: string]: string } = {};
.getInput('images')
.split('\n')
.filter((image) => image.length > 0) || []
const imageDockerfilePathMap: {[id: string]: string} = {}
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false') const pullImages = !(core.getInput("pull-images").toLowerCase() === "false");
if (pullImages) { if (pullImages) {
//Fetching from image label if available //Fetching from image label if available
for (const image of imageNames) { for (const image of imageNames) {
try { try {
imageDockerfilePathMap[image] = await getDockerfilePath(image) imageDockerfilePathMap[image] = await getDockerfilePath(image);
} catch (ex) { } catch (ex) {
core.warning( core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} ` `Failed to get dockerfile path for image ${image.toString()}: ${ex} `
) );
}
} }
} }
}
return Promise.resolve(<DeploymentConfig>{ return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles, manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths, helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap dockerfilePaths: imageDockerfilePathMap,
}) });
} }
async function getDockerfilePath(image: any): Promise<string> { async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath() await checkDockerPath();
const dockerExec: DockerExec = new DockerExec('docker') const dockerExec: DockerExec = new DockerExec("docker");
await dockerExec.pull(image, [], false) await dockerExec.pull(image, [], false);
const imageInspectResult: string = await dockerExec.inspect(image, [], false) const imageInspectResult: string = await dockerExec.inspect(image, [], false);
const imageConfig = JSON.parse(imageInspectResult)[0] const imageConfig = JSON.parse(imageInspectResult)[0];
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path' const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path";
let pathValue: string = '' let pathValue: string = "";
if ( if (
imageConfig?.Config?.Labels && imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY] imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) { ) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY] const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY];
pathValue = getNormalizedPath(pathLabel) pathValue = getNormalizedPath(pathLabel);
} }
return Promise.resolve(pathValue) return Promise.resolve(pathValue);
} }
export async function checkDockerPath() { export async function checkDockerPath() {
const dockerPath = await io.which('docker', false) const dockerPath = await io.which("docker", false);
if (!dockerPath) { if (!dockerPath) {
throw new Error('Docker is not installed.') throw new Error("Docker is not installed.");
} }
} }
+39 -112
View File
@@ -1,122 +1,49 @@
import * as fileUtils from './fileUtils' import {
getFilesFromDirectories
} from "./fileUtils";
import * as path from "path";
import * as yaml from 'js-yaml' describe("File utils", () => {
import fs from 'node:fs' it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
import * as path from 'path' const testPath = path.join("test", "unit", "manifests")
import {K8sObject} from '../types/k8sObject' const testSearch: string[] = getFilesFromDirectories([testPath])
const sampleYamlUrl = const expectedManifests =
'https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/controllers/nginx-deployment.yaml' [
describe('File utils', () => { "test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml",
test('correctly parses a yaml file from a URL', async () => { "test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml",
const tempFile = await fileUtils.writeYamlFromURLToFile(sampleYamlUrl, 0) "test/unit/manifests/manifest_test_dir/nested-test-service.yaml",
const fileContents = fs.readFileSync(tempFile).toString() "test/unit/manifests/test-ingress.yml",
const inputObjects: K8sObject[] = yaml.loadAll( "test/unit/manifests/test-service.yml"
fileContents ]
) as K8sObject[]
expect(inputObjects).toHaveLength(1)
// is there a more efficient way to test equality w random order?
for (const obj of inputObjects) { expect(testSearch).toHaveLength(5);
expect(obj.metadata.name).toBe('nginx-deployment')
expect(obj.kind).toBe('Deployment')
}
})
it('fails when a bad URL is given among other files', async () => {
const badUrl = 'https://www.github.com'
const testPath = path.join('test', 'unit', 'manifests')
await expect(
fileUtils.getFilesFromDirectoriesAndURLs([testPath, badUrl])
).rejects.toThrow()
})
it('detects files in nested directories with the same name and ignores non-manifest files and empty dirs', async () => {
const testPath = path.join('test', 'unit', 'manifests')
const testSearch: string[] =
await fileUtils.getFilesFromDirectoriesAndURLs([
testPath,
sampleYamlUrl
])
const expectedManifests = [
'test/unit/manifests/manifest_test_dir/another_layer/test-ingress.yaml',
'test/unit/manifests/manifest_test_dir/another_layer/nested-test-service.yaml',
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml',
'test/unit/manifests/test-ingress.yml',
'test/unit/manifests/test-ingress-new.yml',
'test/unit/manifests/test-service.yml'
]
expect(testSearch).toHaveLength(8)
expectedManifests.forEach((fileName) => { expectedManifests.forEach((fileName) => {
if (fileName.startsWith('test/unit')) { expect(testSearch).toContain(fileName)
expect(testSearch).toContain(fileName)
} else {
expect(fileName.includes(fileUtils.urlFileKind)).toBe(true)
expect(fileName.startsWith(fileUtils.getTempDirectory()))
}
}) })
})
it('crashes when an invalid file is provided', async () => { });
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
const goodPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect( it("crashes when an invalid file is provided", () => {
fileUtils.getFilesFromDirectoriesAndURLs([badPath, goodPath]) const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml")
).rejects.toThrowError() const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir")
})
it("doesn't duplicate files when nested dir included", async () => { expect(() => {getFilesFromDirectories([badPath, goodPath])}).toThrowError()
const outerPath = path.join('test', 'unit', 'manifests') });
const fileAtOuter = path.join(
'test',
'unit',
'manifests',
'test-service.yml'
)
const innerPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect( it("doesn't duplicate files when nested dir included", () => {
await fileUtils.getFilesFromDirectoriesAndURLs([ const outerPath = path.join("test", "unit", "manifests")
outerPath, const fileAtOuter = path.join("test", "unit", "manifests", "test-service.yml")
fileAtOuter, const innerPath = path.join("test", "unit", "manifests", "manifest_test_dir")
innerPath
])
).toHaveLength(7)
})
it('throws an error for an invalid URL', async () => { expect(getFilesFromDirectories([outerPath, fileAtOuter, innerPath])).toHaveLength(5)
const badUrl = 'https://www.github.com' })
await expect( });
fileUtils.writeYamlFromURLToFile(badUrl, 0)
).rejects.toBeTruthy()
})
})
describe('moving files to temp', () => {
it('correctly moves the contents of a file to the temporary directory', () => { // files that don't exist / nested files that don't exist / something else with non-manifest
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {}) // lots of combinations of pointing to a directory and non yaml/yaml file
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => { // similarly named files in different folders
return 'test contents'
})
const originalFilePath = path.join('path', 'in', 'repo')
const output = fileUtils.moveFileToTmpDir(originalFilePath)
expect(output).toEqual(
path.join(fileUtils.getTempDirectory(), '/path/in/repo')
)
})
})
+109 -235
View File
@@ -1,235 +1,109 @@
import fs from 'node:fs' import * as fs from "fs";
import * as https from 'https' import * as path from "path";
import * as path from 'path' import * as core from "@actions/core";
import * as core from '@actions/core' import * as os from "os";
import * as os from 'os' import { getCurrentTime } from "./timeUtils";
import * as yaml from 'js-yaml'
import {Errorable, succeeded, failed, Failed} from '../types/errorable' export function getTempDirectory(): string {
import {getCurrentTime} from './timeUtils' return process.env["runner.tempDirectory"] || os.tmpdir();
import {isHttpUrl} from './githubUtils' }
import {K8sObject} from '../types/k8sObject'
export function writeObjectsToFile(inputObjects: any[]): string[] {
export const urlFileKind = 'urlfile' const newFilePaths = [];
export function getTempDirectory(): string { inputObjects.forEach((inputObject: any) => {
return process.env['runner.tempDirectory'] || os.tmpdir() try {
} const inputObjectString = JSON.stringify(inputObject);
export function writeObjectsToFile(inputObjects: any[]): string[] { if (inputObject?.metadata?.name) {
const newFilePaths = [] const fileName = getManifestFileName(
inputObject.kind,
inputObjects.forEach((inputObject: any) => { inputObject.metadata.name
try { );
const inputObjectString = JSON.stringify(inputObject) fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName);
if (inputObject?.metadata?.name) { } else {
const fileName = getNewTempManifestFileName( core.debug(
inputObject.kind, "Input object is not proper K8s resource object. Object: " +
inputObject.metadata.name inputObjectString
) );
fs.writeFileSync(path.join(fileName), inputObjectString) }
newFilePaths.push(fileName) } catch (ex) {
} else { core.debug(
core.debug( `Exception occurred while writing object to file ${inputObject}: ${ex}`
'Input object is not proper K8s resource object. Object: ' + );
inputObjectString }
) });
}
} catch (ex) { return newFilePaths;
core.debug( }
`Exception occurred while writing object to file ${inputObject}: ${ex}`
) export function writeManifestToFile(
} inputObjectString: string,
}) kind: string,
name: string
return newFilePaths ): string {
} if (inputObjectString) {
try {
export function writeManifestToFile( const fileName = getManifestFileName(kind, name);
inputObjectString: string, fs.writeFileSync(path.join(fileName), inputObjectString);
kind: string, return fileName;
name: string } catch (ex) {
): string { throw Error(
if (inputObjectString) { `Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
try { );
const fileName = getNewTempManifestFileName(kind, name) }
fs.writeFileSync(path.join(fileName), inputObjectString) }
return fileName }
} catch (ex) {
throw Error( function getManifestFileName(kind: string, name: string) {
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}` const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`;
) const tempDirectory = getTempDirectory();
} return path.join(tempDirectory, path.basename(filePath));
} }
}
export function getFilesFromDirectories(
export function moveFileToTmpDir(originalFilepath: string) { filePaths: string[]
const tempDirectory = getTempDirectory() ): string[]{
const newPath = path.join(tempDirectory, originalFilepath)
const fullPathSet: Set<string> = new Set<string>()
core.debug(`reading original contents from path: ${originalFilepath}`)
const contents = fs.readFileSync(originalFilepath).toString() filePaths.forEach((fileName => {
try {
const dirName = path.dirname(newPath) if(fs.lstatSync(fileName).isDirectory()){
if (!fs.existsSync(dirName)) { recurisveManifestGetter(fileName).forEach((file) => {fullPathSet.add(file)})
core.debug(`path ${dirName} doesn't exist yet, making new dir...`) } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
fs.mkdirSync(dirName, {recursive: true}) fullPathSet.add(fileName)
} } else{
core.debug(`writing contents to new path ${newPath}`) core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
fs.writeFileSync(path.join(newPath), contents) }
} catch (ex) {
core.debug(`moved contents from ${originalFilepath} to ${newPath}`) throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
return newPath );
} }
}))
function getNewTempManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_${getCurrentTime().toString()}` return Array.from(fullPathSet)
const tempDirectory = getTempDirectory() }
return path.join(tempDirectory, path.basename(filePath))
} function recurisveManifestGetter(dirName: string): string[]{
const toRet: string[] = []
export async function getFilesFromDirectoriesAndURLs(
filePaths: string[] fs.readdirSync(dirName).forEach((fileName) => {
): Promise<string[]> { const fnwd: string = path.join(dirName, fileName)
const fullPathSet: Set<string> = new Set<string>() if(fs.lstatSync(fnwd).isDirectory()){
toRet.push(...recurisveManifestGetter(fnwd))
let fileCounter = 0 } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
for (const fileName of filePaths) { toRet.push(path.join(dirName, fileName))
try { } else{
if (isHttpUrl(fileName)) { core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
try { }
const tempFilePath: string = await writeYamlFromURLToFile( })
fileName,
fileCounter++ return toRet
) }
fullPathSet.add(tempFilePath)
} catch (e) { function getFileExtension(fileName: string){
throw Error( return fileName.slice((fileName.lastIndexOf(".") - 1 >>> 0) + 2)
`encountered error trying to pull YAML from URL ${fileName}: ${e}` }
)
}
} else if (fs.lstatSync(fileName).isDirectory()) {
recurisveManifestGetter(fileName).forEach((file) => {
fullPathSet.add(file)
})
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
fullPathSet.add(fileName)
} else {
core.debug(
`Detected non-manifest file, ${fileName}, continuing... `
)
}
} catch (ex) {
throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
)
}
}
const arr = Array.from(fullPathSet)
return arr
}
export async function writeYamlFromURLToFile(
url: string,
fileNumber: number
): Promise<string> {
return new Promise((resolve, reject) => {
https
.get(url, async (response) => {
const code = response.statusCode ?? 0
if (code >= 400) {
reject(
Error(
`received response status ${response.statusMessage} from url ${url}`
)
)
}
const targetPath = getNewTempManifestFileName(
urlFileKind,
fileNumber.toString()
)
// save the file to disk
const fileWriter = fs
.createWriteStream(targetPath)
.on('finish', () => {
const verification = verifyYaml(targetPath, url)
if (succeeded(verification)) {
core.debug(
`outputting YAML contents from ${url} to ${targetPath}: ${JSON.stringify(
verification.result
)}`
)
resolve(targetPath)
} else {
reject(verification.error)
}
})
response.pipe(fileWriter)
})
.on('error', (error) => {
reject(error)
})
})
}
function verifyYaml(filepath: string, url: string): Errorable<K8sObject[]> {
const fileContents = fs.readFileSync(filepath).toString()
let inputObjects
try {
inputObjects = yaml.loadAll(fileContents)
} catch (e) {
return {
succeeded: false,
error: `failed to parse manifest from url ${url}: ${e}`
}
}
if (!inputObjects || inputObjects.length == 0) {
return {
succeeded: false,
error: `failed to parse manifest from url ${url}: no objects detected in manifest`
}
}
for (const obj of inputObjects) {
if (!obj.kind || !obj.apiVersion || !obj.metadata) {
return {
succeeded: false,
error: `failed to parse manifest from ${url}: missing fields`
}
}
}
return {succeeded: true, result: inputObjects}
}
function recurisveManifestGetter(dirName: string): string[] {
const toRet: string[] = []
fs.readdirSync(dirName).forEach((fileName) => {
const fnwd: string = path.join(dirName, fileName)
if (fs.lstatSync(fnwd).isDirectory()) {
toRet.push(...recurisveManifestGetter(fnwd))
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
toRet.push(path.join(dirName, fileName))
} else {
core.debug(`Detected non-manifest file, ${fileName}, continuing... `)
}
})
return toRet
}
function getFileExtension(fileName: string) {
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
}
+40 -40
View File
@@ -1,48 +1,48 @@
import { import {
getNormalizedPath, getNormalizedPath,
isHttpUrl, isHttpUrl,
normalizeWorkflowStrLabel normalizeWorkflowStrLabel,
} from './githubUtils' } from "./githubUtils";
describe('Github utils', () => { describe("Github utils", () => {
it('normalizes workflow string labels', () => { it("normalizes workflow string labels", () => {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
const path = 'test/path/test' const path = "test/path/test";
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path) expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path);
expect(normalizeWorkflowStrLabel(path)).toBe(path) expect(normalizeWorkflowStrLabel(path)).toBe(path);
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe( expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath path + workflowsPath
) );
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe( expect(normalizeWorkflowStrLabel(path + " " + path)).toBe(
path + '_' + path path + "_" + path
) );
}) });
it('normalizes path', () => { it("normalizes path", () => {
const httpUrl = 'http://www.test.com' const httpUrl = "http://www.test.com";
expect(getNormalizedPath(httpUrl)).toBe(httpUrl) expect(getNormalizedPath(httpUrl)).toBe(httpUrl);
const httpsUrl = 'https://www.test.com' const httpsUrl = "https://www.test.com";
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl) expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl);
const repo = 'gh_repo' const repo = "gh_repo";
const sha = 'gh_sha' const sha = "gh_sha";
const path = 'path' const path = "path";
process.env.GITHUB_REPOSITORY = repo process.env.GITHUB_REPOSITORY = repo;
process.env.GITHUB_SHA = sha process.env.GITHUB_SHA = sha;
expect(getNormalizedPath(path)).toBe( expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}` `https://github.com/${repo}/blob/${sha}/${path}`
) );
}) });
it('checks if url is http', () => { it("checks if url is http", () => {
expect(isHttpUrl('www.test.com')).toBe(false) expect(isHttpUrl("www.test.com")).toBe(false);
expect(isHttpUrl('http.test.com')).toBe(false) expect(isHttpUrl("http.test.com")).toBe(false);
expect(isHttpUrl('http:.test.com')).toBe(false) expect(isHttpUrl("http:.test.com")).toBe(false);
expect(isHttpUrl('http:/.test.com')).toBe(false) expect(isHttpUrl("http:/.test.com")).toBe(false);
expect(isHttpUrl('https://www.test.com')).toBe(true) expect(isHttpUrl("https://www.test.com")).toBe(true);
expect(isHttpUrl('http://wwww.test.com')).toBe(true) expect(isHttpUrl("http://wwww.test.com")).toBe(true);
}) });
}) });
+39 -39
View File
@@ -1,54 +1,54 @@
import {GitHubClient, OkStatusCode} from '../types/githubClient' import { GitHubClient, OkStatusCode } from "../types/githubClient";
import * as core from '@actions/core' import * as core from "@actions/core";
export async function getWorkflowFilePath( export async function getWorkflowFilePath(
githubToken: string githubToken: string
): Promise<string> { ): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW let workflowFilePath = process.env.GITHUB_WORKFLOW;
if (!workflowFilePath.startsWith('.github/workflows/')) { if (!workflowFilePath.startsWith(".github/workflows/")) {
const githubClient = new GitHubClient( const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY, process.env.GITHUB_REPOSITORY,
githubToken githubToken
) );
const response = await githubClient.getWorkflows() const response = await githubClient.getWorkflows();
if (response) { if (response) {
if (response.status === OkStatusCode && response.data.total_count) { if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) { if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) { for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) { if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path workflowFilePath = workflow.path;
break break;
}
}
} }
} else if (response.status != OkStatusCode) { }
core.error( }
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}` } else if (response.status != OkStatusCode) {
) core.error(
} `An error occurred while getting list of workflows on the repo. Status code: ${response.status}`
} else { );
core.error(`Failed to get response from workflow list API`)
} }
} } else {
return Promise.resolve(workflowFilePath) core.error(`Failed to get response from workflow list API`);
}
}
return Promise.resolve(workflowFilePath);
} }
export function normalizeWorkflowStrLabel(workflowName: string): string { export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
workflowName = workflowName.startsWith(workflowsPath) workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, '') ? workflowName.replace(workflowsPath, "")
: workflowName : workflowName;
return workflowName.replace(/ /g, '_') return workflowName.replace(/ /g, "_");
} }
export function getNormalizedPath(pathValue: string) { export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) { if (!isHttpUrl(pathValue)) {
//if it is not an http url then convert to link from current repo and commit //if it is not an http url then convert to link from current repo and commit
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}` return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`;
} }
return pathValue return pathValue;
} }
export function isHttpUrl(url: string) { export function isHttpUrl(url: string) {
return /^https?:\/\/.*$/.test(url) return /^https?:\/\/.*$/.test(url);
} }
+54 -54
View File
@@ -1,61 +1,61 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
describe('Kubectl utils', () => { describe("Kubectl utils", () => {
it('checks for errors', () => { it("checks for errors", () => {
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0} const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 };
const successWithStderr: ExecOutput = { const successWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 0 exitCode: 0,
} };
const failWithExitCode: ExecOutput = { const failWithExitCode: ExecOutput = {
stderr: '', stderr: "",
stdout: '', stdout: "",
exitCode: 1 exitCode: 1,
} };
const failWithExitWithStderr: ExecOutput = { const failWithExitWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 2 exitCode: 2,
} };
// with throw behavior // with throw behavior
expect(() => checkForErrors([success])).not.toThrow() expect(() => checkForErrors([success])).not.toThrow();
expect(() => checkForErrors([successWithStderr])).not.toThrow() expect(() => checkForErrors([successWithStderr])).not.toThrow();
expect(() => checkForErrors([success, successWithStderr])).not.toThrow() expect(() => checkForErrors([success, successWithStderr])).not.toThrow();
expect(() => checkForErrors([failWithExitCode])).toThrow() expect(() => checkForErrors([failWithExitCode])).toThrow();
expect(() => checkForErrors([failWithExitWithStderr])).toThrow() expect(() => checkForErrors([failWithExitWithStderr])).toThrow();
expect(() => checkForErrors([success, failWithExitCode])).toThrow() expect(() => checkForErrors([success, failWithExitCode])).toThrow();
expect(() => expect(() =>
checkForErrors([successWithStderr, failWithExitCode]) checkForErrors([successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode]) checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr]) checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow() ).toThrow();
// with warn behavior // with warn behavior
jest.spyOn(core, 'warning').mockImplementation(() => {}) jest.spyOn(core, "warning").mockImplementation(() => {});
let warningCalls = 0 let warningCalls = 0;
expect(() => checkForErrors([success], true)).not.toThrow() expect(() => checkForErrors([success], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(warningCalls) expect(core.warning).toBeCalledTimes(warningCalls);
expect(() => checkForErrors([successWithStderr], true)).not.toThrow() expect(() => checkForErrors([successWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => expect(() =>
checkForErrors([success, successWithStderr], true) checkForErrors([success, successWithStderr], true)
).not.toThrow() ).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow() expect(() => checkForErrors([failWithExitCode], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow() expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
}) });
}) });
+66 -86
View File
@@ -1,102 +1,82 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
const NAMESPACE = 'namespace'
export function checkForErrors( export function checkForErrors(
execResults: ExecOutput[], execResults: ExecOutput[],
warnIfError?: boolean warnIfError?: boolean
) { ) {
let stderr = '' let stderr = "";
execResults.forEach((result) => { execResults.forEach((result) => {
if (result?.exitCode !== 0) { if (result?.exitCode !== 0) {
stderr += result?.stderr + ' \n' stderr += result?.stderr + " \n";
} else if (result?.stderr) { } else if (result?.stderr) {
core.warning(result.stderr) core.warning(result.stderr);
} }
}) });
if (stderr.length > 0) { if (stderr.length > 0) {
if (warnIfError) { if (warnIfError) {
core.warning(stderr.trim()) core.warning(stderr.trim());
} else { } else {
throw new Error(stderr.trim()) throw new Error(stderr.trim());
} }
} }
} }
export async function getLastSuccessfulRunSha( export async function getLastSuccessfulRunSha(
kubectl: Kubectl, kubectl: Kubectl,
namespaceName: string, namespaceName: string,
annotationKey: string annotationKey: string
): Promise<string> { ): Promise<string> {
try { try {
const result = await kubectl.getResource( const result = await kubectl.getResource("namespace", namespaceName);
NAMESPACE, if (result?.stderr) {
namespaceName, core.warning(result.stderr);
false, return process.env.GITHUB_SHA;
namespaceName } else if (result?.stdout) {
) const annotationsSet = JSON.parse(result.stdout).metadata.annotations;
if (result?.stderr) { if (annotationsSet && annotationsSet[annotationKey]) {
core.warning(result.stderr) return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
return process.env.GITHUB_SHA .commit;
} else if (result?.stdout) { } else {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations return "NA";
if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit
} else {
return 'NA'
}
} }
} catch (ex) { }
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`) } catch (ex) {
return '' core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`);
} return "";
}
} }
export async function annotateChildPods( export async function annotateChildPods(
kubectl: Kubectl, kubectl: Kubectl,
resourceType: string, resourceType: string,
resourceName: string, resourceName: string,
namespace: string | undefined, annotationKeyValStr: string,
annotationKeyValStr: string allPods
): Promise<ExecOutput[]> { ): Promise<ExecOutput[]> {
let owner = resourceName let owner = resourceName;
if (resourceType.toLowerCase().indexOf('deployment') > -1) { if (resourceType.toLowerCase().indexOf("deployment") > -1) {
owner = await kubectl.getNewReplicaSet(resourceName, namespace) owner = await kubectl.getNewReplicaSet(resourceName);
} }
const commandExecutionResults = [] const commandExecutionResults = [];
if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences;
if (owners) {
for (const ownerRef of owners) {
if (ownerRef.name === owner) {
commandExecutionResults.push(
kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr)
);
break;
}
}
}
});
}
let allPods return await Promise.all(commandExecutionResults);
try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout)
} catch (e) {
core.debug(`Unable to parse pods: ${e}`)
}
if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences
if (owners) {
for (const ownerRef of owners) {
if (ownerRef.name === owner) {
commandExecutionResults.push(
kubectl.annotate(
'pod',
pod.metadata.name,
annotationKeyValStr,
namespace
)
)
break
}
}
}
})
}
return await Promise.all(commandExecutionResults)
} }
+31 -35
View File
@@ -1,48 +1,44 @@
import {KubernetesWorkload} from '../types/kubernetesTypes' import { KubernetesWorkload } from "../types/kubernetesTypes";
export function getImagePullSecrets(inputObject: any) { export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null if (!inputObject?.spec) return null;
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase() )
) return inputObject?.spec?.jobTemplate?.spec?.template?.spec
return inputObject?.spec?.jobTemplate?.spec?.template?.spec ?.imagePullSecrets;
?.imagePullSecrets
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets return inputObject.spec.imagePullSecrets;
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets return inputObject.spec.template.spec.imagePullSecrets;
} }
} }
export function setImagePullSecrets( export function setImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: any newImagePullSecrets: any
) { ) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return if (!inputObject || !inputObject.spec || !newImagePullSecrets) return;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.spec.imagePullSecrets = newImagePullSecrets;
) { return;
inputObject.spec.imagePullSecrets = newImagePullSecrets }
return
}
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase() ) {
) { if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec) inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = newImagePullSecrets;
newImagePullSecrets return;
return }
}
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
return return;
} }
} }
+45 -47
View File
@@ -1,73 +1,71 @@
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
export function updateSpecLabels( export function updateSpecLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) throw InputObjectKindNotDefinedError if (!inputObject.kind) throw InputObjectKindNotDefinedError;
if (!newLabels) return if (!newLabels) return;
let existingLabels = getSpecLabels(inputObject) let existingLabels = getSpecLabels(inputObject);
if (override) { if (override) {
existingLabels = newLabels existingLabels = newLabels;
} else { } else {
existingLabels = existingLabels || new Map<string, string>() existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
} }
setSpecLabels(inputObject, existingLabels) setSpecLabels(inputObject, existingLabels);
} }
function getSpecLabels(inputObject: any) { function getSpecLabels(inputObject: any) {
if (!inputObject) return null if (!inputObject) return null;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels return inputObject.metadata.labels;
if (inputObject?.spec?.template?.metadata) if (inputObject?.spec?.template?.metadata)
return inputObject.spec.template.metadata.labels return inputObject.spec.template.metadata.labels;
return null return null;
} }
function setSpecLabels(inputObject: any, newLabels: any) { function setSpecLabels(inputObject: any, newLabels: any) {
if (!inputObject || !newLabels) return null if (!inputObject || !newLabels) return null;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.metadata.labels = newLabels;
) { return;
inputObject.metadata.labels = newLabels }
return
}
if (inputObject?.spec?.template?.metatada) { if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels inputObject.spec.template.metatada.labels = newLabels;
return return;
} }
} }
export function getSpecSelectorLabels(inputObject: any) { export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector;
else return inputObject.spec.selector.matchLabels else return inputObject.spec.selector.matchLabels;
} }
} }
export function setSpecSelectorLabels(inputObject: any, newLabels: any) { export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels inputObject.spec.selector = newLabels;
else inputObject.spec.selector.matchLabels = newLabels else inputObject.spec.selector.matchLabels = newLabels;
} }
} }
@@ -1,52 +0,0 @@
import * as manifestStabilityUtils from './manifestStabilityUtils'
import {Kubectl} from '../types/kubectl'
import {ResourceTypeFleet, ResourceTypeManagedCluster} from '../actions/deploy'
import {ExecOutput} from '@actions/exec'
import {exitCode, stdout} from 'process'
describe('manifestStabilityUtils', () => {
const kc = new Kubectl('')
const resources = [
{
type: 'deployment',
name: 'test',
namespace: 'default'
}
]
it('should return immediately if the resource type is fleet', async () => {
const spy = jest.spyOn(manifestStabilityUtils, 'checkManifestStability')
const checkRolloutStatusSpy = jest.spyOn(kc, 'checkRolloutStatus')
await manifestStabilityUtils.checkManifestStability(
kc,
resources,
ResourceTypeFleet
)
expect(checkRolloutStatusSpy).not.toHaveBeenCalled()
expect(spy).toHaveReturned()
})
it('should run fully if the resource type is managedCluster', async () => {
const spy = jest.spyOn(manifestStabilityUtils, 'checkManifestStability')
const checkRolloutStatusSpy = jest
.spyOn(kc, 'checkRolloutStatus')
.mockImplementation(() => {
return new Promise<ExecOutput>((resolve, reject) => {
resolve({
exitCode: 0,
stderr: '',
stdout: ''
})
})
})
await manifestStabilityUtils.checkManifestStability(
kc,
resources,
ResourceTypeManagedCluster
)
expect(checkRolloutStatusSpy).toHaveBeenCalled()
expect(spy).toHaveReturned()
})
})
+184 -220
View File
@@ -1,220 +1,184 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
import {sleep} from './timeUtils' import { sleep } from "./timeUtils";
import {ResourceTypeFleet} from '../actions/deploy'
import {ClusterType} from '../inputUtils' export async function checkManifestStability(
kubectl: Kubectl,
const IS_SILENT = false resources: Resource[]
const POD = 'pod' ): Promise<void> {
let rolloutStatusHasErrors = false;
export async function checkManifestStability( for (let i = 0; i < resources.length; i++) {
kubectl: Kubectl, const resource = resources[i];
resources: Resource[],
resourceType: ClusterType if (
): Promise<void> { KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
// Skip if resource type is microsoft.containerservice/fleets resource.type.toLowerCase()
if (resourceType === ResourceTypeFleet) { ) >= 0
core.info(`Skipping checkManifestStability for ${ResourceTypeFleet}`) ) {
return try {
} const result = await kubectl.checkRolloutStatus(
let rolloutStatusHasErrors = false resource.type,
for (let i = 0; i < resources.length; i++) { resource.name
const resource = resources[i] );
checkForErrors([result]);
if ( } catch (ex) {
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf( core.error(ex);
resource.type.toLowerCase() await kubectl.describe(resource.type, resource.name);
) >= 0 rolloutStatusHasErrors = true;
) { }
try { }
const result = await kubectl.checkRolloutStatus(
resource.type, if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
resource.name, try {
resource.namespace await checkPodStatus(kubectl, resource.name);
) } catch (ex) {
checkForErrors([result]) core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`);
} catch (ex) { await kubectl.describe(resource.type, resource.name);
core.error(ex) }
await kubectl.describe( }
resource.type, if (
resource.name, resource.type ==
IS_SILENT, KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
resource.namespace ) {
) try {
rolloutStatusHasErrors = true const service = await getService(kubectl, resource.name);
} const { spec, status } = service;
} if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
if (!isLoadBalancerIPAssigned(status)) {
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) { await waitForServiceExternalIPAssignment(kubectl, resource.name);
try { } else {
await checkPodStatus(kubectl, resource) core.info(
} catch (ex) { `ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
core.warning( );
`Could not determine pod status: ${JSON.stringify(ex)}` }
) }
await kubectl.describe( } catch (ex) {
resource.type, core.warning(
resource.name, `Could not determine service status of: ${resource.name} Error: ${ex}`
IS_SILENT, );
resource.namespace await kubectl.describe(resource.type, resource.name);
) }
} }
} }
if (
resource.type == if (rolloutStatusHasErrors) {
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE throw new Error("Rollout status error");
) { }
try { }
const service = await getService(kubectl, resource)
const {spec, status} = service export async function checkPodStatus(
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) { kubectl: Kubectl,
if (!isLoadBalancerIPAssigned(status)) { podName: string
await waitForServiceExternalIPAssignment(kubectl, resource) ): Promise<void> {
} else { const sleepTimeout = 10 * 1000; // 10 seconds
core.info( const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
) let podStatus;
} let kubectlDescribeNeeded = false;
} for (let i = 0; i < iterations; i++) {
} catch (ex) { await sleep(sleepTimeout);
core.warning(
`Could not determine service status of: ${resource.name} Error: ${ex}` core.debug(`Polling for pod status: ${podName}`);
) podStatus = await getPodStatus(kubectl, podName);
await kubectl.describe(
resource.type, if (
resource.name, podStatus &&
IS_SILENT, podStatus?.phase !== "Pending" &&
resource.namespace podStatus?.phase !== "Unknown"
) ) {
} break;
} }
} }
if (rolloutStatusHasErrors) { podStatus = await getPodStatus(kubectl, podName);
throw new Error('Rollout status error') switch (podStatus.phase) {
} case "Succeeded":
} case "Running":
if (isPodReady(podStatus)) {
export async function checkPodStatus( console.log(`pod/${podName} is successfully rolled out`);
kubectl: Kubectl, } else {
pod: Resource kubectlDescribeNeeded = true;
): Promise<void> { }
const sleepTimeout = 10 * 1000 // 10 seconds break;
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout case "Pending":
if (!isPodReady(podStatus)) {
let podStatus core.warning(`pod/${podName} rollout status check timed out`);
let kubectlDescribeNeeded = false kubectlDescribeNeeded = true;
for (let i = 0; i < iterations; i++) { }
await sleep(sleepTimeout) break;
case "Failed":
core.debug(`Polling for pod status: ${pod.name}`) core.error(`pod/${podName} rollout failed`);
podStatus = await getPodStatus(kubectl, pod) kubectlDescribeNeeded = true;
break;
if ( default:
podStatus && core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
podStatus?.phase !== 'Pending' && }
podStatus?.phase !== 'Unknown'
) { if (kubectlDescribeNeeded) {
break await kubectl.describe("pod", podName);
} }
} }
podStatus = await getPodStatus(kubectl, pod) async function getPodStatus(kubectl: Kubectl, podName: string) {
switch (podStatus.phase) { const podResult = await kubectl.getResource("pod", podName);
case 'Succeeded': checkForErrors([podResult]);
case 'Running':
if (isPodReady(podStatus)) { return JSON.parse(podResult.stdout).status;
console.log(`pod/${pod.name} is successfully rolled out`) }
} else {
kubectlDescribeNeeded = true function isPodReady(podStatus: any): boolean {
} let allContainersAreReady = true;
break podStatus.containerStatuses.forEach((container) => {
case 'Pending': if (container.ready === false) {
if (!isPodReady(podStatus)) { core.info(
core.warning(`pod/${pod.name} rollout status check timed out`) `'${container.name}' status: ${JSON.stringify(container.state)}`
kubectlDescribeNeeded = true );
} allContainersAreReady = false;
break }
case 'Failed': });
core.error(`pod/${pod.name} rollout failed`)
kubectlDescribeNeeded = true if (!allContainersAreReady) {
break core.warning("All containers not in ready state");
default: }
core.warning(`pod/${pod.name} rollout status: ${podStatus.phase}`)
} return allContainersAreReady;
}
if (kubectlDescribeNeeded) {
await kubectl.describe(POD, pod.name, IS_SILENT, pod.namespace) async function getService(kubectl: Kubectl, serviceName) {
} const serviceResult = await kubectl.getResource(
} KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
serviceName
async function getPodStatus(kubectl: Kubectl, pod: Resource) { );
const podResult = await kubectl.getResource(
POD, checkForErrors([serviceResult]);
pod.name, return JSON.parse(serviceResult.stdout);
IS_SILENT, }
pod.namespace
) async function waitForServiceExternalIPAssignment(
checkForErrors([podResult]) kubectl: Kubectl,
serviceName: string
return JSON.parse(podResult.stdout).status ): Promise<void> {
} const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout
function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true for (let i = 0; i < iterations; i++) {
podStatus.containerStatuses.forEach((container) => { core.info(`Wait for service ip assignment : ${serviceName}`);
if (container.ready === false) { await sleep(sleepTimeout);
core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}` const status = (await getService(kubectl, serviceName)).status;
) if (isLoadBalancerIPAssigned(status)) {
allContainersAreReady = false core.info(
} `ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
}) );
return;
if (!allContainersAreReady) { }
core.warning('All containers not in ready state') }
}
core.warning(`Wait for service ip assignment timed out${serviceName}`);
return allContainersAreReady }
}
function isLoadBalancerIPAssigned(status: any) {
async function getService(kubectl: Kubectl, service: Resource) { return status?.loadBalancer?.ingress?.length > 0;
const serviceResult = await kubectl.getResource( }
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
service.name,
IS_SILENT,
service.namespace
)
checkForErrors([serviceResult])
return JSON.parse(serviceResult.stdout)
}
async function waitForServiceExternalIPAssignment(
kubectl: Kubectl,
service: Resource
): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
for (let i = 0; i < iterations; i++) {
core.info(`Wait for service ip assignment : ${service.name}`)
await sleep(sleepTimeout)
const status = (await getService(kubectl, service)).status
if (isLoadBalancerIPAssigned(status)) {
core.info(
`ServiceExternalIP ${service.name} ${status.loadBalancer.ingress[0].ip}`
)
return
}
}
core.warning(`Wait for service ip assignment timed out ${service.name}`)
}
function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0
}
-28
View File
@@ -1,28 +0,0 @@
import * as fileUtils from './fileUtils'
import * as manifestUpdateUtils from './manifestUpdateUtils'
import * as path from 'path'
import * as fs from 'fs'
describe('manifestUpdateUtils', () => {
jest.spyOn(fileUtils, 'moveFileToTmpDir').mockImplementation((filename) => {
return path.join('/tmp', filename)
})
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
return 'test contents'
})
it('should place all files within the temp dir with the same path that they have in the repo', () => {
const originalFilePaths: string[] = [
'path/in/repo/test.txt',
'path/deeper/in/repo/test.txt'
]
const expected: string[] = [
'/tmp/path/in/repo/test.txt',
'/tmp/path/deeper/in/repo/test.txt'
]
const newFilePaths =
manifestUpdateUtils.moveFilesToTmpDir(originalFilePaths)
expect(newFilePaths).toEqual(expected)
})
})
+310 -332
View File
@@ -1,332 +1,310 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as path from 'path' import * as path from "path";
import * as fileHelper from './fileUtils' import * as fileHelper from "./fileUtils";
import {moveFileToTmpDir} from './fileUtils' import { getTempDirectory } from "./fileUtils";
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError, InputObjectMetadataNotDefinedError,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
import { import {
getSpecSelectorLabels, getSpecSelectorLabels,
setSpecSelectorLabels setSpecSelectorLabels,
} from './manifestSpecLabelUtils' } from "./manifestSpecLabelUtils";
import { import {
getImagePullSecrets, getImagePullSecrets,
setImagePullSecrets setImagePullSecrets,
} from './manifestPullSecretUtils' } from "./manifestPullSecretUtils";
import {Resource} from '../types/kubectl' import { Resource } from "../types/kubectl";
import {K8sObject} from '../types/k8sObject'
export function updateManifestFiles(manifestFilePaths: string[]) {
export function updateManifestFiles(manifestFilePaths: string[]) { if (manifestFilePaths?.length === 0) {
if (manifestFilePaths?.length === 0) { throw new Error("Manifest files not provided");
throw new Error('Manifest files not provided') }
}
// update container images
// move original set of input files to tmp dir const containers: string[] = core.getInput("images").split("\n");
const manifestFilesInTempDir = moveFilesToTmpDir(manifestFilePaths) const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths,
// update container images containers
const containers: string[] = core.getInput('images').split('\n') );
const manifestFiles = updateContainerImagesInManifestFiles( // update pull secrets
manifestFilesInTempDir, const imagePullSecrets: string[] = core
containers .getInput("imagepullsecrets")
) .split("\n")
.filter((secret) => secret.trim().length > 0);
// update pull secrets return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets);
const imagePullSecrets: string[] = core }
.getInput('imagepullsecrets')
.split('\n') export function UnsetClusterSpecificDetails(resource: any) {
.filter((secret) => secret.trim().length > 0) if (!resource) {
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets) return;
} }
export function moveFilesToTmpDir(filepaths: string[]): string[] { // Unset cluster specific details in the object
return filepaths.map((filename) => { if (!!resource) {
return moveFileToTmpDir(filename) const { metadata, status } = resource;
})
} if (!!metadata) {
resource.metadata = {
export function UnsetClusterSpecificDetails(resource: any) { annotations: metadata.annotations,
if (!resource) { labels: metadata.labels,
return name: metadata.name,
} };
}
// Unset cluster specific details in the object
if (!!resource) { if (!!status) {
const {metadata, status} = resource resource.status = {};
}
if (!!metadata) { }
resource.metadata = { }
annotations: metadata.annotations,
labels: metadata.labels, function updateContainerImagesInManifestFiles(
name: metadata.name filePaths: string[],
} containers: string[]
} ): string[] {
if (filePaths?.length <= 0) return filePaths;
if (!!status) {
resource.status = {} const newFilePaths = [];
}
} // update container images
} filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString();
function updateContainerImagesInManifestFiles(
filePaths: string[], containers.forEach((container: string) => {
containers: string[] let [imageName] = container.split(":");
): string[] { if (imageName.indexOf("@") > 0) {
if (filePaths?.length <= 0) return filePaths imageName = imageName.split("@")[0];
}
// update container images
filePaths.forEach((filePath: string) => { if (contents.indexOf(imageName) > 0)
let contents = fs.readFileSync(filePath).toString() contents = substituteImageNameInSpecFile(
containers.forEach((container: string) => { contents,
let [imageName] = container.split(':') imageName,
if (imageName.indexOf('@') > 0) { container
imageName = imageName.split('@')[0] );
} });
if (contents.indexOf(imageName) > 0) // write updated files
contents = substituteImageNameInSpecFile( const tempDirectory = getTempDirectory();
contents, const fileName = path.join(tempDirectory, path.basename(filePath));
imageName, fs.writeFileSync(path.join(fileName), contents);
container newFilePaths.push(fileName);
) });
})
return newFilePaths;
// write updated files }
fs.writeFileSync(path.join(filePath), contents)
}) /*
Example:
return filePaths
} Input of
currentString: `image: "example/example-image"`
/* imageName: `example/example-image`
Example: imageNameWithNewTag: `example/example-image:identifiertag`
Input of would return
currentString: `image: "example/example-image"` `image: "example/example-image:identifiertag"`
imageName: `example/example-image` */
imageNameWithNewTag: `example/example-image:identifiertag` export function substituteImageNameInSpecFile(
spec: string,
would return imageName: string,
`image: "example/example-image:identifiertag"` imageNameWithNewTag: string
*/ ) {
export function substituteImageNameInSpecFile( if (spec.indexOf(imageName) < 0) return spec;
spec: string,
imageName: string, return spec.split("\n").reduce((acc, line) => {
imageNameWithNewTag: string const imageKeyword = line.match(/^ *-? *image:/);
) { if (imageKeyword) {
if (spec.indexOf(imageName) < 0) return spec let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards
return spec.split('\n').reduce((acc, line) => { .trim()
const imageKeyword = line.match(/^ *-? *image:/) .replace(/[',"]/g, "") // replace allowed quotes with nothing
if (imageKeyword) { .split(":");
let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards if (currentImageName?.indexOf(" ") > 0) {
.trim() currentImageName = currentImageName.split(" ")[0]; // remove comments
.replace(/[',"]/g, '') // replace allowed quotes with nothing }
.split(':')
if (currentImageName === imageName) {
if (currentImageName?.indexOf(' ') > 0) { return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
currentImageName = currentImageName.split(' ')[0] // remove comments }
} }
if (currentImageName === imageName) { return acc + line + "\n";
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n` }, "");
} }
}
export function getReplicaCount(inputObject: any): any {
return acc + line + '\n' if (!inputObject) throw NullInputObjectError;
}, '')
} if (!inputObject.kind) {
throw InputObjectKindNotDefinedError;
export function getReplicaCount(inputObject: any): any { }
if (!inputObject) throw NullInputObjectError
const { kind } = inputObject;
if (!inputObject.kind) { if (
throw InputObjectKindNotDefinedError kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
} kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
)
const {kind} = inputObject return inputObject.spec.replicas;
if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && return 0;
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() }
)
return inputObject.spec.replicas export function updateObjectLabels(
inputObject: any,
return 0 newLabels: Map<string, string>,
} override: boolean = false
) {
export function updateObjectLabels( if (!inputObject) throw NullInputObjectError;
inputObject: any,
newLabels: Map<string, string>, if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
override: boolean = false
) { if (!newLabels) return;
if (!inputObject) throw NullInputObjectError
if (override) {
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError inputObject.metadata.labels = newLabels;
} else {
if (!newLabels) return let existingLabels =
inputObject.metadata.labels || new Map<string, string>();
if (override) {
inputObject.metadata.labels = newLabels Object.keys(newLabels).forEach(
} else { (key) => (existingLabels[key] = newLabels[key])
let existingLabels = );
inputObject.metadata.labels || new Map<string, string>()
inputObject.metadata.labels = existingLabels;
Object.keys(newLabels).forEach( }
(key) => (existingLabels[key] = newLabels[key]) }
)
export function updateObjectAnnotations(
inputObject.metadata.labels = existingLabels inputObject: any,
} newAnnotations: Map<string, string>,
} override: boolean = false
) {
export function updateObjectAnnotations( if (!inputObject) throw NullInputObjectError;
inputObject: any,
newAnnotations: Map<string, string>, if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
override: boolean = false
) { if (!newAnnotations) return;
if (!inputObject) throw NullInputObjectError
if (override) {
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError inputObject.metadata.annotations = newAnnotations;
} else {
if (!newAnnotations) return const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>();
if (override) {
inputObject.metadata.annotations = newAnnotations Object.keys(newAnnotations).forEach(
} else { (key) => (existingAnnotations[key] = newAnnotations[key])
const existingAnnotations = );
inputObject.metadata.annotations || new Map<string, string>()
inputObject.metadata.annotations = existingAnnotations;
Object.keys(newAnnotations).forEach( }
(key) => (existingAnnotations[key] = newAnnotations[key]) }
)
export function updateImagePullSecrets(
inputObject.metadata.annotations = existingAnnotations inputObject: any,
} newImagePullSecrets: string[],
} override: boolean = false
) {
export function updateImagePullSecrets( if (!inputObject?.spec || !newImagePullSecrets) return;
inputObject: any,
newImagePullSecrets: string[], const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => {
override: boolean = false return { name };
) { });
if (!inputObject?.spec || !newImagePullSecrets) return let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
const newImagePullSecretsObjects = Array.from( if (override) {
newImagePullSecrets, existingImagePullSecretObjects = newImagePullSecretsObjects;
(name) => { } else {
return {name} existingImagePullSecretObjects = existingImagePullSecretObjects || [];
}
) existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject) newImagePullSecretsObjects
);
if (override) { }
existingImagePullSecretObjects = newImagePullSecretsObjects
} else { setImagePullSecrets(inputObject, existingImagePullSecretObjects);
existingImagePullSecretObjects = existingImagePullSecretObjects || [] }
existingImagePullSecretObjects = existingImagePullSecretObjects.concat( export function updateSelectorLabels(
newImagePullSecretsObjects inputObject: any,
) newLabels: Map<string, string>,
} override: boolean
) {
setImagePullSecrets(inputObject, existingImagePullSecretObjects) if (!inputObject) throw NullInputObjectError;
}
if (!inputObject.kind) throw InputObjectKindNotDefinedError;
export function updateSelectorLabels(
inputObject: any, if (!newLabels) return;
newLabels: Map<string, string>,
override: boolean if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
) { return;
if (!inputObject) throw NullInputObjectError
let existingLabels = getSpecSelectorLabels(inputObject);
if (!inputObject.kind) throw InputObjectKindNotDefinedError if (override) {
existingLabels = newLabels;
if (!newLabels) return } else {
existingLabels = existingLabels || new Map<string, string>();
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) Object.keys(newLabels).forEach(
return (key) => (existingLabels[key] = newLabels[key])
);
let existingLabels = getSpecSelectorLabels(inputObject) }
if (override) {
existingLabels = newLabels setSpecSelectorLabels(inputObject, existingLabels);
} else { }
existingLabels = existingLabels || new Map<string, string>()
Object.keys(newLabels).forEach( export function getResources(
(key) => (existingLabels[key] = newLabels[key]) filePaths: string[],
) filterResourceTypes: string[]
} ): Resource[] {
if (!filePaths) return [];
setSpecSelectorLabels(inputObject, existingLabels)
} const resources: Resource[] = [];
filePaths.forEach((filePath: string) => {
export function getResources( const fileContents = fs.readFileSync(filePath).toString();
filePaths: string[], yaml.safeLoadAll(fileContents, (inputObject) => {
filterResourceTypes: string[] const inputObjectKind = inputObject?.kind || "";
): Resource[] { if (
if (!filePaths) return [] filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
const resources: Resource[] = [] ).length > 0
filePaths.forEach((filePath: string) => { ) {
try { resources.push({
const fileContents = fs.readFileSync(filePath).toString() type: inputObject.kind,
const inputObjects: K8sObject[] = yaml.loadAll( name: inputObject.metadata.name,
fileContents });
) as K8sObject[] }
inputObjects.forEach((inputObject) => { });
const inputObjectKind = inputObject?.kind || '' });
if (
filterResourceTypes.filter( return resources;
(type) => inputObjectKind.toLowerCase() === type.toLowerCase() }
).length > 0
) { function updateImagePullSecretsInManifestFiles(
resources.push({ filePaths: string[],
type: inputObject.kind, imagePullSecrets: string[]
name: inputObject.metadata.name, ): string[] {
namespace: inputObject?.metadata?.namespace if (imagePullSecrets?.length <= 0) return filePaths;
})
} const newObjectsList = [];
}) filePaths.forEach((filePath: string) => {
} catch (error) { const fileContents = fs.readFileSync(filePath).toString();
core.error(`Failed to process file at ${filePath}: ${error.message}`) yaml.safeLoadAll(fileContents, (inputObject: any) => {
throw error if (inputObject?.kind) {
} const { kind } = inputObject;
}) if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets);
return resources }
} newObjectsList.push(inputObject);
}
function updateImagePullSecretsInManifestFiles( });
filePaths: string[], });
imagePullSecrets: string[]
): string[] { return fileHelper.writeObjectsToFile(newObjectsList);
if (imagePullSecrets?.length <= 0) return filePaths }
const newObjectsList = []
filePaths.forEach((filePath: string) => {
try {
const fileContents = fs.readFileSync(filePath).toString()
yaml.loadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) {
const {kind} = inputObject
if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets)
}
newObjectsList.push(inputObject)
}
})
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
})
return fileHelper.writeObjectsToFile(newObjectsList)
}
+2 -2
View File
@@ -1,7 +1,7 @@
export function sleep(timeout: number) { export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout)) return new Promise((resolve) => setTimeout(resolve, timeout));
} }
export function getCurrentTime(): number { export function getCurrentTime(): number {
return new Date().getTime() return new Date().getTime();
} }
+11 -11
View File
@@ -1,18 +1,18 @@
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
const trafficSplitAPIVersionPrefix = 'split.smi-spec.io' const trafficSplitAPIVersionPrefix = "split.smi-spec.io";
export async function getTrafficSplitAPIVersion( export async function getTrafficSplitAPIVersion(
kubectl: Kubectl kubectl: Kubectl
): Promise<string> { ): Promise<string> {
const result = await kubectl.executeCommand('api-versions') const result = await kubectl.executeCommand("api-versions");
const trafficSplitAPIVersion = result.stdout const trafficSplitAPIVersion = result.stdout
.split('\n') .split("\n")
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix)) .find((version) => version.startsWith(trafficSplitAPIVersionPrefix));
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
throw new Error('Unable to find traffic split api version') throw new Error("Unable to find traffic split api version");
} }
return trafficSplitAPIVersion return trafficSplitAPIVersion;
} }
+17 -32
View File
@@ -1,33 +1,18 @@
import { import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils";
cleanLabel,
removeInvalidLabelCharacters,
VALID_LABEL_REGEX
} from '../utilities/workflowAnnotationUtils'
describe('WorkflowAnnotationUtils', () => { describe("WorkflowAnnotationUtils", () => {
describe('cleanLabel', () => { describe("prefixObjectKeys", () => {
it('should clean label', () => { it("should prefix an object with a given prefix", () => {
const alreadyClean = 'alreadyClean' const obj = {
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean) foo: "bar",
expect(cleanLabel('.startInvalid')).toEqual('startInvalid') baz: "qux",
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual( };
'withS0MEinvalidchars' const prefix = "prefix.";
) const expected = {
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji') "prefix.foo": "bar",
}) "prefix.baz": "qux",
it('should remove slashes from label', () => { };
expect( expect(prefixObjectKeys(obj, prefix)).toEqual(expected);
cleanLabel('Workflow Name / With Slashes / And Spaces') });
).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces') });
}) });
it('should return a blank string when regex fails (https://github.com/Azure/k8s-deploy/issues/266)', () => {
const label = '持续部署'
expect(cleanLabel(label)).toEqual('github-workflow-file')
let removedInvalidChars = removeInvalidLabelCharacters(label)
const regexResult = VALID_LABEL_REGEX.exec(removedInvalidChars)
expect(regexResult).toBe(null)
})
})
})

Some files were not shown because too many files have changed in this diff Show More