Compare commits

..

16 Commits

Author SHA1 Message Date
David Gamero da331a158c Update codeql.yml 2024-03-19 12:57:22 -04:00
David Gamero e08fe4d10f Update CHANGELOG.md 2024-03-19 12:55:59 -04:00
David Gamero 159ed4c2e2 Update CHANGELOG.md 2024-03-19 12:55:04 -04:00
David Gamero e394a363ea Update codeql.yml 2024-03-19 12:41:03 -04:00
David Gamero 9a3f9b33d4 update the current tags 2024-03-12 17:01:59 -04:00
David Gamero 2deb54c5d3 format 2024-03-12 15:23:18 -04:00
David Gamero f0b74d1da1 Update codeql.yml 2024-03-12 15:20:14 -04:00
David Gamero 0767161214 Update codeql.yml 2024-03-12 15:18:05 -04:00
David Gamero ee4689b033 Update codeql.yml 2024-03-12 15:14:05 -04:00
David Gamero 103b5ccfa2 Update codeql.yml 2024-03-12 11:36:09 -04:00
David Gamero 209431e7c0 format 2024-03-12 11:09:35 -04:00
David Gamero 18f9d6f27c Update CHANGELOG.md 2024-03-12 11:08:25 -04:00
David Gamero f9cf4e2ef6 Update CHANGELOG.md 2024-03-12 11:08:10 -04:00
David Gamero db9a5aa2d4 Update CHANGELOG.md 2024-03-12 11:07:40 -04:00
David Gamero f7415623aa Update release-pr.yml 2024-03-12 11:05:47 -04:00
David Gamero 43974c78e2 Update package.json 2024-03-12 11:03:38 -04:00
48 changed files with 8156 additions and 23843 deletions
-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:
- '*'
+4 -4
View File
@@ -16,7 +16,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
@@ -24,7 +24,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
uses: github/codeql-action/init@05963f47d870e2cb19a537396c1f668a348c7d8f #v3.24.8
# Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java
@@ -32,7 +32,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
uses: github/codeql-action/autobuild@05963f47d870e2cb19a537396c1f668a348c7d8f #v3.24.8
# ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
@@ -46,4 +46,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
uses: github/codeql-action/analyze@05963f47d870e2cb19a537396c1f668a348c7d8f #v3.24.8
+2 -2
View File
@@ -13,7 +13,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
- uses: actions/stale@v3
name: Setting issue as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
@@ -24,7 +24,7 @@ jobs:
operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
- uses: actions/stale@v3
name: Setting PR as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
+4 -4
View File
@@ -10,9 +10,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: install deps
run: npm install
uses: actions/checkout@v2
- name: Enforce Prettier
run: npm run format-check
uses: actionsx/prettier@v2
with:
args: --check .
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,22 +31,22 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.24.0
kubernetes-version: 1.22.3
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -64,13 +64,9 @@ jobs:
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
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,22 +31,22 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.31.2
kubernetes-version: 1.22.3
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,22 +31,22 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.31.2
kubernetes-version: 1.22.3
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,24 +31,23 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.24.0
kubernetes-version: 1.22.3
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 --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install | sh
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
export PATH=$PATH:/home/runner/.linkerd2/bin
linkerd install --crds | kubectl apply -f -
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
@@ -57,7 +56,7 @@ jobs:
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,22 +31,22 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.24.0
kubernetes-version: 1.22.3
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,21 +31,23 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.24.0
kubernetes-version: 1.22.3
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
- name: Install linkerd and add controlplane to cluster
run: |
curl --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install | sh
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
export PATH=$PATH:/home/runner/.linkerd2/bin
linkerd install --crds | kubectl apply -f -
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
@@ -54,7 +56,7 @@ jobs:
- name: Create namespace to run tests
run: kubectl create ns ${{ env.NAMESPACE }}
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -11,7 +11,7 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
@@ -19,7 +19,7 @@ jobs:
contents: read
id-token: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -30,20 +30,20 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- name: Azure login
uses: azure/login@v2.3.0
uses: azure/login@v1.4.3
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
- uses: Azure/setup-kubectl@v3
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 group create --location eastus --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 }}
@@ -51,7 +51,7 @@ jobs:
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
@@ -63,7 +63,6 @@ jobs:
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 }}
@@ -74,9 +73,6 @@ jobs:
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: |
@@ -13,12 +13,12 @@ on:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
NAMESPACE: test-${{ github.run_id }}
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- name: Install dependencies
run: |
@@ -31,22 +31,22 @@ jobs:
- name: Build
run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
- uses: Azure/setup-kubectl@v3
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
uses: medyagh/setup-minikube@latest
with:
minikube-version: 1.34.0
kubernetes-version: 1.31.0
minikube-version: 1.24.0
kubernetes-version: 1.22.3
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
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
+1 -1
View File
@@ -14,7 +14,7 @@ jobs:
name: Run Unit Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/checkout@v3
- run: |
npm install
npm test
+1
View File
@@ -2,5 +2,6 @@ node_modules
.DS_Store
.idea
lib/
coverage/
+14 -26
View File
@@ -1,40 +1,28 @@
# Changelog
## [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
- #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
- #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
- #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
+3 -3
View File
@@ -4,6 +4,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+14 -18
View File
@@ -17,22 +17,22 @@ permissions:
Following are the key capabilities of this action:
- **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.
- **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.
- **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.
- **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.
- **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.
- **Deployment strategy** Supports both canary and blue-green deployment strategies
- **Deployment strategy** Supports both canary and blue-green deployment strategies
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
- **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.
- **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:
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
- **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.
- **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:
- **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.
- **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.
- **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.
- **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.
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.
@@ -125,10 +125,6 @@ Following are the key capabilities of this action:
<td>skip-tls-verify</br></br>(Optional)</td>
<td>Acceptable values: true/false</br>Default value: false</br>True if the insecure-skip-tls-verify option should be used</td>
</tr>
<tr>
<td>resource-type (Optional)</td>
<td>Acceptable values: `Microsoft.ContainerService/managedClusters` (default), 'Microsoft.ContainerService/fleets'</td>
</tr>
</table>
## Usage Examples
@@ -466,9 +462,9 @@ jobs:
## 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.
- 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
+7 -7
View File
@@ -14,13 +14,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
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.)
- 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)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue
- 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
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
-4
View File
@@ -80,10 +80,6 @@ inputs:
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'
-6
View File
@@ -1,6 +0,0 @@
module.exports = {
presets: [
['@babel/preset-env', {targets: {node: 'current'}}],
'@babel/preset-typescript'
]
}
+2 -11
View File
@@ -1,20 +1,11 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
'\\.[jt]sx?$': 'babel-jest'
'^.+\\.ts$': 'ts-jest'
},
transformIgnorePatterns: [
'node_modules/(?!' +
[
'@octokit',
'universal-user-agent',
'before-after-hook',
'minimist'
].join('|') +
')'
],
verbose: true,
testTimeout: 9000
}
-17984
View File
File diff suppressed because it is too large Load Diff
+7613 -4943
View File
File diff suppressed because it is too large Load Diff
+16 -20
View File
@@ -4,7 +4,7 @@
"author": "Deepak Sattiraju",
"license": "MIT",
"scripts": {
"prebuild": "npm i @vercel/ncc",
"prebuild": "npm i @ncc/vercel",
"build": "ncc build src/run.ts -o lib",
"test": "jest",
"coverage": "jest --coverage=true",
@@ -12,27 +12,23 @@
"format-check": "prettier --check ."
},
"dependencies": {
"@actions/core": "^1.11.1",
"@actions/core": "^1.10.0",
"@actions/exec": "^1.0.0",
"@actions/io": "^1.1.3",
"@actions/tool-cache": "2.0.2",
"@babel/preset-env": "^7.26.9",
"@babel/preset-typescript": "^7.27.0",
"@octokit/core": "^6.1.4",
"@octokit/plugin-retry": "^7.2.0",
"@types/minipass": "^3.3.5",
"js-yaml": "4.1.0",
"minimist": "^1.2.8"
"@actions/io": "^1.0.0",
"@actions/tool-cache": "1.1.2",
"@octokit/core": "^3.5.1",
"@octokit/plugin-retry": "^3.0.9",
"@types/minipass": "^3.1.2",
"js-yaml": "3.13.1"
},
"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"
"@types/jest": "^26.0.0",
"@types/js-yaml": "^3.12.7",
"@types/node": "^12.20.41",
"@vercel/ncc": "^0.36.1",
"jest": "^26.0.0",
"prettier": "^2.7.1",
"ts-jest": "^26.0.0",
"typescript": "3.9.5"
}
}
+1 -19
View File
@@ -13,12 +13,6 @@ import {
} from '../strategyHelpers/deploymentHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
export const ResourceTypeManagedCluster =
'Microsoft.ContainerService/managedClusters'
export const ResourceTypeFleet = 'Microsoft.ContainerService/fleets'
export type ClusterType =
| typeof ResourceTypeManagedCluster
| typeof ResourceTypeFleet
export async function deploy(
kubectl: Kubectl,
@@ -45,25 +39,13 @@ export async function deploy(
// check manifest stability
core.startGroup('Checking manifest stability')
const resourceTypeInput =
core.getInput('resource-type') || ResourceTypeManagedCluster
const resourceTypes: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
])
)
if (
resourceTypeInput !== ResourceTypeManagedCluster &&
resourceTypeInput !== ResourceTypeFleet
) {
let errMsg = `Invalid resource type: ${resourceTypeInput}. Supported resource types are: ${ResourceTypeManagedCluster} (default), ${ResourceTypeFleet}`
core.setFailed(errMsg)
throw new Error(errMsg)
}
await checkManifestStability(kubectl, resourceTypes, resourceTypeInput)
await checkManifestStability(kubectl, resourceTypes)
core.endGroup()
// print ingresses
+1 -16
View File
@@ -38,7 +38,6 @@ import {
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
import {ResourceTypeFleet, ResourceTypeManagedCluster} from './deploy'
export async function promote(
kubectl: Kubectl,
@@ -167,8 +166,6 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// checking stability of newly created deployments
core.startGroup('Checking manifest stability')
const resourceType =
core.getInput('resource-type') || ResourceTypeManagedCluster
const deployedManifestFiles = deployResult.manifestFiles
const resources: Resource[] = getResources(
deployedManifestFiles,
@@ -176,19 +173,7 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
models.DiscoveryAndLoadBalancerResource.SERVICE
])
)
if (
resourceType !== ResourceTypeManagedCluster &&
resourceType !== ResourceTypeFleet
) {
const errMsg = `Invalid resource type: ${resourceType}. Supported resource types are: ${ResourceTypeManagedCluster} (default), fleet`
core.setFailed(errMsg)
throw new Error(errMsg)
}
await KubernetesManifestUtility.checkManifestStability(
kubectl,
resources,
resourceType
)
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
core.endGroup()
core.startGroup(
+3 -2
View File
@@ -26,8 +26,9 @@ export async function run() {
.map((manifest) => manifest.trim()) // remove surrounding whitespace
.filter((manifest) => manifest.length > 0) // remove any blanks
const fullManifestFilePaths =
await getFilesFromDirectoriesAndURLs(manifestFilePaths)
const fullManifestFilePaths = await getFilesFromDirectoriesAndURLs(
manifestFilePaths
)
const kubectlPath = await getKubectlPath()
const namespace = core.getInput('namespace') || 'default'
const isPrivateCluster =
@@ -77,26 +77,22 @@ export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
// Manifest objects per type. All resources should be parsed and
// organized before we can check if services are “routed” or not.
filePaths.forEach((filePath: string) => {
try {
const fileContents = fs.readFileSync(filePath).toString()
yaml.loadAll(fileContents, (inputObject: any) => {
if (!!inputObject) {
const kind = inputObject.kind
if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject)
} else if (isServiceEntity(kind)) {
serviceEntityList.push(inputObject)
} else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject)
} else {
otherEntitiesList.push(inputObject)
}
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) {
const kind = inputObject.kind
if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject)
} else if (isServiceEntity(kind)) {
serviceEntityList.push(inputObject)
} else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject)
} else {
otherEntitiesList.push(inputObject)
}
})
} catch (error) {
core.error(`Error processing file ${filePath}: ${error.message}`)
throw error
}
}
})
})
serviceEntityList.forEach((inputObject: any) => {
@@ -77,8 +77,9 @@ export async function createTrafficSplitObject(
): Promise<TrafficSplitObject> {
// cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion =
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
// retrieve annotations for TS object
const annotations = inputAnnotations
+15 -21
View File
@@ -211,31 +211,25 @@ async function cleanUpCanary(
const deletedFiles: string[] = []
for (const filePath of files) {
try {
const fileContents = fs.readFileSync(filePath).toString()
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
const parsedYaml = yaml.safeLoadAll(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)
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)
}
await deleteObject(kind, canaryObjectName, namespace)
await deleteObject(kind, baselineObjectName, namespace)
}
} catch (error) {
core.error(`Failed to process file ${filePath}: ${error.message}`)
throw error
}
}
+40 -64
View File
@@ -8,7 +8,6 @@ import * as canaryDeploymentHelper from './canaryHelper'
import {isDeploymentEntity} from '../../types/kubernetesTypes'
import {getReplicaCount} from '../../utilities/manifestUpdateUtils'
import {DeployResult} from '../../types/deployResult'
import {K8sObject} from '../../types/k8sObject'
export async function deployPodCanary(
filePaths: string[],
@@ -22,73 +21,50 @@ export async function deployPodCanary(
throw Error('Percentage must be between 0 and 100')
for (const filePath of filePaths) {
try {
const fileContents = fs.readFileSync(filePath, 'utf8')
const parsedYaml = yaml.loadAll(fileContents)
for (const inputObject of parsedYaml) {
if (
inputObject &&
typeof inputObject === 'object' &&
'metadata' in inputObject &&
'kind' in inputObject &&
'spec' in inputObject &&
typeof inputObject.metadata === 'object' &&
'name' in inputObject.metadata &&
typeof inputObject.metadata.name === 'string' &&
typeof inputObject.kind === 'string'
) {
const obj = inputObject as K8sObject
const name = obj.metadata.name
const kind = obj.kind
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (!onlyDeployStable && isDeploymentEntity(kind)) {
core.debug('Calculating replica count for canary')
const canaryReplicaCount = calculateReplicaCountForCanary(
obj,
percentage
if (!onlyDeployStable && isDeploymentEntity(kind)) {
core.debug('Calculating replica count for canary')
const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug('Replica count is ' + canaryReplicaCount)
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
// if there's already a stable object, deploy baseline as well
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
if (stableObject) {
core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects`
)
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
core.debug('Replica count is ' + canaryReplicaCount)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
obj,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
// if there's already a stable object, deploy baseline as well
const stableObject =
await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
if (stableObject) {
core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects`
)
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
core.debug(
'New baseline object: ' +
JSON.stringify(newBaselineObject)
)
newObjectsList.push(newBaselineObject)
}
} else {
// deploy non deployment entity or regular deployments for promote as they are
newObjectsList.push(obj)
}
core.debug(
'New baseline object: ' + JSON.stringify(newBaselineObject)
)
newObjectsList.push(newBaselineObject)
}
} else {
// deploy non deployment entity or regular deployments for promote as they are
newObjectsList.push(inputObject)
}
} catch (error) {
core.error(
`Failed to parse YAML file at ${filePath}: ${error.message}`
)
throw error
}
}
+127 -152
View File
@@ -11,7 +11,6 @@ import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
import {checkForErrors} from '../../utilities/kubectlUtils'
import {inputAnnotations} from '../../inputUtils'
import {DeployResult} from '../../types/deployResult'
import {K8sObject} from '../../types/k8sObject'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
@@ -37,68 +36,60 @@ export async function deploySMICanary(
const newObjectsList = []
for await (const filePath of filePaths) {
try {
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects: K8sObject[] = yaml.loadAll(
fileContents
) as K8sObject[]
for (const inputObject of inputObjects) {
const name = inputObject.metadata.name
const kind = inputObject.kind
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects = yaml.safeLoadAll(fileContents)
for (const inputObject of inputObjects) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (!onlyDeployStable && isDeploymentEntity(kind)) {
if (calculateReplicas) {
// calculate for each object
const percentage = parseInt(
core.getInput('percentage', {required: true})
)
canaryReplicaCount =
podCanaryHelper.calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug(`calculated replica count ${canaryReplicaCount}`)
}
core.debug('Creating canary object')
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
if (!onlyDeployStable && isDeploymentEntity(kind)) {
if (calculateReplicas) {
// calculate for each object
const percentage = parseInt(
core.getInput('percentage', {required: true})
)
canaryReplicaCount =
podCanaryHelper.calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug(`calculated replica count ${canaryReplicaCount}`)
}
core.debug('Creating canary object')
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
)
if (stableObject) {
core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects`
)
const newBaselineObject =
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment(
stableObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
)
if (stableObject) {
core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects`
)
const newBaselineObject =
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment(
stableObject,
canaryReplicaCount
)
newObjectsList.push(newBaselineObject)
}
} else if (isDeploymentEntity(kind)) {
core.debug(
`creating stable deployment with ${inputObject.spec.replicas} replicas`
)
const stableDeployment =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(stableDeployment)
} else {
// Update non deployment entity or stable deployment as it is
newObjectsList.push(inputObject)
newObjectsList.push(newBaselineObject)
}
} else if (isDeploymentEntity(kind)) {
core.debug(
`creating stable deployment with ${inputObject.spec.replicas} replicas`
)
const stableDeployment =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(stableDeployment)
} else {
// Update non deployment entity or stable deployment as it is
newObjectsList.push(inputObject)
}
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
}
core.debug(
@@ -120,90 +111,81 @@ async function createCanaryService(
const trafficObjectsList: string[] = []
for (const filePath of filePaths) {
try {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml: K8sObject[] = yaml.loadAll(
fileContents
) as K8sObject[]
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (isServiceEntity(kind)) {
core.debug(`Creating services for ${kind} ${name}`)
const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject)
if (isServiceEntity(kind)) {
core.debug(`Creating services for ${kind} ${name}`)
const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject)
const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject)
newObjectsList.push(newBaselineServiceObject)
const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject)
newObjectsList.push(newBaselineServiceObject)
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
)
if (!stableObject) {
const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(newStableServiceObject)
const stableObject = await canaryDeploymentHelper.fetchResource(
core.debug('Creating the traffic object for service: ' + name)
const trafficObject = await createTrafficSplitManifestFile(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
name,
0,
0,
1000
)
if (!stableObject) {
const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(newStableServiceObject)
core.debug('Creating the traffic object for service: ' + name)
const trafficObject = await createTrafficSplitManifestFile(
kubectl,
name,
0,
0,
1000
trafficObjectsList.push(trafficObject)
} else {
let updateTrafficObject = true
const trafficObject = await canaryDeploymentHelper.fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name)
)
if (trafficObject) {
const trafficJObject = JSON.parse(
JSON.stringify(trafficObject)
)
trafficObjectsList.push(trafficObject)
} else {
let updateTrafficObject = true
const trafficObject =
await canaryDeploymentHelper.fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name)
)
if (trafficObject) {
const trafficJObject = JSON.parse(
JSON.stringify(trafficObject)
)
if (trafficJObject?.spec?.backends) {
trafficJObject.spec.backends.forEach((s) => {
if (
s.service ===
canaryDeploymentHelper.getCanaryResourceName(
name
) &&
s.weight === '1000m'
) {
core.debug('Update traffic objcet not required')
updateTrafficObject = false
}
})
}
if (trafficJObject?.spec?.backends) {
trafficJObject.spec.backends.forEach((s) => {
if (
s.service ===
canaryDeploymentHelper.getCanaryResourceName(
name
) &&
s.weight === '1000m'
) {
core.debug('Update traffic objcet not required')
updateTrafficObject = false
}
})
}
}
if (updateTrafficObject) {
core.debug(
'Stable service object present so updating the traffic object for service: ' +
name
)
trafficObjectsList.push(
await updateTrafficSplitObject(kubectl, name)
)
}
if (updateTrafficObject) {
core.debug(
'Stable service object present so updating the traffic object for service: ' +
name
)
trafficObjectsList.push(
await updateTrafficSplitObject(kubectl, name)
)
}
}
}
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
}
@@ -242,31 +224,23 @@ async function adjustTraffic(
const trafficSplitManifests = []
for (const filePath of manifestFilePaths) {
try {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml: K8sObject[] = yaml.loadAll(
fileContents
) as K8sObject[]
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (isServiceEntity(kind)) {
trafficSplitManifests.push(
await createTrafficSplitManifestFile(
kubectl,
name,
stableWeight,
0,
canaryWeight
)
if (isServiceEntity(kind)) {
trafficSplitManifests.push(
await createTrafficSplitManifestFile(
kubectl,
name,
stableWeight,
0,
canaryWeight
)
}
)
}
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
}
@@ -347,8 +321,9 @@ async function getTrafficSplitObject(
): Promise<string> {
// cached version
if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion =
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
}
return JSON.stringify({
+27 -37
View File
@@ -10,7 +10,12 @@ import {Kubectl, Resource} from '../types/kubectl'
import {deployPodCanary} from './canary/podCanaryHelper'
import {deploySMICanary} from './canary/smiCanaryHelper'
import {DeploymentConfig} from '../types/deploymentConfig'
import {deployBlueGreen} from './blueGreen/deploy'
import {
deployBlueGreen,
deployBlueGreenIngress,
deployBlueGreenService
} from './blueGreen/deploy'
import {deployBlueGreenSMI} from './blueGreen/deploy'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from '@actions/core'
import {
@@ -34,8 +39,8 @@ import {
normalizeWorkflowStrLabel
} from '../utilities/githubUtils'
import {getDeploymentConfig} from '../utilities/dockerUtils'
import {deploy} from '../actions/deploy'
import {DeployResult} from '../types/deployResult'
import {ClusterType} from '../actions/deploy'
export async function deployManifests(
files: string[],
@@ -111,24 +116,19 @@ function appendStableVersionLabelToResource(files: string[]): string[] {
const newObjectsList = []
files.forEach((filePath: string) => {
try {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString()
yaml.loadAll(fileContents, function (inputObject) {
const kind = (inputObject as {kind: string}).kind
yaml.safeLoadAll(fileContents, function (inputObject) {
const {kind} = inputObject
if (isDeploymentEntity(kind)) {
const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject)
} else {
manifestFiles.push(filePath)
}
})
} catch (error) {
core.error(`Failed to parse file at ${filePath}: ${error.message}`)
throw error
}
if (isDeploymentEntity(kind)) {
const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject)
} else {
manifestFiles.push(filePath)
}
})
})
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
@@ -139,14 +139,9 @@ function appendStableVersionLabelToResource(files: string[]): string[] {
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[],
resourceType: ClusterType
resources: Resource[]
): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(
kubectl,
resources,
resourceType
)
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
}
export async function annotateAndLabelResources(
@@ -204,19 +199,14 @@ async function annotateResources(
)
if (core.isDebug()) {
try {
core.debug(`files getting annotated are ${JSON.stringify(files)}`)
for (const filePath of files) {
core.debug('printing objects getting annotated...')
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects = yaml.loadAll(fileContents)
for (const inputObject of inputObjects) {
core.debug(`object: ${JSON.stringify(inputObject)}`)
}
core.debug(`files getting annotated are ${JSON.stringify(files)}`)
for (const filePath of files) {
core.debug('printing objects getting annotated...')
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects = yaml.safeLoadAll(fileContents)
for (const inputObject of inputObjects) {
core.debug(`object: ${JSON.stringify(inputObject)}`)
}
} catch (error) {
core.error(`Failed to load and parse files: ${error.message}`)
throw error
}
}
+11
View File
@@ -39,6 +39,17 @@ const testNamespace = 'testNamespace'
const defaultNamespace = 'default'
const otherNamespace = 'otherns'
describe('Kubectl class', () => {
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
})
describe('with a success exec return in testNamespace', () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
+4 -33
View File
@@ -1,14 +1,8 @@
import * as fileUtils from '../utilities/fileUtils'
import fs from 'node:fs'
import {
PrivateKubectl,
extractFileNames,
replaceFileNamesWithShallowNamesRelativeToTemp
} from './privatekubectl'
import {PrivateKubectl} 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 testString = `kubectl annotate -f test.yml,test2.yml,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/manifests/test.yml"],"helmChartPaths":[],"provider":"GitHub"} --overwrite --namespace test-3498366832`
const mockKube = new PrivateKubectl(
'kubectlPath',
'namespace',
@@ -17,32 +11,9 @@ describe('Private kubectl', () => {
'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`
expect(mockKube.extractFilesnames(testString)).toEqual(
'test.yml test2.yml test3.yml test4.yml test5.yml'
)
})
+98 -84
View File
@@ -1,10 +1,10 @@
import {Kubectl} from './kubectl'
import minimist from 'minimist'
import * as minimist from 'minimist'
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
import * as core from '@actions/core'
import fs from 'node:fs'
import * as os from 'os'
import * as fs from 'fs'
import * as path from 'path'
import {getTempDirectory} from '../utilities/fileUtils'
export class PrivateKubectl extends Kubectl {
protected async execute(args: string[], silent: boolean = false) {
@@ -18,7 +18,8 @@ export class PrivateKubectl extends Kubectl {
}
if (this.containsFilenames(kubectlCmd)) {
kubectlCmd = replaceFileNamesWithShallowNamesRelativeToTemp(kubectlCmd)
// For private clusters, files will referenced solely by their basename
kubectlCmd = this.replaceFilnamesWithBasenames(kubectlCmd)
addFileFlag = true
}
@@ -42,9 +43,22 @@ export class PrivateKubectl extends Kubectl {
]
if (addFileFlag) {
const tempDirectory = getTempDirectory()
eo.cwd = path.join(tempDirectory, 'manifests')
const filenames = this.extractFilesnames(kubectlCmd).split(' ')
const tempDirectory =
process.env['runner.tempDirectory'] || os.tmpdir() + '/manifests'
eo.cwd = tempDirectory
privateClusterArgs.push(...['--file', '.'])
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
const file = filenamesArr[index]
if (!file) {
continue
}
this.moveFileToTempManifestDir(file)
}
}
core.debug(
@@ -81,89 +95,89 @@ export class PrivateKubectl extends Kubectl {
} as ExecOutput
}
private replaceFilnamesWithBasenames(kubectlCmd: string) {
let exFilenames = this.extractFilesnames(kubectlCmd)
let filenames = exFilenames.split(' ')
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
filenamesArr[index] = path.basename(filenamesArr[index])
}
let baseFilenames = filenamesArr.join()
let result = kubectlCmd.replace(exFilenames, baseFilenames)
return result
}
public extractFilesnames(strToParse: string) {
const fileNames: string[] = []
const argv = minimist(strToParse.split(' '))
const fArg = 'f'
const filenameArg = 'filename'
fileNames.push(...this.extractFilesFromMinimist(argv, fArg))
fileNames.push(...this.extractFilesFromMinimist(argv, filenameArg))
return fileNames.join(' ')
}
private 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
}
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(','))
private createTempManifestsDirectory() {
const manifestsDir = '/tmp/manifests'
if (!fs.existsSync('/tmp/manifests')) {
fs.mkdirSync('/tmp/manifests', {recursive: true})
}
}
return toReturn
private moveFileToTempManifestDir(file: string) {
this.createTempManifestsDirectory()
if (!fs.existsSync('/tmp/' + file)) {
core.debug(
'/tmp/' +
file +
' does not exist, and therefore cannot be moved to the manifest directory'
)
}
fs.copyFile('/tmp/' + file, '/tmp/manifests/' + file, function (err) {
if (err) {
core.debug(
'Could not rename ' +
'/tmp/' +
file +
' to ' +
'/tmp/manifests/' +
file +
' ERROR: ' +
err
)
return
}
core.debug(
"Successfully moved file '" +
file +
"' from /tmp to /tmp/manifest directory"
)
})
}
}
+24 -39
View File
@@ -1,19 +1,22 @@
import * as fileUtils from './fileUtils'
import {
getFilesFromDirectoriesAndURLs,
getTempDirectory,
urlFileKind,
writeYamlFromURLToFile
} from './fileUtils'
import * as yaml from 'js-yaml'
import fs from 'node:fs'
import * as fs from 'fs'
import * as path from 'path'
import {K8sObject} from '../types/k8sObject'
import {succeeded} from '../types/errorable'
const sampleYamlUrl =
'https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/controllers/nginx-deployment.yaml'
describe('File utils', () => {
test('correctly parses a yaml file from a URL', async () => {
const tempFile = await fileUtils.writeYamlFromURLToFile(sampleYamlUrl, 0)
const tempFile = await writeYamlFromURLToFile(sampleYamlUrl, 0)
const fileContents = fs.readFileSync(tempFile).toString()
const inputObjects: K8sObject[] = yaml.loadAll(
fileContents
) as K8sObject[]
const inputObjects = yaml.safeLoadAll(fileContents)
expect(inputObjects).toHaveLength(1)
for (const obj of inputObjects) {
@@ -27,34 +30,34 @@ describe('File utils', () => {
const testPath = path.join('test', 'unit', 'manifests')
await expect(
fileUtils.getFilesFromDirectoriesAndURLs([testPath, badUrl])
getFilesFromDirectoriesAndURLs([testPath, badUrl])
).rejects.toThrow()
})
it('detects files in nested directories with the same name and ignores non-manifest files and empty dirs', async () => {
it('detects files in nested directories 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 testSearch: string[] = await 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/another_layer/deep-ingress.yaml',
'test/unit/manifests/manifest_test_dir/another_layer/deep-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'
]
// is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(8)
expectedManifests.forEach((fileName) => {
if (fileName.startsWith('test/unit')) {
expect(testSearch).toContain(fileName)
} else {
expect(fileName.includes(fileUtils.urlFileKind)).toBe(true)
expect(fileName.startsWith(fileUtils.getTempDirectory()))
expect(fileName.includes(urlFileKind)).toBe(true)
expect(fileName.startsWith(getTempDirectory()))
}
})
})
@@ -69,7 +72,7 @@ describe('File utils', () => {
)
expect(
fileUtils.getFilesFromDirectoriesAndURLs([badPath, goodPath])
getFilesFromDirectoriesAndURLs([badPath, goodPath])
).rejects.toThrowError()
})
@@ -89,7 +92,7 @@ describe('File utils', () => {
)
expect(
await fileUtils.getFilesFromDirectoriesAndURLs([
await getFilesFromDirectoriesAndURLs([
outerPath,
fileAtOuter,
innerPath
@@ -99,24 +102,6 @@ describe('File utils', () => {
it('throws an error for an invalid URL', async () => {
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', () => {
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
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')
)
await expect(writeYamlFromURLToFile(badUrl, 0)).rejects.toBeTruthy()
})
})
+6 -26
View File
@@ -1,4 +1,4 @@
import fs from 'node:fs'
import * as fs from 'fs'
import * as https from 'https'
import * as path from 'path'
import * as core from '@actions/core'
@@ -23,7 +23,7 @@ export function writeObjectsToFile(inputObjects: any[]): string[] {
const inputObjectString = JSON.stringify(inputObject)
if (inputObject?.metadata?.name) {
const fileName = getNewTempManifestFileName(
const fileName = getManifestFileName(
inputObject.kind,
inputObject.metadata.name
)
@@ -52,7 +52,7 @@ export function writeManifestToFile(
): string {
if (inputObjectString) {
try {
const fileName = getNewTempManifestFileName(kind, name)
const fileName = getManifestFileName(kind, name)
fs.writeFileSync(path.join(fileName), inputObjectString)
return fileName
} catch (ex) {
@@ -63,27 +63,7 @@ export function writeManifestToFile(
}
}
export function moveFileToTmpDir(originalFilepath: string) {
const tempDirectory = getTempDirectory()
const newPath = path.join(tempDirectory, originalFilepath)
core.debug(`reading original contents from path: ${originalFilepath}`)
const contents = fs.readFileSync(originalFilepath).toString()
const dirName = path.dirname(newPath)
if (!fs.existsSync(dirName)) {
core.debug(`path ${dirName} doesn't exist yet, making new dir...`)
fs.mkdirSync(dirName, {recursive: true})
}
core.debug(`writing contents to new path ${newPath}`)
fs.writeFileSync(path.join(newPath), contents)
core.debug(`moved contents from ${originalFilepath} to ${newPath}`)
return newPath
}
function getNewTempManifestFileName(kind: string, name: string) {
function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_${getCurrentTime().toString()}`
const tempDirectory = getTempDirectory()
return path.join(tempDirectory, path.basename(filePath))
@@ -150,7 +130,7 @@ export async function writeYamlFromURLToFile(
)
}
const targetPath = getNewTempManifestFileName(
const targetPath = getManifestFileName(
urlFileKind,
fileNumber.toString()
)
@@ -183,7 +163,7 @@ function verifyYaml(filepath: string, url: string): Errorable<K8sObject[]> {
const fileContents = fs.readFileSync(filepath).toString()
let inputObjects
try {
inputObjects = yaml.loadAll(fileContents)
inputObjects = yaml.safeLoadAll(fileContents)
} catch (e) {
return {
succeeded: false,
@@ -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()
})
})
+1 -8
View File
@@ -3,21 +3,14 @@ import * as KubernetesConstants from '../types/kubernetesTypes'
import {Kubectl, Resource} from '../types/kubectl'
import {checkForErrors} from './kubectlUtils'
import {sleep} from './timeUtils'
import {ClusterType, ResourceTypeFleet} from '../actions/deploy'
const IS_SILENT = false
const POD = 'pod'
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[],
clusterTyper: ClusterType
resources: Resource[]
): Promise<void> {
// Skip if resource type is microsoft.containerservice/fleets
if (clusterTyper === ResourceTypeFleet) {
core.info(`Skipping checkManifestStability for ${ResourceTypeFleet}`)
return
}
let rolloutStatusHasErrors = false
for (let i = 0; i < resources.length; i++) {
const resource = resources[i]
-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)
})
})
+34 -52
View File
@@ -3,7 +3,7 @@ import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as path from 'path'
import * as fileHelper from './fileUtils'
import {moveFileToTmpDir} from './fileUtils'
import {getTempDirectory} from './fileUtils'
import {
InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError,
@@ -20,21 +20,16 @@ import {
setImagePullSecrets
} from './manifestPullSecretUtils'
import {Resource} from '../types/kubectl'
import {K8sObject} from '../types/k8sObject'
export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) {
throw new Error('Manifest files not provided')
}
// move original set of input files to tmp dir
const manifestFilesInTempDir = moveFilesToTmpDir(manifestFilePaths)
// update container images
const containers: string[] = core.getInput('images').split('\n')
const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilesInTempDir,
manifestFilePaths,
containers
)
@@ -46,12 +41,6 @@ export function updateManifestFiles(manifestFilePaths: string[]) {
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets)
}
export function moveFilesToTmpDir(filepaths: string[]): string[] {
return filepaths.map((filename) => {
return moveFileToTmpDir(filename)
})
}
export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) {
return
@@ -81,9 +70,12 @@ function updateContainerImagesInManifestFiles(
): string[] {
if (filePaths?.length <= 0) return filePaths
const newFilePaths = []
// update container images
filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString()
containers.forEach((container: string) => {
let [imageName] = container.split(':')
if (imageName.indexOf('@') > 0) {
@@ -99,10 +91,13 @@ function updateContainerImagesInManifestFiles(
})
// write updated files
fs.writeFileSync(path.join(filePath), contents)
const tempDirectory = getTempDirectory()
const fileName = path.join(tempDirectory, path.basename(filePath))
fs.writeFileSync(path.join(fileName), contents)
newFilePaths.push(fileName)
})
return filePaths
return newFilePaths
}
/*
@@ -275,29 +270,21 @@ export function getResources(
const resources: Resource[] = []
filePaths.forEach((filePath: string) => {
try {
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects: K8sObject[] = yaml.loadAll(
fileContents
) as K8sObject[]
inputObjects.forEach((inputObject) => {
const inputObjectKind = inputObject?.kind || ''
if (
filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
).length > 0
) {
resources.push({
type: inputObject.kind,
name: inputObject.metadata.name,
namespace: inputObject?.metadata?.namespace
})
}
})
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => {
const inputObjectKind = inputObject?.kind || ''
if (
filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
).length > 0
) {
resources.push({
type: inputObject.kind,
name: inputObject.metadata.name,
namespace: inputObject?.metadata?.namespace
})
}
})
})
return resources
@@ -311,21 +298,16 @@ function updateImagePullSecretsInManifestFiles(
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)
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) {
const {kind} = inputObject
if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets)
}
})
} catch (error) {
core.error(`Failed to process file at ${filePath}: ${error.message}`)
throw error
}
newObjectsList.push(inputObject)
}
})
})
return fileHelper.writeObjectsToFile(newObjectsList)
+2 -1
View File
@@ -232,7 +232,8 @@ def main():
getAllObjectsCmd = azPrefix + 'kubectl get '+kind+' -n '+namespace
if not azPrefix == "":
getAllObjectsCmd = azPrefix + "'{getAllObjectsCmd}'" # add extra set of quotes
foundObjects = os.popen(getAllObjectsCmd).read()
cmd = + "'" + cmd + "'"
foundObjects = os.popen().read()
suffix = f"resources of type {kind}: {foundObjects}"
sys.exit(msg + " " + suffix)
@@ -1,33 +0,0 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment3
labels:
app: nginx3
spec:
replicas: 1
selector:
matchLabels:
app: nginx3
template:
metadata:
labels:
app: nginx3
spec:
containers:
- name: nginx
image: nginx
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service3
spec:
selector:
app: nginx3
ports:
- protocol: TCP
port: 80
targetPort: 80
-33
View File
@@ -1,33 +0,0 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment2
labels:
app: nginx2
spec:
replicas: 1
selector:
matchLabels:
app: nginx2
template:
metadata:
labels:
app: nginx2
spec:
containers:
- name: nginx
image: nginx
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service2
spec:
selector:
app: nginx2
ports:
- protocol: TCP
port: 80
targetPort: 80
+1 -2
View File
@@ -1,8 +1,7 @@
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"esModuleInterop": true
"module": "commonjs"
},
"exclude": ["node_modules", "test", "src/**/*.test.ts"]
}