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
72 changed files with 15814 additions and 16126 deletions
+2 -1
View File
@@ -1,4 +1,4 @@
name: 'Code scanning - action'
name: "Code scanning - action"
on:
push:
@@ -8,6 +8,7 @@ on:
jobs:
CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest
+2 -1
View File
@@ -3,7 +3,7 @@ name: setting-default-labels
# Controls when the action will run.
on:
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
jobs:
@@ -13,6 +13,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/stale@v3
name: Setting issue as idle
with:
-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@v2
- name: Enforce Prettier
uses: actionsx/prettier@v2
with:
args: --check .
+1 -1
View File
@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
release:
description: 'Define release version (ex: v1, v2, v3)'
description: "Define release version (ex: v1, v2, v3)"
required: true
jobs:
+6 -6
View File
@@ -4,12 +4,12 @@ on:
branches:
- master
- main
- 'releases/*'
- "releases/*"
push:
branches:
- master
- main
- 'releases/*'
- "releases/*"
workflow_dispatch:
jobs:
@@ -43,9 +43,9 @@ jobs:
name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2
with:
minikube version: 'v1.24.0'
kubernetes version: 'v1.17.8'
driver: 'none'
minikube version: "v1.24.0"
kubernetes version: "v1.17.8"
driver: "none"
timeout-minutes: 3
- name: Create namespace to run tests
@@ -54,7 +54,7 @@ jobs:
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
python-version: "3.x"
- name: Cleaning any previously created items
run: |
+5 -5
View File
@@ -1,13 +1,13 @@
name: 'Run unit tests.'
name: "Run unit tests."
on: # rebuild any PRs and main branch changes
pull_request:
branches:
- main
- 'releases/*'
- master
- "releases/*"
push:
branches:
- main
- 'releases/*'
- master
- "releases/*"
jobs:
build: # make sure build/ci works properly
-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
}
+26 -32
View File
@@ -43,14 +43,6 @@ Following are the key capabilities of this action:
<tr>
<td>manifests </br></br>(Required)</td>
<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>
<td>strategy </br></br>(Required)</td>
<td>Acceptable values: basic/canary/blue-green. <br>
Default value: basic
<br>Deployment strategy to be used while applying manifest files on the cluster.
<br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
<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>
</tr>
<tr>
<td>namespace </br></br>(Optional)
@@ -70,13 +62,15 @@ Following are the key capabilities of this action:
<td>pull-images</br></br>(Optional)</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>
</tr>
<tr>
<td>strategy </br></br>(Optional)</td>
<td>Acceptable values: none/canary/blue-green. <br>
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>
</tr>
<tr>
<td>traffic-split-method </br></br>(Optional)</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>
<td>traffic-split-annotations </br></br>(Optional)</td>
<td>Annotations in the form of key/value pair to be added to TrafficSplit.</td>
<tr>
<td>percentage </br></br>(Optional but required if strategy is canary)</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>
@@ -113,10 +107,10 @@ Following are the key capabilities of this action:
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
namespace: "myapp"
manifests: |
dir/manifestsDirectory
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -127,8 +121,8 @@ Following are the key capabilities of this action:
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -146,8 +140,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -164,8 +158,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -185,8 +179,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} '
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -196,7 +190,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
dir/manifestsDirectory
strategy: canary
traffic-split-method: smi
action: reject # substitute reject if you want to reject
action: reject # substitute promote if you want to promote
```
### Blue-Green deployment with different route methods
@@ -204,8 +198,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -224,8 +218,8 @@ To promote/reject the green workload created by the above snippet, the following
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
@@ -268,7 +262,7 @@ jobs:
# Set the target AKS cluster.
- uses: Azure/aks-set-context@v1
with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
creds: "${{ secrets.AZURE_CREDENTIALS }}"
cluster-name: contoso
resource-group: contoso-rg
@@ -387,7 +381,7 @@ jobs:
# Set the target AKS cluster.
- uses: Azure/aks-set-context@v1
with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
creds: "${{ secrets.AZURE_CREDENTIALS }}"
cluster-name: contoso
resource-group: contoso-rg
@@ -401,12 +395,12 @@ jobs:
- uses: azure/k8s-bake@v2
with:
renderEngine: 'helm'
helmChart: './aks-helloworld/'
overrideFiles: './aks-helloworld/values-override.yaml'
renderEngine: "helm"
helmChart: "./aks-helloworld/"
overrideFiles: "./aks-helloworld/values-override.yaml"
overrides: |
replicas:2
helm-version: 'latest'
helm-version: "latest"
id: bake
- uses: Azure/k8s-deploy@v1.2
+8 -8
View File
@@ -4,7 +4,7 @@
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
@@ -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.
+25 -28
View File
@@ -1,70 +1,67 @@
name: 'Deploy to Kubernetes cluster'
description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters'
name: "Deploy to Kubernetes cluster"
description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters"
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
# You also need to have kubectl installed (azure/setup-kubectl)
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
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
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
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
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"
required: false
default: true
strategy:
description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
required: true
default: 'basic'
route-method:
description: 'Route based on service, ingress or SMI for blue-green strategy'
description: "Deployment strategy to be used. Allowed values are none, canary and blue-green"
required: false
default: 'service'
default: "none"
route-method:
description: "Route based on service, ingress or SMI for blue-green strategy"
required: false
default: "service"
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
default: 0
traffic-split-method:
description: 'Traffic split method to be used. Allowed values are pod and smi'
required: false
default: 'pod'
traffic-split-annotations:
description: 'Annotations in the form of key/value pair to be added to TrafficSplit. Relevant only if deployement strategy is blue-green or canary'
description: "Traffic split method to be used. Allowed values are pod and smi"
required: false
default: "pod"
baseline-and-canary-replicas:
description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)'
description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)"
required: false
default: 0
percentage:
description: 'Percentage of traffic redirect to canary deployment'
description: "Percentage of traffic redirect to canary deployment"
required: false
default: 0
action:
description: 'deploy, promote, or reject'
description: "deploy, promote, or reject"
required: true
default: 'deploy'
default: "deploy"
force:
description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command'
description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command"
required: false
default: false
token:
description: 'Github token'
description: "Github token"
default: ${{ github.token }}
required: true
annotate-namespace:
description: 'Annotate the target namespace'
description: "Annotate the target namespace"
required: false
default: true
branding:
color: 'green'
color: "green"
runs:
using: 'node16'
main: 'lib/index.js'
using: "node12"
main: "lib/index.js"
+45 -109
View File
@@ -22,10 +22,8 @@
"@types/jest": "^26.0.0",
"@types/js-yaml": "^3.12.7",
"@types/node": "^12.20.41",
"@vercel/ncc": "^0.34.0",
"jest": "^26.0.0",
"prettier": "2.7.1",
"ts-jest": "^26.0.0",
"ts-jest": "^25.5.1",
"typescript": "3.9.5"
}
},
@@ -1156,15 +1154,6 @@
"integrity": "sha512-37RSHht+gzzgYeobbG+KWryeAW8J33Nhr69cjTqSYymXVZEN9NbRYWoYlRtDhHKPVT1FyNKwaTPC1NynKZpzRA==",
"dev": true
},
"node_modules/@vercel/ncc": {
"version": "0.34.0",
"resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.34.0.tgz",
"integrity": "sha512-G9h5ZLBJ/V57Ou9vz5hI8pda/YQX5HQszCs3AmIus3XzsmRn/0Ptic5otD3xVST8QLKk7AMk7AqpsyQGN7MZ9A==",
"dev": true,
"bin": {
"ncc": "dist/ncc/cli.js"
}
},
"node_modules/abab": {
"version": "2.0.5",
"resolved": "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz",
@@ -3963,6 +3952,12 @@
"integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
"dev": true
},
"node_modules/lodash.memoize": {
"version": "4.1.2",
"resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz",
"integrity": "sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=",
"dev": true
},
"node_modules/lru-cache": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
@@ -4119,15 +4114,15 @@
}
},
"node_modules/mkdirp": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
"integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
"version": "0.5.5",
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.5.tgz",
"integrity": "sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==",
"dev": true,
"dependencies": {
"minimist": "^1.2.5"
},
"bin": {
"mkdirp": "bin/cmd.js"
},
"engines": {
"node": ">=10"
}
},
"node_modules/ms": {
@@ -4613,21 +4608,6 @@
"node": ">= 0.8.0"
}
},
"node_modules/prettier": {
"version": "2.7.1",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
"integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
"dev": true,
"bin": {
"prettier": "bin-prettier.js"
},
"engines": {
"node": ">=10.13.0"
},
"funding": {
"url": "https://github.com/prettier/prettier?sponsor=1"
}
},
"node_modules/pretty-format": {
"version": "26.6.2",
"resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-26.6.2.tgz",
@@ -5685,55 +5665,31 @@
}
},
"node_modules/ts-jest": {
"version": "26.5.6",
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.6.tgz",
"integrity": "sha512-rua+rCP8DxpA8b4DQD/6X2HQS8Zy/xzViVYfEs2OQu68tkCuKLV0Md8pmX55+W24uRIyAsf/BajRfxOs+R2MKA==",
"version": "25.5.1",
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-25.5.1.tgz",
"integrity": "sha512-kHEUlZMK8fn8vkxDjwbHlxXRB9dHYpyzqKIGDNxbzs+Rz+ssNDSDNusEK8Fk/sDd4xE6iKoQLfFkFVaskmTJyw==",
"dev": true,
"dependencies": {
"bs-logger": "0.x",
"buffer-from": "1.x",
"fast-json-stable-stringify": "2.x",
"jest-util": "^26.1.0",
"json5": "2.x",
"lodash": "4.x",
"lodash.memoize": "4.x",
"make-error": "1.x",
"mkdirp": "1.x",
"semver": "7.x",
"yargs-parser": "20.x"
"micromatch": "4.x",
"mkdirp": "0.x",
"semver": "6.x",
"yargs-parser": "18.x"
},
"bin": {
"ts-jest": "cli.js"
},
"engines": {
"node": ">= 10"
"node": ">= 8"
},
"peerDependencies": {
"jest": ">=26 <27",
"typescript": ">=3.8 <5.0"
}
},
"node_modules/ts-jest/node_modules/semver": {
"version": "7.3.7",
"resolved": "https://registry.npmjs.org/semver/-/semver-7.3.7.tgz",
"integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==",
"dev": true,
"dependencies": {
"lru-cache": "^6.0.0"
},
"bin": {
"semver": "bin/semver.js"
},
"engines": {
"node": ">=10"
}
},
"node_modules/ts-jest/node_modules/yargs-parser": {
"version": "20.2.9",
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz",
"integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==",
"dev": true,
"engines": {
"node": ">=10"
"jest": ">=25 <26",
"typescript": ">=3.4 <4.0"
}
},
"node_modules/tunnel": {
@@ -7096,12 +7052,6 @@
"integrity": "sha512-37RSHht+gzzgYeobbG+KWryeAW8J33Nhr69cjTqSYymXVZEN9NbRYWoYlRtDhHKPVT1FyNKwaTPC1NynKZpzRA==",
"dev": true
},
"@vercel/ncc": {
"version": "0.34.0",
"resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.34.0.tgz",
"integrity": "sha512-G9h5ZLBJ/V57Ou9vz5hI8pda/YQX5HQszCs3AmIus3XzsmRn/0Ptic5otD3xVST8QLKk7AMk7AqpsyQGN7MZ9A==",
"dev": true
},
"abab": {
"version": "2.0.5",
"resolved": "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz",
@@ -9269,6 +9219,12 @@
"integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
"dev": true
},
"lodash.memoize": {
"version": "4.1.2",
"resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz",
"integrity": "sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=",
"dev": true
},
"lru-cache": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
@@ -9391,10 +9347,13 @@
}
},
"mkdirp": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
"integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
"dev": true
"version": "0.5.5",
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.5.tgz",
"integrity": "sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==",
"dev": true,
"requires": {
"minimist": "^1.2.5"
}
},
"ms": {
"version": "2.1.2",
@@ -9770,12 +9729,6 @@
"integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=",
"dev": true
},
"prettier": {
"version": "2.7.1",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
"integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
"dev": true
},
"pretty-format": {
"version": "26.6.2",
"resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-26.6.2.tgz",
@@ -10633,38 +10586,21 @@
}
},
"ts-jest": {
"version": "26.5.6",
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.6.tgz",
"integrity": "sha512-rua+rCP8DxpA8b4DQD/6X2HQS8Zy/xzViVYfEs2OQu68tkCuKLV0Md8pmX55+W24uRIyAsf/BajRfxOs+R2MKA==",
"version": "25.5.1",
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-25.5.1.tgz",
"integrity": "sha512-kHEUlZMK8fn8vkxDjwbHlxXRB9dHYpyzqKIGDNxbzs+Rz+ssNDSDNusEK8Fk/sDd4xE6iKoQLfFkFVaskmTJyw==",
"dev": true,
"requires": {
"bs-logger": "0.x",
"buffer-from": "1.x",
"fast-json-stable-stringify": "2.x",
"jest-util": "^26.1.0",
"json5": "2.x",
"lodash": "4.x",
"lodash.memoize": "4.x",
"make-error": "1.x",
"mkdirp": "1.x",
"semver": "7.x",
"yargs-parser": "20.x"
},
"dependencies": {
"semver": {
"version": "7.3.7",
"resolved": "https://registry.npmjs.org/semver/-/semver-7.3.7.tgz",
"integrity": "sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==",
"dev": true,
"requires": {
"lru-cache": "^6.0.0"
}
},
"yargs-parser": {
"version": "20.2.9",
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz",
"integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==",
"dev": true
}
"micromatch": "4.x",
"mkdirp": "0.x",
"semver": "6.x",
"yargs-parser": "18.x"
}
},
"tunnel": {
+3 -7
View File
@@ -4,10 +4,8 @@
"author": "Deepak Sattiraju",
"license": "MIT",
"scripts": {
"build": "ncc build src/run.ts -o lib",
"test": "jest",
"format": "prettier --write .",
"format-check": "prettier --check ."
"build": "tsc --outDir ./lib --rootDir ./src",
"test": "jest"
},
"dependencies": {
"@actions/core": "^1.2.6",
@@ -23,10 +21,8 @@
"@types/jest": "^26.0.0",
"@types/js-yaml": "^3.12.7",
"@types/node": "^12.20.41",
"@vercel/ncc": "^0.34.0",
"jest": "^26.0.0",
"prettier": "2.7.1",
"ts-jest": "^26.0.0",
"ts-jest": "^25.5.1",
"typescript": "3.9.5"
}
}
+38 -45
View File
@@ -1,92 +1,85 @@
import * as core from '@actions/core'
import * as models from '../types/kubernetesTypes'
import * as KubernetesConstants from '../types/kubernetesTypes'
import {Kubectl, Resource} from '../types/kubectl'
import * as core from "@actions/core";
import * as models from "../types/kubernetesTypes";
import * as KubernetesConstants from "../types/kubernetesTypes";
import { Kubectl, Resource } from "../types/kubectl";
import {
getResources,
updateManifestFiles
} from '../utilities/manifestUpdateUtils'
import {routeBlueGreen} from '../strategyHelpers/blueGreen/blueGreenHelper'
updateManifestFiles,
} from "../utilities/manifestUpdateUtils";
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper";
import {
annotateAndLabelResources,
checkManifestStability,
deployManifests
} from '../strategyHelpers/deploymentHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
import {parseRouteStrategy} from '../types/routeStrategy'
deployManifests,
} from "../strategyHelpers/deploymentHelper";
import { DeploymentStrategy } from "../types/deploymentStrategy";
import { parseTrafficSplitMethod } from "../types/trafficSplitMethod";
import { parseRouteStrategy } from "../types/routeStrategy";
export async function deploy(
kubectl: Kubectl,
manifestFilePaths: string[],
deploymentStrategy: DeploymentStrategy,
annotations: {[key: string]: string} = {}
deploymentStrategy: DeploymentStrategy
) {
// update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths)
core.debug('Input manifest files: ' + inputManifestFiles)
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths);
core.debug("Input manifest files: " + inputManifestFiles);
// deploy manifests
core.startGroup('Deploying manifests')
core.info("Deploying manifests");
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
core.getInput("traffic-split-method", { required: true })
);
const deployedManifestFiles = await deployManifests(
inputManifestFiles,
deploymentStrategy,
kubectl,
trafficSplitMethod,
annotations
)
core.endGroup()
core.debug('Deployed manifest files: ' + deployedManifestFiles)
trafficSplitMethod
);
core.debug("Deployed manifest files: " + deployedManifestFiles);
// check manifest stability
core.startGroup('Checking manifest stability')
core.info("Checking manifest stability");
const resourceTypes: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
])
)
await checkManifestStability(kubectl, resourceTypes)
core.endGroup()
);
await checkManifestStability(kubectl, resourceTypes);
if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
core.startGroup('Routing blue green')
core.info("Routing blue green");
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy)
core.endGroup()
core.getInput("route-method", { required: true })
);
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy);
}
// print ingresses
core.startGroup('Printing ingresses')
core.info("Printing ingresses");
const ingressResources: Resource[] = getResources(deployedManifestFiles, [
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
])
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
]);
for (const ingressResource of ingressResources) {
await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name
)
);
}
core.endGroup()
// annotate resources
core.startGroup('Annotating resources')
let allPods
core.info("Annotating resources");
let allPods;
try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout)
allPods = JSON.parse((await kubectl.getAllPods()).stdout);
} catch (e) {
core.debug('Unable to parse pods: ' + e)
core.debug("Unable to parse pods: " + e);
}
await annotateAndLabelResources(
deployedManifestFiles,
kubectl,
resourceTypes,
allPods
)
core.endGroup()
);
}
+69 -84
View File
@@ -1,187 +1,172 @@
import * as core from '@actions/core'
import * as deploy from './deploy'
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import * as core from "@actions/core";
import * as deploy from "./deploy";
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import {
getResources,
updateManifestFiles
} from '../utilities/manifestUpdateUtils'
import * as models from '../types/kubernetesTypes'
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
updateManifestFiles,
} from "../utilities/manifestUpdateUtils";
import * as models from "../types/kubernetesTypes";
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import {
BlueGreenManifests,
deleteWorkloadsAndServicesWithLabel,
deleteWorkloadsWithLabel,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from '../strategyHelpers/blueGreen/blueGreenHelper'
NONE_LABEL_VALUE,
} from "../strategyHelpers/blueGreen/blueGreenHelper";
import {
promoteBlueGreenService,
routeBlueGreenService
} from '../strategyHelpers/blueGreen/serviceBlueGreenHelper'
routeBlueGreenService,
} from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import {
promoteBlueGreenIngress,
routeBlueGreenIngress
} from '../strategyHelpers/blueGreen/ingressBlueGreenHelper'
routeBlueGreenIngress,
} from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
import {
cleanupSMI,
promoteBlueGreenSMI,
routeBlueGreenSMI
} from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
import {Kubectl, Resource} from '../types/kubectl'
import {DeploymentStrategy} from '../types/deploymentStrategy'
routeBlueGreenSMI,
} from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
import { Kubectl, Resource } from "../types/kubectl";
import { DeploymentStrategy } from "../types/deploymentStrategy";
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
TrafficSplitMethod,
} from "../types/trafficSplitMethod";
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
export async function promote(
kubectl: Kubectl,
manifests: string[],
deploymentStrategy: DeploymentStrategy,
annotations: {[key: string]: string} = {}
deploymentStrategy: DeploymentStrategy
) {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY:
await promoteCanary(kubectl, manifests)
break
await promoteCanary(kubectl, manifests);
break;
case DeploymentStrategy.BLUE_GREEN:
await promoteBlueGreen(kubectl, manifests, annotations)
break
await promoteBlueGreen(kubectl, manifests);
break;
default:
throw Error('Invalid promote deployment strategy')
throw Error("Invalid promote deployment strategy");
}
}
async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false
let includeServices = false;
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
core.getInput("traffic-split-method", { required: true })
);
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
includeServices = true
includeServices = true;
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
// canary deployment, then update stable deployment and then redirect traffic to stable deployment
core.startGroup('Redirecting traffic to canary deployment')
core.info("Redirecting traffic to canary deployment");
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
kubectl,
manifests
)
core.endGroup()
);
core.startGroup('Deploying input manifests with SMI canary strategy')
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
core.info("Deploying input manifests with SMI canary strategy");
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
core.startGroup('Redirecting traffic to stable deployment')
core.info("Redirecting traffic to stable deployment");
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
manifests
)
core.endGroup()
);
} else {
core.startGroup('Deploying input manifests')
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
core.info("Deploying input manifests");
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
}
core.startGroup('Deleting canary and baseline workloads')
core.info("Deleting canary and baseline workloads");
try {
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
manifests,
includeServices
)
);
} catch (ex) {
core.warning(
'Exception occurred while deleting canary and baseline workloads: ' +
ex
)
"Exception occurred while deleting canary and baseline workloads: " + ex
);
}
core.endGroup()
}
async function promoteBlueGreen(
kubectl: Kubectl,
manifests: string[],
annotations: {[key: string]: string} = {}
) {
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests)
const inputManifestFiles: string[] = updateManifestFiles(manifests);
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles)
getManifestObjects(inputManifestFiles);
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
core.getInput("route-method", { required: true })
);
core.startGroup('Deleting old deployment and making new one')
let result
core.info("Deleting old deployment and making new one");
let result;
if (routeStrategy == RouteStrategy.INGRESS) {
result = await promoteBlueGreenIngress(kubectl, manifestObjects)
result = await promoteBlueGreenIngress(kubectl, manifestObjects);
} else if (routeStrategy == RouteStrategy.SMI) {
result = await promoteBlueGreenSMI(kubectl, manifestObjects)
result = await promoteBlueGreenSMI(kubectl, manifestObjects);
} else {
result = await promoteBlueGreenService(kubectl, manifestObjects)
result = await promoteBlueGreenService(kubectl, manifestObjects);
}
core.endGroup()
// checking stability of newly created deployments
core.startGroup('Checking manifest stability')
const deployedManifestFiles = result.newFilePaths
core.info("Checking manifest stability");
const deployedManifestFiles = result.newFilePaths;
const resources: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE
models.DiscoveryAndLoadBalancerResource.SERVICE,
])
)
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
core.endGroup()
);
await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
core.startGroup(
'Routing to new deployments and deleting old workloads and services'
)
core.info(
"Routing to new deployments and deleting old workloads and services"
);
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress(
kubectl,
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
);
await deleteWorkloadsAndServicesWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList,
annotations
)
manifestObjects.serviceEntityList
);
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
)
await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
);
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
} else {
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
);
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
)
);
}
core.endGroup()
}
+32 -40
View File
@@ -1,76 +1,68 @@
import * as core from '@actions/core'
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import {Kubectl} from '../types/kubectl'
import {rejectBlueGreenService} from '../strategyHelpers/blueGreen/serviceBlueGreenHelper'
import {rejectBlueGreenIngress} from '../strategyHelpers/blueGreen/ingressBlueGreenHelper'
import {rejectBlueGreenSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from "@actions/core";
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import { Kubectl } from "../types/kubectl";
import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
import { DeploymentStrategy } from "../types/deploymentStrategy";
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
TrafficSplitMethod,
} from "../types/trafficSplitMethod";
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
export async function reject(
kubectl: Kubectl,
manifests: string[],
deploymentStrategy: DeploymentStrategy,
annotations: {[key: string]: string} = {}
deploymentStrategy: DeploymentStrategy
) {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY:
await rejectCanary(kubectl, manifests)
break
await rejectCanary(kubectl, manifests);
break;
case DeploymentStrategy.BLUE_GREEN:
await rejectBlueGreen(kubectl, manifests, annotations)
break
await rejectBlueGreen(kubectl, manifests);
break;
default:
throw 'Invalid delete deployment strategy'
throw "Invalid delete deployment strategy";
}
}
async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false
let includeServices = false;
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
core.getInput("traffic-split-method", { required: true })
);
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
core.startGroup('Rejecting deployment with SMI canary strategy')
includeServices = true
core.info("Rejecting deployment with SMI canary strategy");
includeServices = true;
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
manifests
)
core.endGroup()
);
}
core.startGroup('Deleting baseline and canary workloads')
core.info("Deleting baseline and canary workloads");
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
manifests,
includeServices
)
core.endGroup()
);
}
async function rejectBlueGreen(
kubectl: Kubectl,
manifests: string[],
annotations: {[key: string]: string} = {}
) {
core.startGroup('Rejecting deployment with blue green strategy')
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
core.info("Rejecting deployment with blue green strategy");
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
core.getInput("route-method", { required: true })
);
if (routeStrategy == RouteStrategy.INGRESS) {
await rejectBlueGreenIngress(kubectl, manifests)
await rejectBlueGreenIngress(kubectl, manifests);
} else if (routeStrategy == RouteStrategy.SMI) {
await rejectBlueGreenSMI(kubectl, manifests, annotations)
await rejectBlueGreenSMI(kubectl, manifests);
} else {
await rejectBlueGreenService(kubectl, manifests)
await rejectBlueGreenService(kubectl, manifests);
}
core.endGroup()
}
+27 -31
View File
@@ -1,60 +1,56 @@
import * as core from '@actions/core'
import {getKubectlPath, Kubectl} from './types/kubectl'
import {deploy} from './actions/deploy'
import {promote} from './actions/promote'
import {reject} from './actions/reject'
import {Action, parseAction} from './types/action'
import {parseDeploymentStrategy} from './types/deploymentStrategy'
import {getFilesFromDirectories} from './utilities/fileUtils'
import {parseAnnotations} from './types/annotations'
import * as core from "@actions/core";
import { getKubectlPath, Kubectl } from "./types/kubectl";
import { deploy } from "./actions/deploy";
import { promote } from "./actions/promote";
import { reject } from "./actions/reject";
import { Action, parseAction } from "./types/action";
import { parseDeploymentStrategy } from "./types/deploymentStrategy";
import { getFilesFromDirectories } from "./utilities/fileUtils";
export async function run() {
// verify kubeconfig is set
if (!process.env['KUBECONFIG'])
if (!process.env["KUBECONFIG"])
core.warning(
'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.'
)
"KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action."
);
// get inputs
const action: Action | undefined = parseAction(
core.getInput('action', {required: true})
)
const annotations = parseAnnotations(
core.getInput('annotations', {required: false})
)
const strategy = parseDeploymentStrategy(core.getInput('strategy'))
const manifestsInput = core.getInput('manifests', {required: true})
core.getInput("action", { required: true })
);
const strategy = parseDeploymentStrategy(core.getInput("strategy"));
const manifestsInput = core.getInput("manifests", { required: true });
const manifestFilePaths = manifestsInput
.split(/[\n,;]+/) // split into each individual manifest
.map((manifest) => manifest.trim()) // remove surrounding whitespace
.filter((manifest) => manifest.length > 0) // remove any blanks
.filter((manifest) => manifest.length > 0); // remove any blanks
const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
// create kubectl
const kubectlPath = await getKubectlPath()
const namespace = core.getInput('namespace') || 'default'
const kubectl = new Kubectl(kubectlPath, namespace, true)
const kubectlPath = await getKubectlPath();
const namespace = core.getInput("namespace") || "default";
const kubectl = new Kubectl(kubectlPath, namespace, true);
// run action
switch (action) {
case Action.DEPLOY: {
await deploy(kubectl, fullManifestFilePaths, strategy, annotations)
break
await deploy(kubectl, fullManifestFilePaths, strategy);
break;
}
case Action.PROMOTE: {
await promote(kubectl, fullManifestFilePaths, strategy, annotations)
break
await promote(kubectl, fullManifestFilePaths, strategy);
break;
}
case Action.REJECT: {
await reject(kubectl, fullManifestFilePaths, strategy, annotations)
break
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)
run().catch(core.setFailed);
+129 -134
View File
@@ -1,67 +1,66 @@
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import {Kubectl} from '../../types/kubectl'
import * as core from "@actions/core";
import * as fs from "fs";
import * as yaml from "js-yaml";
import { Kubectl } from "../../types/kubectl";
import {
isDeploymentEntity,
isIngressEntity,
isServiceEntity,
KubernetesWorkload
} from '../../types/kubernetesTypes'
import * as fileHelper from '../../utilities/fileUtils'
import {routeBlueGreenService} from './serviceBlueGreenHelper'
import {routeBlueGreenIngress} from './ingressBlueGreenHelper'
import {routeBlueGreenSMI} from './smiBlueGreenHelper'
KubernetesWorkload,
} from "../../types/kubernetesTypes";
import * as fileHelper from "../../utilities/fileUtils";
import { routeBlueGreenService } from "./serviceBlueGreenHelper";
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
import {
UnsetClusterSpecificDetails,
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
import {sleep} from '../../utilities/timeUtils'
import {RouteStrategy} from '../../types/routeStrategy'
updateSelectorLabels,
} from "../../utilities/manifestUpdateUtils";
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import { checkForErrors } from "../../utilities/kubectlUtils";
import { sleep } from "../../utilities/timeUtils";
import { RouteStrategy } from "../../types/routeStrategy";
export const GREEN_LABEL_VALUE = 'green'
export const NONE_LABEL_VALUE = 'None'
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color'
export const GREEN_SUFFIX = '-green'
export const STABLE_SUFFIX = '-stable'
export const GREEN_LABEL_VALUE = "green";
export const NONE_LABEL_VALUE = "None";
export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color";
export const GREEN_SUFFIX = "-green";
export const STABLE_SUFFIX = "-stable";
export interface BlueGreenManifests {
serviceEntityList: any[]
serviceNameMap: Map<string, string>
unroutedServiceEntityList: any[]
deploymentEntityList: any[]
ingressEntityList: any[]
otherObjects: any[]
serviceEntityList: any[];
serviceNameMap: Map<string, string>;
unroutedServiceEntityList: any[];
deploymentEntityList: any[];
ingressEntityList: any[];
otherObjects: any[];
}
export async function routeBlueGreen(
kubectl: Kubectl,
inputManifestFiles: string[],
routeStrategy: RouteStrategy,
annotations: {[key: string]: string} = {}
routeStrategy: RouteStrategy
) {
// sleep for buffer time
const bufferTime: number = parseInt(
core.getInput('version-switch-buffer') || '0'
)
core.getInput("version-switch-buffer") || "0"
);
if (bufferTime < 0 || bufferTime > 300)
throw Error('Version switch buffer must be between 0 and 300 (inclusive)')
const startSleepDate = new Date()
throw Error("Version switch buffer must be between 0 and 300 (inclusive)");
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()
);
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))
getManifestObjects(inputManifestFiles);
core.debug("Manifest objects: " + JSON.stringify(manifestObjects));
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
@@ -70,20 +69,19 @@ export async function routeBlueGreen(
GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList,
annotations
)
manifestObjects.serviceEntityList
);
} else {
await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
);
}
}
@@ -92,26 +90,26 @@ export async function deleteWorkloadsWithLabel(
deleteLabel: string,
deploymentEntityList: any[]
) {
const resourcesToDelete = []
const resourcesToDelete = [];
deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name
const kind = inputObject.kind
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments
const resourceToDelete = {name, kind}
resourcesToDelete.push(resourceToDelete)
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete new green deployments
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
resourcesToDelete.push(resourceToDelete)
}
})
});
await deleteObjects(kubectl, resourcesToDelete)
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteWorkloadsAndServicesWithLabel(
@@ -121,36 +119,36 @@ export async function deleteWorkloadsAndServicesWithLabel(
serviceEntityList: any[]
) {
// need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList)
const resourcesToDelete = []
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
const resourcesToDelete = [];
deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name
const kind = inputObject.kind
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects
const resourceToDelete = {name, kind}
resourcesToDelete.push(resourceToDelete)
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete green labels
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
resourcesToDelete.push(resourceToDelete)
}
})
});
await deleteObjects(kubectl, resourcesToDelete)
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])
const result = await kubectl.delete([delObject.kind, delObject.name]);
checkForErrors([result]);
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
@@ -159,40 +157,40 @@ export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList = []
const routedServiceEntityList = []
const unroutedServiceEntityList = []
const ingressEntityList = []
const otherEntitiesList = []
const serviceNameMap = new Map<string, string>()
const deploymentEntityList = [];
const routedServiceEntityList = [];
const unroutedServiceEntityList = [];
const ingressEntityList = [];
const otherEntitiesList = [];
const serviceNameMap = new Map<string, string>();
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) {
const kind = inputObject.kind
const name = inputObject.metadata.name
const kind = inputObject.kind;
const name = inputObject.metadata.name;
if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject)
deploymentEntityList.push(inputObject);
} else if (isServiceEntity(kind)) {
if (isServiceRouted(inputObject, deploymentEntityList)) {
routedServiceEntityList.push(inputObject)
routedServiceEntityList.push(inputObject);
serviceNameMap.set(
name,
getBlueGreenResourceName(name, GREEN_SUFFIX)
)
);
} else {
unroutedServiceEntityList.push(inputObject)
unroutedServiceEntityList.push(inputObject);
}
} else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject)
ingressEntityList.push(inputObject);
} else {
otherEntitiesList.push(inputObject)
otherEntitiesList.push(inputObject);
}
}
})
})
});
});
return {
serviceEntityList: routedServiceEntityList,
@@ -200,32 +198,32 @@ export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList
}
otherObjects: otherEntitiesList,
};
}
export function isServiceRouted(
serviceObject: any[],
deploymentEntityList: any[]
): boolean {
let shouldBeRouted: boolean = false
const serviceSelector: any = getServiceSelector(serviceObject)
let shouldBeRouted: boolean = false;
const serviceSelector: any = getServiceSelector(serviceObject);
if (serviceSelector) {
if (
deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject)
const matchLabels: any = getDeploymentMatchLabels(depObject);
return (
matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
)
);
})
) {
shouldBeRouted = true
shouldBeRouted = true;
}
}
return shouldBeRouted
return shouldBeRouted;
}
export async function createWorkloadsWithLabel(
@@ -233,39 +231,39 @@ export async function createWorkloadsWithLabel(
deploymentObjectList: any[],
nextLabel: string
) {
const newObjectsList = []
const newObjectsList = [];
deploymentObjectList.forEach((inputObject) => {
// creating deployment with label
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel)
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel);
core.debug(
'New blue-green object is: ' + JSON.stringify(newBlueGreenObject)
)
newObjectsList.push(newBlueGreenObject)
})
"New blue-green object is: " + JSON.stringify(newBlueGreenObject)
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const result = await kubectl.apply(manifestFiles)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const result = await kubectl.apply(manifestFiles);
return {result: result, newFilePaths: manifestFiles}
return { result: result, newFilePaths: manifestFiles };
}
export function getNewBlueGreenObject(
inputObject: any,
labelValue: string
): 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
if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name,
GREEN_SUFFIX
)
);
}
// Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject
addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject;
}
export function addBlueGreenLabelsAndAnnotations(
@@ -273,21 +271,21 @@ export function addBlueGreenLabelsAndAnnotations(
labelValue: string
) {
//creating the k8s.deploy.color label
const newLabels = new Map<string, string>()
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue
const newLabels = new Map<string, string>();
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
// updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false)
updateObjectLabels(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false);
// updating spec labels if it is a service
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false)
updateSpecLabels(inputObject, newLabels, false);
}
}
export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}`
return `${name}${suffix}`;
}
export function getDeploymentMatchLabels(deploymentObject: any): any {
@@ -296,15 +294,15 @@ export function getDeploymentMatchLabels(deploymentObject: any): any {
KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels
) {
return deploymentObject.metadata.labels
return deploymentObject.metadata.labels;
} else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels
return deploymentObject.spec.selector.matchLabels;
}
}
export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector
return serviceObject.spec.selector;
}
}
@@ -312,27 +310,24 @@ export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any,
matchLabels: any
): boolean {
const serviceSelectorMap = new Map()
const matchLabelsMap = new Map()
const serviceSelectorMap = new Map();
const matchLabelsMap = new Map();
JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value)
})
serviceSelectorMap.set(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) => {
if (
!!key &&
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value
)
isMatch = false
})
if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value)
isMatch = false;
});
return isMatch
return isMatch;
}
export async function fetchResource(
@@ -340,21 +335,21 @@ export async function fetchResource(
kind: string,
name: string
) {
const result = await kubectl.getResource(kind, name)
const result = await kubectl.getResource(kind, name);
if (result == null || !!result.stderr) {
return null
return null;
}
if (!!result.stdout) {
const resource = JSON.parse(result.stdout)
const resource = JSON.parse(result.stdout);
try {
UnsetClusterSpecificDetails(resource)
return resource
UnsetClusterSpecificDetails(resource);
return resource;
} catch (ex) {
core.debug(
`Exception occurred while Parsing ${resource} in Json object: ${ex}`
)
);
}
}
}
@@ -1,5 +1,5 @@
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import { Kubectl } from "../../types/kubectl";
import * as fileHelper from "../../utilities/fileUtils";
import {
addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL,
@@ -10,43 +10,43 @@ import {
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
import * as core from '@actions/core'
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
import * as core from "@actions/core";
const BACKEND = 'BACKEND'
const BACKEND = "BACKEND";
export async function deployBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
);
// create new services and other objects
let newObjectsList = []
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
)
newObjectsList.push(newBlueGreenObject)
})
);
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result
return result;
}
export async function promoteBlueGreenIngress(
@@ -61,7 +61,7 @@ export async function promoteBlueGreenIngress(
manifestObjects.serviceNameMap
)
) {
throw 'Ingress not in promote state'
throw "Ingress not in promote state";
}
// create stable deployments with new configuration
@@ -69,22 +69,22 @@ export async function promoteBlueGreenIngress(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
);
// create stable services with new configuration
const newObjectsList = []
const newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE
)
newObjectsList.push(newBlueGreenObject)
})
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result
return result;
}
export async function rejectBlueGreenIngress(
@@ -92,7 +92,7 @@ export async function rejectBlueGreenIngress(
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route ingress to stables services
await routeBlueGreenIngress(
@@ -100,7 +100,7 @@ export async function rejectBlueGreenIngress(
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
);
// delete green services and deployments
await deleteWorkloadsAndServicesWithLabel(
@@ -108,7 +108,7 @@ export async function rejectBlueGreenIngress(
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
);
}
export async function routeBlueGreenIngress(
@@ -117,12 +117,12 @@ export async function routeBlueGreenIngress(
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
) {
let newObjectsList = []
let newObjectsList = [];
if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
)
);
} else {
ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
@@ -130,17 +130,17 @@ export async function routeBlueGreenIngress(
inputObject,
serviceNameMap,
GREEN_LABEL_VALUE
)
newObjectsList.push(newBlueGreenIngressObject)
);
newObjectsList.push(newBlueGreenIngressObject);
} else {
newObjectsList.push(inputObject)
newObjectsList.push(inputObject);
}
})
});
}
core.debug('New objects: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
core.debug("New objects: " + JSON.stringify(newObjectsList));
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
export function validateIngressesState(
@@ -148,7 +148,7 @@ export function validateIngressesState(
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): boolean {
let areIngressesTargetingNewServices: boolean = true
let areIngressesTargetingNewServices: boolean = true;
ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
@@ -156,40 +156,40 @@ export function validateIngressesState(
kubectl,
inputObject.kind,
inputObject.metadata.name
)
);
if (!!existingIngress) {
const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL]
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL];
// if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false
areIngressesTargetingNewServices = false;
} else {
// no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false
areIngressesTargetingNewServices = false;
}
}
})
});
return areIngressesTargetingNewServices
return areIngressesTargetingNewServices;
}
function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false
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
if (key === "serviceName" && serviceNameMap.has(value)) {
isIngressRouted = true;
}
return value
})
return value;
});
return isIngressRouted
return isIngressRouted;
}
export function getUpdatedBlueGreenIngress(
@@ -198,15 +198,15 @@ export function getUpdatedBlueGreenIngress(
type: string
): object {
if (!type) {
return inputObject
return inputObject;
}
const newObject = JSON.parse(JSON.stringify(inputObject))
const newObject = JSON.parse(JSON.stringify(inputObject));
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type)
addBlueGreenLabelsAndAnnotations(newObject, type);
// update ingress labels
return updateIngressBackend(newObject, serviceNameMap)
return updateIngressBackend(newObject, serviceNameMap);
}
export function updateIngressBackend(
@@ -215,15 +215,15 @@ export function updateIngressBackend(
): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if (key.toUpperCase() === BACKEND) {
const {serviceName} = value
const { serviceName } = value;
if (serviceNameMap.has(serviceName)) {
// update service name with corresponding bluegreen name only if service is provied in given manifests
value.serviceName = serviceNameMap.get(serviceName)
value.serviceName = serviceNameMap.get(serviceName);
}
}
return value
})
return value;
});
return inputObject
return inputObject;
}
@@ -1,5 +1,5 @@
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import { Kubectl } from "../../types/kubectl";
import * as fileHelper from "../../utilities/fileUtils";
import {
addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL,
@@ -9,31 +9,31 @@ import {
fetchResource,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
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)
.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
return result;
}
export async function promoteBlueGreenService(
@@ -44,7 +44,7 @@ export async function promoteBlueGreenService(
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw 'Not inP promote state'
throw "Not inP promote state";
}
// creating stable deployments with new configurations
@@ -52,7 +52,7 @@ export async function promoteBlueGreenService(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
);
}
export async function rejectBlueGreenService(
@@ -60,21 +60,21 @@ export async function rejectBlueGreenService(
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
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(
@@ -82,18 +82,18 @@ export async function routeBlueGreenService(
nextLabel: string,
serviceEntityList: any[]
) {
const newObjectsList = []
const newObjectsList = [];
serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject,
nextLabel
)
newObjectsList.push(newBlueGreenServiceObject)
})
);
newObjectsList.push(newBlueGreenServiceObject);
});
// configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
// add green labels to configure existing service
@@ -101,18 +101,18 @@ function getUpdatedBlueGreenService(
inputObject: any,
labelValue: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject))
const newObject = JSON.parse(JSON.stringify(inputObject));
// Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject
addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject;
}
export async function validateServicesState(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<boolean> {
let areServicesGreen: boolean = true
let areServicesGreen: boolean = true;
for (const serviceObject of serviceEntityList) {
// finding the existing routed service
@@ -120,27 +120,27 @@ export async function validateServicesState(
kubectl,
serviceObject.kind,
serviceObject.metadata.name
)
);
if (!!existingService) {
const currentLabel: string = getServiceSpecLabel(existingService)
const currentLabel: string = getServiceSpecLabel(existingService);
if (currentLabel != GREEN_LABEL_VALUE) {
// service should be targeting deployments with green label
areServicesGreen = false
areServicesGreen = false;
}
} else {
// service targeting deployment doesn't exist
areServicesGreen = false
areServicesGreen = false;
}
}
return areServicesGreen
return areServicesGreen;
}
export function getServiceSpecLabel(inputObject: any): string {
if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL]
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL];
}
return ''
return "";
}
@@ -1,6 +1,6 @@
import {Kubectl} from '../../types/kubectl'
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import * as fileHelper from '../../utilities/fileUtils'
import { Kubectl } from "../../types/kubectl";
import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as fileHelper from "../../utilities/fileUtils";
import {
BlueGreenManifests,
createWorkloadsWithLabel,
@@ -13,39 +13,38 @@ import {
GREEN_LABEL_VALUE,
GREEN_SUFFIX,
NONE_LABEL_VALUE,
STABLE_SUFFIX
} from './blueGreenHelper'
STABLE_SUFFIX,
} from "./blueGreenHelper";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit'
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
const MIN_VAL = 0
const MAX_VAL = 100
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit";
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
const MIN_VAL = 0;
const MAX_VAL = 100;
export async function deployBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[],
annotations: {[key: string]: string} = {}
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create services and other objects
const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.serviceEntityList)
.concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// make extraservices and trafficsplit
await setupSMI(kubectl, manifestObjects.serviceEntityList, annotations)
await setupSMI(kubectl, manifestObjects.serviceEntityList);
// create new deloyments
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
);
}
export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
@@ -56,7 +55,7 @@ export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
manifestObjects.serviceEntityList
))
) {
throw Error('Not in promote state SMI')
throw Error("Not in promote state SMI");
}
// create stable deployments with new configuration
@@ -64,157 +63,146 @@ export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
);
}
export async function rejectBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[],
annotations: {[key: string]: string} = {}
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route trafficsplit to stable deployments
// route trafficsplit to stable deploymetns
await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList,
annotations
)
manifestObjects.serviceEntityList
);
// delete rejected new bluegreen deployments
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
)
);
// delete trafficsplit and extra services
await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
}
export async function setupSMI(
kubectl: Kubectl,
serviceEntityList: any[],
annotations: {[key: string]: string} = {}
) {
const newObjectsList = []
const trafficObjectList = []
export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const newObjectsList = [];
const trafficObjectList = [];
serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service
trafficObjectList.push(serviceObject)
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)
})
);
const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX);
newObjectsList.push(newStableService);
newObjectsList.push(newGreenService);
});
// create services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// route to stable service
trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject(
kubectl,
inputObject.metadata.name,
NONE_LABEL_VALUE,
annotations
)
})
NONE_LABEL_VALUE
);
});
}
let trafficSplitAPIVersion = ''
let trafficSplitAPIVersion = "";
async function createTrafficSplitObject(
kubectl: Kubectl,
name: string,
nextLabel: string,
annotations: {[key: string]: 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
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL;
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL;
const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: 'TrafficSplit',
kind: "TrafficSplit",
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
annotations: annotations
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight
weight: stableWeight,
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight
}
]
}
})
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)
await kubectl.apply(trafficSplitManifestFile);
}
export function getSMIServiceResource(
inputObject: any,
suffix: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject))
const newObject = JSON.parse(JSON.stringify(inputObject));
if (suffix === STABLE_SUFFIX) {
// adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name,
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)
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE);
}
}
export async function routeBlueGreenSMI(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[],
annotations: {[key: string]: string} = {}
serviceEntityList: any[]
) {
for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label
await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel,
annotations
)
nextLabel
);
}
}
@@ -222,41 +210,39 @@ export async function validateTrafficSplitsState(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<boolean> {
let trafficSplitsInRightState: boolean = true
let trafficSplitsInRightState: boolean = true;
for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name
const name = serviceObject.metadata.name;
let trafficSplitObject = await fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
)
);
if (!trafficSplitObject) {
// no traffic split exits
trafficSplitsInRightState = false
trafficSplitsInRightState = false;
}
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject))
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
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
if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
}
if (
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
if (element.weight != MIN_VAL) trafficSplitsInRightState = false
if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) {
if (element.weight != MIN_VAL) trafficSplitsInRightState = false;
}
})
});
}
return trafficSplitsInRightState
return trafficSplitsInRightState;
}
export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const deleteList = []
const deleteList = [];
serviceEntityList.forEach((serviceObject) => {
deleteList.push({
@@ -264,26 +250,23 @@ export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
serviceObject.metadata.name,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
),
kind: TRAFFIC_SPLIT_OBJECT
})
kind: TRAFFIC_SPLIT_OBJECT,
});
deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
GREEN_SUFFIX
),
kind: serviceObject.kind
})
name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX),
kind: serviceObject.kind,
});
deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
STABLE_SUFFIX
),
kind: serviceObject.kind
})
})
kind: serviceObject.kind,
});
});
// delete all objects
await deleteObjects(kubectl, deleteList)
await deleteObjects(kubectl, deleteList);
}
+63 -63
View File
@@ -1,28 +1,28 @@
import {Kubectl} from '../../types/kubectl'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as core from '@actions/core'
import { Kubectl } from "../../types/kubectl";
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as core from "@actions/core";
import {
isDeploymentEntity,
isServiceEntity,
KubernetesWorkload
} from '../../types/kubernetesTypes'
import * as utils from '../../utilities/manifestUpdateUtils'
KubernetesWorkload,
} from "../../types/kubernetesTypes";
import * as utils from "../../utilities/manifestUpdateUtils";
import {
updateObjectAnnotations,
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
updateSelectorLabels,
} from "../../utilities/manifestUpdateUtils";
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import { checkForErrors } from "../../utilities/kubectlUtils";
export const CANARY_VERSION_LABEL = 'workflow/version'
const BASELINE_SUFFIX = '-baseline'
export const BASELINE_LABEL_VALUE = 'baseline'
const CANARY_SUFFIX = '-canary'
export const CANARY_LABEL_VALUE = 'canary'
export const STABLE_SUFFIX = '-stable'
export const STABLE_LABEL_VALUE = 'stable'
export const CANARY_VERSION_LABEL = "workflow/version";
const BASELINE_SUFFIX = "-baseline";
export const BASELINE_LABEL_VALUE = "baseline";
const CANARY_SUFFIX = "-canary";
export const CANARY_LABEL_VALUE = "canary";
export const STABLE_SUFFIX = "-stable";
export const STABLE_LABEL_VALUE = "stable";
export async function deleteCanaryDeployment(
kubectl: Kubectl,
@@ -30,48 +30,48 @@ export async function deleteCanaryDeployment(
includeServices: boolean
) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) {
throw new Error('Manifest file not found')
throw new Error("Manifest file not found");
}
await cleanUpCanary(kubectl, manifestFilePaths, includeServices)
await cleanUpCanary(kubectl, manifestFilePaths, includeServices);
}
export function markResourceAsStable(inputObject: any): object {
if (isResourceMarkedAsStable(inputObject)) {
return inputObject
return inputObject;
}
const newObject = JSON.parse(JSON.stringify(inputObject))
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE)
return newObject
const newObject = JSON.parse(JSON.stringify(inputObject));
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE);
return newObject;
}
export function isResourceMarkedAsStable(inputObject: any): boolean {
return (
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
)
);
}
export function getStableResource(inputObject: any): object {
const replicaCount = specContainsReplicas(inputObject.kind)
? inputObject.metadata.replicas
: 0
: 0;
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE)
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
}
export function getNewBaselineResource(
stableObject: any,
replicas?: number
): object {
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE)
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE);
}
export function getNewCanaryResource(
inputObject: any,
replicas?: number
): object {
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE)
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE);
}
export async function fetchResource(
@@ -79,36 +79,36 @@ export async function fetchResource(
kind: string,
name: string
) {
const result = await kubectl.getResource(kind, name)
const result = await kubectl.getResource(kind, name);
if (!result || result?.stderr) {
return null
return null;
}
if (result.stdout) {
const resource = JSON.parse(result.stdout)
const resource = JSON.parse(result.stdout);
try {
utils.UnsetClusterSpecificDetails(resource)
return resource
utils.UnsetClusterSpecificDetails(resource);
return resource;
} catch (ex) {
core.debug(
`Exception occurred while Parsing ${resource} in JSON object: ${ex}`
)
);
}
}
}
export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX
return name + CANARY_SUFFIX;
}
export function getBaselineResourceName(name: string) {
return name + BASELINE_SUFFIX
return name + BASELINE_SUFFIX;
}
export function getStableResourceName(name: string) {
return name + STABLE_SUFFIX
return name + STABLE_SUFFIX;
}
function getNewCanaryObject(
@@ -116,26 +116,26 @@ function getNewCanaryObject(
replicas: number,
type: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject))
const newObject = JSON.parse(JSON.stringify(inputObject));
// Updating name
if (type === CANARY_LABEL_VALUE) {
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name)
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name);
} else if (type === STABLE_LABEL_VALUE) {
newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
newObject.metadata.name = getStableResourceName(inputObject.metadata.name);
} else {
newObject.metadata.name = getBaselineResourceName(
inputObject.metadata.name
)
);
}
addCanaryLabelsAndAnnotations(newObject, type)
addCanaryLabelsAndAnnotations(newObject, type);
if (specContainsReplicas(newObject.kind)) {
newObject.spec.replicas = replicas
newObject.spec.replicas = replicas;
}
return newObject
return newObject;
}
function specContainsReplicas(kind: string) {
@@ -143,19 +143,19 @@ function specContainsReplicas(kind: string) {
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
!isServiceEntity(kind)
)
);
}
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newLabels = new Map<string, string>()
newLabels[CANARY_VERSION_LABEL] = type
const newLabels = new Map<string, string>();
newLabels[CANARY_VERSION_LABEL] = type;
updateObjectLabels(inputObject, newLabels, false)
updateObjectAnnotations(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false)
updateObjectLabels(inputObject, newLabels, false);
updateObjectAnnotations(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false);
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false)
updateSpecLabels(inputObject, newLabels, false);
}
}
@@ -166,30 +166,30 @@ async function cleanUpCanary(
) {
const deleteObject = async function (kind, name) {
try {
const result = await kubectl.delete([kind, name])
checkForErrors([result])
const result = await kubectl.delete([kind, name]);
checkForErrors([result]);
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
}
};
for (const filePath of files) {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
const parsedYaml = yaml.safeLoadAll(fileContents)
const parsedYaml = yaml.safeLoadAll(fileContents);
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (
isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind))
) {
const canaryObjectName = getCanaryResourceName(name)
const baselineObjectName = getBaselineResourceName(name)
const canaryObjectName = getCanaryResourceName(name);
const baselineObjectName = getBaselineResourceName(name);
await deleteObject(kind, canaryObjectName)
await deleteObject(kind, baselineObjectName)
await deleteObject(kind, canaryObjectName);
await deleteObject(kind, baselineObjectName);
}
}
}
+42 -46
View File
@@ -1,94 +1,90 @@
import {Kubectl} from '../../types/kubectl'
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import { Kubectl } from "../../types/kubectl";
import * as core from "@actions/core";
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils'
import * as canaryDeploymentHelper from './canaryHelper'
import {isDeploymentEntity} from '../../types/kubernetesTypes'
import {getReplicaCount} from '../../utilities/manifestUpdateUtils'
import * as fileHelper from "../../utilities/fileUtils";
import * as canaryDeploymentHelper from "./canaryHelper";
import { isDeploymentEntity } from "../../types/kubernetesTypes";
import { getReplicaCount } from "../../utilities/manifestUpdateUtils";
export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
const newObjectsList = []
const percentage = parseInt(core.getInput('percentage'))
const newObjectsList = [];
const percentage = parseInt(core.getInput("percentage"));
if (percentage < 0 || percentage > 100)
throw Error('Percentage must be between 0 and 100')
throw Error("Percentage must be between 0 and 100");
for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
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
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (isDeploymentEntity(kind)) {
core.debug('Calculating replica count for canary')
core.debug("Calculating replica count for canary");
const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug('Replica count is ' + canaryReplicaCount)
);
core.debug("Replica count is " + canaryReplicaCount);
// Get stable object
core.debug('Querying stable object')
core.debug("Querying stable object");
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
);
if (!stableObject) {
core.debug('Stable object not found. Creating canary object')
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
core.debug("Stable object not found. Creating canary object");
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
);
newObjectsList.push(newCanaryObject);
} else {
core.debug(
'Creating canary and baseline objects. Stable object found: ' +
"Creating canary and baseline objects. Stable object found: " +
JSON.stringify(stableObject)
)
);
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
core.debug(
'New canary object: ' + JSON.stringify(newCanaryObject)
)
);
core.debug("New canary object: " + JSON.stringify(newCanaryObject));
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
);
core.debug(
'New baseline object: ' + JSON.stringify(newBaselineObject)
)
"New baseline object: " + JSON.stringify(newBaselineObject)
);
newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject)
newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject);
}
} else {
// update non deployment entity as it is
newObjectsList.push(inputObject)
newObjectsList.push(inputObject);
}
}
}
core.debug('New objects list: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
core.debug("New objects list: " + JSON.stringify(newObjectsList));
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(manifestFiles, forceDeployment)
return {result, newFilePaths: manifestFiles}
const result = await kubectl.apply(manifestFiles, forceDeployment);
return { result, newFilePaths: manifestFiles };
}
function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
const inputReplicaCount = getReplicaCount(inputObject)
return Math.round((inputReplicaCount * percentage) / 100)
const inputReplicaCount = getReplicaCount(inputObject);
return Math.round((inputReplicaCount * percentage) / 100);
}
+114 -125
View File
@@ -1,187 +1,178 @@
import {Kubectl} from '../../types/kubectl'
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import { Kubectl } from "../../types/kubectl";
import * as core from "@actions/core";
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils'
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import * as canaryDeploymentHelper from './canaryHelper'
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
import {checkForErrors} from '../../utilities/kubectlUtils'
import * as fileHelper from "../../utilities/fileUtils";
import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as canaryDeploymentHelper from "./canaryHelper";
import {
isDeploymentEntity,
isServiceEntity,
} from "../../types/kubernetesTypes";
import { checkForErrors } from "../../utilities/kubectlUtils";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout";
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
const canaryReplicaCount = parseInt(
core.getInput('baseline-and-canary-replicas')
)
core.getInput("baseline-and-canary-replicas")
);
if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
throw Error('Baseline-and-canary-replicas must be between 0 and 100')
throw Error("Baseline-and-canary-replicas must be between 0 and 100");
const newObjectsList = []
const newObjectsList = [];
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => {
const name = inputObject.metadata.name
const kind = inputObject.kind
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (isDeploymentEntity(kind)) {
const stableObject = canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
);
if (!stableObject) {
core.debug(
'Stable object not found. Creating only canary object'
)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
core.debug("Stable object not found. Creating only canary object");
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
);
newObjectsList.push(newCanaryObject);
} else {
if (
!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)
) {
throw Error(`StableSpecSelectorNotExist : ${name}`)
if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) {
throw Error(`StableSpecSelectorNotExist : ${name}`);
}
core.debug(
'Stable object found. Creating canary and baseline objects'
)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
"Stable object found. Creating canary and baseline objects"
);
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
);
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject)
);
newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject);
}
} else {
// Update non deployment entity as it is
newObjectsList.push(inputObject)
newObjectsList.push(inputObject);
}
})
})
});
});
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(newFilePaths, forceDeployment)
await createCanaryService(kubectl, filePaths)
return {result, newFilePaths}
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList);
const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(newFilePaths, forceDeployment);
await createCanaryService(kubectl, filePaths);
return { result, newFilePaths };
}
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
const newObjectsList = []
const trafficObjectsList = []
const newObjectsList = [];
const trafficObjectsList = [];
for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
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
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (isServiceEntity(kind)) {
const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject)
canaryDeploymentHelper.getNewCanaryResource(inputObject);
newObjectsList.push(newCanaryServiceObject);
const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject)
newObjectsList.push(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)
canaryDeploymentHelper.getStableResource(inputObject);
newObjectsList.push(newStableServiceObject);
core.debug('Creating the traffic object for service: ' + name)
core.debug("Creating the traffic object for service: " + name);
const trafficObject = await createTrafficSplitManifestFile(
kubectl,
name,
0,
0,
1000
)
);
trafficObjectsList.push(trafficObject)
trafficObjectsList.push(trafficObject);
} else {
let updateTrafficObject = true
let updateTrafficObject = true;
const trafficObject = await canaryDeploymentHelper.fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name)
)
);
if (trafficObject) {
const trafficJObject = JSON.parse(
JSON.stringify(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'
canaryDeploymentHelper.getCanaryResourceName(name) &&
s.weight === "1000m"
) {
core.debug('Update traffic objcet not required')
updateTrafficObject = false
core.debug("Update traffic objcet not required");
updateTrafficObject = false;
}
})
});
}
}
if (updateTrafficObject) {
core.debug(
'Stable service object present so updating the traffic object for service: ' +
"Stable service object present so updating the traffic object for service: " +
name
)
trafficObjectsList.push(
updateTrafficSplitObject(kubectl, name)
)
);
trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
}
}
}
}
}
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...trafficObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
manifestFiles.push(...trafficObjectsList);
const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(manifestFiles, forceDeployment)
checkForErrors([result])
const result = await kubectl.apply(manifestFiles, forceDeployment);
checkForErrors([result]);
}
export async function redirectTrafficToCanaryDeployment(
kubectl: Kubectl,
manifestFilePaths: string[]
) {
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000)
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000);
}
export async function redirectTrafficToStableDeployment(
kubectl: Kubectl,
manifestFilePaths: string[]
) {
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0);
}
async function adjustTraffic(
@@ -191,16 +182,16 @@ async function adjustTraffic(
canaryWeight: number
) {
if (!manifestFilePaths || manifestFilePaths?.length == 0) {
return
return;
}
const trafficSplitManifests = []
const trafficSplitManifests = [];
for (const filePath of manifestFilePaths) {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
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
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (isServiceEntity(kind)) {
trafficSplitManifests.push(
@@ -211,47 +202,47 @@ async function adjustTraffic(
0,
canaryWeight
)
)
);
}
}
}
if (trafficSplitManifests.length <= 0) {
return
return;
}
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(trafficSplitManifests, forceDeployment)
checkForErrors([result])
const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(trafficSplitManifests, forceDeployment);
checkForErrors([result]);
}
async function updateTrafficSplitObject(
kubectl: Kubectl,
serviceName: string
): Promise<string> {
const percentage = parseInt(core.getInput('percentage'))
const percentage = parseInt(core.getInput("percentage"));
if (percentage < 0 || percentage > 100)
throw Error('Percentage must be between 0 and 100')
throw Error("Percentage must be between 0 and 100");
const percentageWithMuliplier = percentage * 10
const baselineAndCanaryWeight = percentageWithMuliplier / 2
const stableDeploymentWeight = 1000 - percentageWithMuliplier
const percentageWithMuliplier = percentage * 10;
const baselineAndCanaryWeight = percentageWithMuliplier / 2;
const stableDeploymentWeight = 1000 - percentageWithMuliplier;
core.debug(
'Creating the traffic object with canary weight: ' +
"Creating the traffic object with canary weight: " +
baselineAndCanaryWeight +
',baseling weight: ' +
",baseling weight: " +
baselineAndCanaryWeight +
',stable: ' +
",stable: " +
stableDeploymentWeight
)
);
return await createTrafficSplitManifestFile(
kubectl,
serviceName,
stableDeploymentWeight,
baselineAndCanaryWeight,
baselineAndCanaryWeight
)
);
}
async function createTrafficSplitManifestFile(
@@ -267,64 +258,62 @@ async function createTrafficSplitManifestFile(
stableWeight,
baselineWeight,
canaryWeight
)
);
const manifestFile = fileHelper.writeManifestToFile(
smiObjectString,
TRAFFIC_SPLIT_OBJECT,
serviceName
)
);
if (!manifestFile) {
throw new Error('Unable to create traffic split manifest file')
throw new Error("Unable to create traffic split manifest file");
}
return manifestFile
return manifestFile;
}
let trafficSplitAPIVersion = ''
let trafficSplitAPIVersion = "";
async function getTrafficSplitObject(
kubectl: Kubectl,
name: string,
stableWeight: number,
baselineWeight: number,
canaryWeight: number,
annotations: {[key: string]: string} = {}
canaryWeight: number
): Promise<string> {
// cached version
if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
);
}
return JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: 'TrafficSplit',
kind: "TrafficSplit",
metadata: {
name: getTrafficSplitResourceName(name),
annotations: annotations
},
spec: {
backends: [
{
service: canaryDeploymentHelper.getStableResourceName(name),
weight: stableWeight
weight: stableWeight,
},
{
service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight
weight: baselineWeight,
},
{
service: canaryDeploymentHelper.getCanaryResourceName(name),
weight: canaryWeight
}
weight: canaryWeight,
},
],
service: name
}
})
service: name,
},
});
}
function getTrafficSplitResourceName(name: string) {
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX;
}
+89 -97
View File
@@ -1,136 +1,130 @@
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as canaryDeploymentHelper from './canary/canaryHelper'
import * as models from '../types/kubernetesTypes'
import {isDeploymentEntity} from '../types/kubernetesTypes'
import * as fileHelper from '../utilities/fileUtils'
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
import {Kubectl, Resource} from '../types/kubectl'
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as canaryDeploymentHelper from "./canary/canaryHelper";
import * as models from "../types/kubernetesTypes";
import { isDeploymentEntity } from "../types/kubernetesTypes";
import * as fileHelper from "../utilities/fileUtils";
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import { Kubectl, Resource } from "../types/kubectl";
import {deployPodCanary} from './canary/podCanaryHelper'
import {deploySMICanary} from './canary/smiCanaryHelper'
import {DeploymentConfig} from '../types/deploymentConfig'
import {deployBlueGreenService} from './blueGreen/serviceBlueGreenHelper'
import {deployBlueGreenIngress} from './blueGreen/ingressBlueGreenHelper'
import {deployBlueGreenSMI} from './blueGreen/smiBlueGreenHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from '@actions/core'
import { deployPodCanary } from "./canary/podCanaryHelper";
import { deploySMICanary } from "./canary/smiCanaryHelper";
import { DeploymentConfig } from "../types/deploymentConfig";
import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper";
import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper";
import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper";
import { DeploymentStrategy } from "../types/deploymentStrategy";
import * as core from "@actions/core";
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
import {ExecOutput} from '@actions/exec'
TrafficSplitMethod,
} from "../types/trafficSplitMethod";
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
import { ExecOutput } from "@actions/exec";
import {
getWorkflowAnnotationKeyLabel,
getWorkflowAnnotations,
cleanLabel
} from '../utilities/workflowAnnotationUtils'
} from "../utilities/workflowAnnotationUtils";
import {
annotateChildPods,
checkForErrors,
getLastSuccessfulRunSha
} from '../utilities/kubectlUtils'
getLastSuccessfulRunSha,
} from "../utilities/kubectlUtils";
import {
getWorkflowFilePath,
normalizeWorkflowStrLabel
} from '../utilities/githubUtils'
import {getDeploymentConfig} from '../utilities/dockerUtils'
normalizeWorkflowStrLabel,
} from "../utilities/githubUtils";
import { getDeploymentConfig } from "../utilities/dockerUtils";
export async function deployManifests(
files: string[],
deploymentStrategy: DeploymentStrategy,
kubectl: Kubectl,
trafficSplitMethod: TrafficSplitMethod,
annotations: {[key: string]: string} = {}
trafficSplitMethod: TrafficSplitMethod
): Promise<string[]> {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: {
const { result, newFilePaths } =
trafficSplitMethod == TrafficSplitMethod.SMI
? await deploySMICanary(files, kubectl)
: await deployPodCanary(files, kubectl)
: await deployPodCanary(files, kubectl);
checkForErrors([result])
return newFilePaths
checkForErrors([result]);
return newFilePaths;
}
case DeploymentStrategy.BLUE_GREEN: {
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
core.getInput("route-method", { required: true })
);
const { result, newFilePaths } = await Promise.resolve(
(routeStrategy == RouteStrategy.INGRESS &&
deployBlueGreenIngress(kubectl, files)) ||
(routeStrategy == RouteStrategy.SMI &&
deployBlueGreenSMI(kubectl, files, annotations)) ||
deployBlueGreenSMI(kubectl, files)) ||
deployBlueGreenService(kubectl, files)
)
);
checkForErrors([result])
return newFilePaths
checkForErrors([result]);
return newFilePaths;
}
case DeploymentStrategy.BASIC: {
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
const updatedManifests = appendStableVersionLabelToResource(files)
const result = await kubectl.apply(
updatedManifests,
forceDeployment
)
checkForErrors([result])
} else {
const result = await kubectl.apply(files, forceDeployment)
checkForErrors([result])
case undefined: {
core.warning("Deployment strategy is not recognized.");
}
return files
}
default: {
throw new Error('Deployment strategy is not recognized.')
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true })
);
const forceDeployment = core.getInput("force").toLowerCase() === "true";
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
const updatedManifests = appendStableVersionLabelToResource(files);
const result = await kubectl.apply(updatedManifests, forceDeployment);
checkForErrors([result]);
} else {
const result = await kubectl.apply(files, forceDeployment);
checkForErrors([result]);
}
return files;
}
}
}
function appendStableVersionLabelToResource(files: string[]): string[] {
const manifestFiles = []
const newObjectsList = []
const manifestFiles = [];
const newObjectsList = [];
files.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, function (inputObject) {
const {kind} = inputObject
const { kind } = inputObject;
if (isDeploymentEntity(kind)) {
const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject)
canaryDeploymentHelper.markResourceAsStable(inputObject);
newObjectsList.push(updatedObject);
} else {
manifestFiles.push(filePath)
manifestFiles.push(filePath);
}
})
})
});
});
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...updatedManifestFiles)
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
manifestFiles.push(...updatedManifestFiles);
return manifestFiles
return manifestFiles;
}
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[]
): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
}
export async function annotateAndLabelResources(
@@ -139,11 +133,11 @@ export async function annotateAndLabelResources(
resourceTypes: Resource[],
allPods: any
) {
const githubToken = core.getInput('token')
const workflowFilePath = await getWorkflowFilePath(githubToken)
const githubToken = core.getInput("token");
const workflowFilePath = await getWorkflowFilePath(githubToken);
const deploymentConfig = await getDeploymentConfig()
const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath)
const deploymentConfig = await getDeploymentConfig();
const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath);
await annotateResources(
files,
@@ -153,8 +147,8 @@ export async function annotateAndLabelResources(
annotationKeyLabel,
workflowFilePath,
deploymentConfig
)
await labelResources(files, kubectl, annotationKeyLabel)
);
await labelResources(files, kubectl, annotationKeyLabel);
}
async function annotateResources(
@@ -166,36 +160,34 @@ async function annotateResources(
workflowFilePath: string,
deploymentConfig: DeploymentConfig
) {
const annotateResults: ExecOutput[] = []
const namespace = core.getInput('namespace') || 'default'
const annotateResults: ExecOutput[] = [];
const namespace = core.getInput("namespace") || "default";
const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl,
namespace,
annotationKey
)
);
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
lastSuccessSha,
workflowFilePath,
deploymentConfig
)}`
)}`;
const annotateNamespace = !(
core.getInput('annotate-namespace').toLowerCase() === 'false'
)
const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false");
if (annotateNamespace) {
annotateResults.push(
await kubectl.annotate('namespace', namespace, annotationKeyValStr)
)
await kubectl.annotate("namespace", namespace, annotationKeyValStr)
);
}
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr))
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr));
for (const resource of resourceTypes) {
if (
resource.type.toLowerCase() !==
models.KubernetesWorkload.POD.toLowerCase()
) {
;(
(
await annotateChildPods(
kubectl,
resource.type,
@@ -203,11 +195,11 @@ async function annotateResources(
annotationKeyValStr,
allPods
)
).forEach((execResult) => annotateResults.push(execResult))
).forEach((execResult) => annotateResults.push(execResult));
}
}
checkForErrors(annotateResults, true)
checkForErrors(annotateResults, true);
}
async function labelResources(
@@ -216,11 +208,11 @@ async function labelResources(
label: string
) {
const labels = [
`workflowFriendlyName=${cleanLabel(
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
`workflowFriendlyName=${normalizeWorkflowStrLabel(
process.env.GITHUB_WORKFLOW
)}`,
`workflow=${cleanLabel(label)}`
]
`workflow=${label}`,
];
checkForErrors([await kubectl.labelFiles(files, labels)], true)
checkForErrors([await kubectl.labelFiles(files, labels)], true);
}
+18 -18
View File
@@ -1,22 +1,22 @@
import {Action, parseAction} from './action'
import { Action, parseAction } from "./action";
describe('Action type', () => {
test('it has required values', () => {
const vals = <any>Object.values(Action)
expect(vals.includes('deploy')).toBe(true)
expect(vals.includes('promote')).toBe(true)
expect(vals.includes('reject')).toBe(true)
})
describe("Action type", () => {
test("it has required values", () => {
const vals = <any>Object.values(Action);
expect(vals.includes("deploy")).toBe(true);
expect(vals.includes("promote")).toBe(true);
expect(vals.includes("reject")).toBe(true);
});
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)
})
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);
});
test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction('invalid')).toBe(undefined)
expect(parseAction('unsupportedType')).toBe(undefined)
})
})
expect(parseAction("invalid")).toBe(undefined);
expect(parseAction("unsupportedType")).toBe(undefined);
});
});
+4 -4
View File
@@ -1,7 +1,7 @@
export enum Action {
DEPLOY = 'deploy',
PROMOTE = 'promote',
REJECT = 'reject'
DEPLOY = "deploy",
PROMOTE = "promote",
REJECT = "reject",
}
/**
@@ -14,4 +14,4 @@ export const parseAction = (str: string): Action | undefined =>
Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof Action
]
];
-8
View File
@@ -1,8 +0,0 @@
export function parseAnnotations(str: string) {
if (str == '') {
return {}
} else {
const annotaion = JSON.parse(str)
return new Map(annotaion)
}
}
+3 -3
View File
@@ -1,5 +1,5 @@
export interface DeploymentConfig {
manifestFilePaths: string[]
helmChartFilePaths: string[]
dockerfilePaths: any
manifestFilePaths: string[];
helmChartFilePaths: string[];
dockerfilePaths: any;
}
+21 -19
View File
@@ -1,25 +1,27 @@
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy'
import {
DeploymentStrategy,
parseDeploymentStrategy,
} from "./deploymentStrategy";
describe('Deployment strategy type', () => {
test('it has required values', () => {
const vals = <any>Object.values(DeploymentStrategy)
expect(vals.includes('canary')).toBe(true)
expect(vals.includes('blue-green')).toBe(true)
expect(vals.includes('basic')).toBe(true)
})
describe("Deployment strategy type", () => {
test("it has required values", () => {
const vals = <any>Object.values(DeploymentStrategy);
expect(vals.includes("canary")).toBe(true);
expect(vals.includes("blue-green")).toBe(true);
});
test('it can parse valid values from a string', () => {
expect(parseDeploymentStrategy('blue-green')).toBe(
test("it can parse valid values from a string", () => {
expect(parseDeploymentStrategy("blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('Blue-green')).toBe(
);
expect(parseDeploymentStrategy("Blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe(
);
expect(parseDeploymentStrategy("BLUE-GREEN")).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('blue-greeN')).toBe(
);
expect(parseDeploymentStrategy("blue-greeN")).toBe(
DeploymentStrategy.BLUE_GREEN
)
})
})
);
});
});
+3 -4
View File
@@ -1,7 +1,6 @@
export enum DeploymentStrategy {
BASIC = 'basic',
CANARY = 'canary',
BLUE_GREEN = 'blue-green'
CANARY = "canary",
BLUE_GREEN = "blue-green",
}
/**
@@ -17,4 +16,4 @@ export const parseDeploymentStrategy = (
(k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy
]
];
+63 -63
View File
@@ -1,98 +1,98 @@
import {DockerExec} from './docker'
import * as actions from '@actions/exec'
import { DockerExec } from "./docker";
import * as actions from "@actions/exec";
const dockerPath = 'dockerPath'
const image = 'image'
const args = ['arg1', 'arg2', 'arg3']
const dockerPath = "dockerPath";
const image = "image";
const args = ["arg1", "arg2", "arg3"];
describe('Docker class', () => {
const docker = new DockerExec(dockerPath)
describe("Docker class", () => {
const docker = new DockerExec(dockerPath);
describe('with a success exec return', () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
describe("with a success exec return", () => {
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn;
});
});
test('pulls an image', async () => {
await docker.pull(image, args)
test("pulls an image", async () => {
await docker.pull(image, args);
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['pull', image, ...args],
["pull", image, ...args],
{ silent: false }
)
})
);
});
test('pulls an image silently', async () => {
await docker.pull(image, args, true)
test("pulls an image silently", async () => {
await docker.pull(image, args, true);
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['pull', image, ...args],
["pull", image, ...args],
{ silent: true }
)
})
);
});
test('inspects a docker image', async () => {
const result = await docker.inspect(image, args)
expect(result).toBe(execReturn.stdout)
test("inspects a docker image", async () => {
const result = await docker.inspect(image, args);
expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['inspect', image, ...args],
["inspect", image, ...args],
{ silent: false }
)
})
);
});
test('inspects a docker image silently', async () => {
const result = await docker.inspect(image, args, true)
expect(result).toBe(execReturn.stdout)
test("inspects a docker image silently", async () => {
const result = await docker.inspect(image, args, true);
expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['inspect', image, ...args],
["inspect", image, ...args],
{ silent: true }
)
})
})
);
});
});
describe('with an unsuccessful exec return code', () => {
const execReturn = {exitCode: 3, stdout: '', stderr: ''}
describe("with an unsuccessful exec return code", () => {
const execReturn = { exitCode: 3, stdout: "", stderr: "" };
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn;
});
});
test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow()
})
test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow();
});
test('inspects a docker image', async () => {
test("inspects a docker image", async () => {
const result = await expect(
docker.inspect(image, args)
).rejects.toThrow()
})
})
).rejects.toThrow();
});
});
describe('with an unsuccessful exec return code', () => {
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'}
describe("with an unsuccessful exec return code", () => {
const execReturn = { exitCode: 0, stdout: "", stderr: "Output" };
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn;
});
});
test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow()
})
test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow();
});
test('inspects a docker image', async () => {
test("inspects a docker image", async () => {
const result = await expect(
docker.inspect(image, args)
).rejects.toThrow()
})
})
})
).rejects.toThrow();
});
});
});
+11 -11
View File
@@ -1,16 +1,16 @@
import {getExecOutput} from '@actions/exec'
import { getExecOutput } from "@actions/exec";
export class DockerExec {
private readonly dockerPath: string
private readonly dockerPath: string;
constructor(dockerPath: string) {
this.dockerPath = dockerPath
this.dockerPath = dockerPath;
}
public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(['pull', image, ...args], silent)
if (result.stderr != '' || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`)
const result = await this.execute(["pull", image, ...args], silent);
if (result.stderr != "" || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`);
}
}
@@ -19,14 +19,14 @@ export class DockerExec {
args: string[],
silent: boolean = false
): Promise<string> {
const result = await this.execute(['inspect', image, ...args], silent)
if (result.stderr != '' || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`)
const result = await this.execute(["inspect", image, ...args], silent);
if (result.stderr != "" || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`);
return result.stdout
return result.stdout;
}
private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, {silent})
return await getExecOutput(this.dockerPath, args, { silent });
}
}
+18 -20
View File
@@ -1,40 +1,38 @@
import * as core from '@actions/core'
import {Octokit} from '@octokit/core'
import {Endpoints} from '@octokit/types'
import {retry} from '@octokit/plugin-retry'
import * as core from "@actions/core";
import { Octokit } from "@octokit/core";
import { Endpoints } from "@octokit/types";
import { retry } from "@octokit/plugin-retry";
export const OkStatusCode = 200
export const OkStatusCode = 200;
const RetryOctokit = Octokit.plugin(retry)
const RETRY_COUNT = 5
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows'
const RetryOctokit = Octokit.plugin(retry);
const RETRY_COUNT = 5;
const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows";
type responseType =
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response']
Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
export class GitHubClient {
private readonly repository: string
private readonly token: string
private readonly repository: string;
private readonly token: string;
constructor(repository: string, token: string) {
this.repository = repository
this.token = token
this.repository = repository;
this.token = token;
}
// prettier-ignore
public async getWorkflows(): Promise<responseType> {
const octokit = new RetryOctokit({
auth: this.token,
request: { retries: RETRY_COUNT },
baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com",
})
const [owner, repo] = this.repository.split('/')
});
const [owner, repo] = this.repository.split("/");
core.debug(`Getting workflows for repo: ${this.repository}`)
core.debug(`Getting workflows for repo: ${this.repository}`);
return Promise.resolve(
await octokit.request(requestUrl, {
owner,
repo
repo,
})
)
);
}
}
+209 -245
View File
@@ -1,367 +1,331 @@
import {getKubectlPath, Kubectl} from './kubectl'
import * as exec from '@actions/exec'
import * as io from '@actions/io'
import * as core from '@actions/core'
import * as toolCache from '@actions/tool-cache'
import {config} from 'process'
import { getKubectlPath, Kubectl } from "./kubectl";
import * as exec from "@actions/exec";
import * as io from "@actions/io";
import * as core from "@actions/core";
import * as toolCache from "@actions/tool-cache";
import { config } from "process";
describe('Kubectl path', () => {
const version = '1.1'
const path = 'path'
describe("Kubectl path", () => {
const version = "1.1";
const path = "path";
it('gets the kubectl path', async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
it("gets the kubectl path", async () => {
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
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 () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version)
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path)
it("gets the kubectl path with version", async () => {
jest.spyOn(core, "getInput").mockImplementationOnce(() => version);
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
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow()
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow();
// with verision
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow()
})
})
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow();
});
});
const kubectlPath = 'kubectlPath'
const testNamespace = 'testNamespace'
const defaultNamespace = 'default'
describe('Kubectl class', () => {
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
const kubectlPath = "kubectlPath";
const namespace = "namespace";
describe("Kubectl class", () => {
const kubectl = new Kubectl(kubectlPath, namespace);
describe("with a success exec return", () => {
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
jest.spyOn(exec, "getExecOutput").mockImplementation(async () => {
return execReturn;
});
});
describe('omits default namespace from commands', () => {
it('executes a command without appending --namespace arg', async () => {
// no args
const command = 'command'
expect(await kubectl.executeCommand(command)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(kubectlPath, [command], {
silent: false
})
})
})
})
describe('with a success exec return in testNamespace', () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
it('applies a configuration with a single config path', async () => {
const configPaths = 'configPaths'
const result = await kubectl.apply(configPaths)
expect(result).toBe(execReturn)
it("applies a configuration with a single config path", async () => {
const configPaths = "configPaths";
const result = await kubectl.apply(configPaths);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace],
["apply", "-f", configPaths, "--namespace", namespace],
{ silent: false }
)
})
);
});
it('applies a configuration with multiple config paths', async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3']
const result = await kubectl.apply(configPaths)
expect(result).toBe(execReturn)
it("applies a configuration with multiple config paths", async () => {
const configPaths = ["configPath1", "configPath2", "configPath3"];
const result = await kubectl.apply(configPaths);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'apply',
'-f',
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--namespace',
testNamespace
"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)
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
"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)
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
],
["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)
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
],
["describe", resourceType, resourceName, "--namespace", namespace],
{ silent: true }
)
})
);
});
it('annotates resource', async () => {
const resourceType = 'type'
const resourceName = 'name'
const annotation = 'annotation'
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(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
"annotate",
resourceType,
resourceName,
annotation,
'--overwrite',
'--namespace',
testNamespace
"--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)
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',
"annotate",
"-f",
file,
annotation,
'--overwrite',
'--namespace',
testNamespace
"--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)
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(','),
"annotate",
"-f",
files.join(","),
annotation,
'--overwrite',
'--namespace',
testNamespace
"--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)
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',
"label",
"-f",
file,
...labels,
'--overwrite',
'--namespace',
testNamespace
"--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)
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(','),
"label",
"-f",
files.join(","),
...labels,
'--overwrite',
'--namespace',
testNamespace
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
)
})
);
});
it('gets all pods', async () => {
expect(await kubectl.getAllPods()).toBe(execReturn)
it("gets all pods", async () => {
expect(await kubectl.getAllPods()).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['get', 'pods', '-o', 'json', '--namespace', testNamespace],
["get", "pods", "-o", "json", "--namespace", namespace],
{ silent: true }
)
})
);
});
it('checks rollout status', async () => {
const resourceType = 'type'
const name = 'name'
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',
"rollout",
"status",
`${resourceType}/${name}`,
'--namespace',
testNamespace
"--namespace",
namespace,
],
{ silent: false }
)
})
);
});
it('gets resource', async () => {
const resourceType = 'type'
const name = 'name'
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
it("gets resource", async () => {
const resourceType = "type";
const name = "name";
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'get',
"get",
`${resourceType}/${name}`,
'-o',
'json',
'--namespace',
testNamespace
"-o",
"json",
"--namespace",
namespace,
],
{ silent: false }
)
})
);
});
it('executes a command', async () => {
it("executes a command", async () => {
// no args
const command = 'command'
expect(await kubectl.executeCommand(command)).toBe(execReturn)
const command = "command";
expect(await kubectl.executeCommand(command)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, '--namespace', testNamespace],
[command, "--namespace", namespace],
{ silent: false }
)
);
// with args
const args = 'args'
expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
const args = "args";
expect(await kubectl.executeCommand(command, args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, args, '--namespace', testNamespace],
[command, args, "--namespace", namespace],
{ silent: false }
)
})
);
});
it('deletes with single argument', async () => {
const arg = 'argument'
expect(await kubectl.delete(arg)).toBe(execReturn)
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],
["delete", arg, "--namespace", namespace],
{ silent: false }
)
})
);
});
it('deletes with multiple arguments', async () => {
const args = ['argument1', 'argument2', 'argument3']
expect(await kubectl.delete(args)).toBe(execReturn)
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],
["delete", ...args, "--namespace", namespace],
{ silent: false }
)
})
})
);
});
});
it('gets new replica sets', async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const newReplicaSetName = 'newreplicaset'
const name = 'name'
it("gets new replica sets", async () => {
const newReplicaSetName = "newreplicaset";
const name = "name";
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra',
stderr: ''
}
stdout: newReplicaSetName + name + " " + "extra",
stderr: "",
};
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
return describeReturn
})
jest.spyOn(exec, "getExecOutput").mockImplementationOnce(async () => {
return describeReturn;
});
const deployment = 'deployment'
const result = await kubectl.getNewReplicaSet(deployment)
expect(result).toBe(name)
})
})
const deployment = "deployment";
const result = await kubectl.getNewReplicaSet(deployment);
expect(result).toBe(name);
});
});
+62 -75
View File
@@ -1,27 +1,27 @@
import {ExecOutput, getExecOutput} from '@actions/exec'
import {createInlineArray} from '../utilities/arrayUtils'
import * as core from '@actions/core'
import * as toolCache from '@actions/tool-cache'
import * as io from '@actions/io'
import { ExecOutput, getExecOutput } from "@actions/exec";
import { createInlineArray } from "../utilities/arrayUtils";
import * as core from "@actions/core";
import * as toolCache from "@actions/tool-cache";
import * as io from "@actions/io";
export interface Resource {
name: string
type: string
name: string;
type: string;
}
export class Kubectl {
private readonly kubectlPath: string
private readonly namespace: string
private readonly ignoreSSLErrors: boolean
private readonly kubectlPath: string;
private readonly namespace: string;
private readonly ignoreSSLErrors: boolean;
constructor(
kubectlPath: string,
namespace: string = 'default',
namespace: string = "default",
ignoreSSLErrors: boolean = false
) {
this.kubectlPath = kubectlPath
this.ignoreSSLErrors = !!ignoreSSLErrors
this.namespace = namespace
this.kubectlPath = kubectlPath;
this.ignoreSSLErrors = !!ignoreSSLErrors;
this.namespace = namespace;
}
public async apply(
@@ -30,18 +30,18 @@ export class Kubectl {
): Promise<ExecOutput> {
try {
if (!configurationPaths || configurationPaths?.length === 0)
throw Error('Configuration paths must exist')
throw Error("Configuration paths must exist");
const applyArgs: string[] = [
'apply',
'-f',
createInlineArray(configurationPaths)
]
if (force) applyArgs.push('--force')
"apply",
"-f",
createInlineArray(configurationPaths),
];
if (force) applyArgs.push("--force");
return await this.execute(applyArgs)
return await this.execute(applyArgs);
} catch (err) {
core.debug('Kubectl apply failed:' + err)
core.debug("Kubectl apply failed:" + err);
}
}
@@ -50,29 +50,26 @@ export class Kubectl {
resourceName: string,
silent: boolean = false
): Promise<ExecOutput> {
return await this.execute(
['describe', resourceType, resourceName],
silent
)
return await this.execute(["describe", resourceType, resourceName], silent);
}
public async getNewReplicaSet(deployment: string) {
const result = await this.describe('deployment', deployment, true)
const result = await this.describe("deployment", deployment, true);
let newReplicaSet = ''
let newReplicaSet = "";
if (result?.stdout) {
const stdout = result.stdout.split('\n')
const stdout = result.stdout.split("\n");
stdout.forEach((line: string) => {
const newreplicaset = 'newreplicaset'
const newreplicaset = "newreplicaset";
if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
newReplicaSet = line
.substring(newreplicaset.length)
.trim()
.split(' ')[0]
})
.split(" ")[0];
});
}
return newReplicaSet
return newReplicaSet;
}
public async annotate(
@@ -81,13 +78,13 @@ export class Kubectl {
annotation: string
): Promise<ExecOutput> {
const args = [
'annotate',
"annotate",
resourceType,
resourceName,
annotation,
'--overwrite'
]
return await this.execute(args)
"--overwrite",
];
return await this.execute(args);
}
public async annotateFiles(
@@ -95,13 +92,13 @@ export class Kubectl {
annotation: string
): Promise<ExecOutput> {
const args = [
'annotate',
'-f',
"annotate",
"-f",
createInlineArray(files),
annotation,
'--overwrite'
]
return await this.execute(args)
"--overwrite",
];
return await this.execute(args);
}
public async labelFiles(
@@ -109,73 +106,63 @@ export class Kubectl {
labels: string[]
): Promise<ExecOutput> {
const args = [
'label',
'-f',
"label",
"-f",
createInlineArray(files),
...labels,
'--overwrite'
]
return await this.execute(args)
"--overwrite",
];
return await this.execute(args);
}
public async getAllPods(): Promise<ExecOutput> {
return await this.execute(['get', 'pods', '-o', 'json'], true)
return await this.execute(["get", "pods", "-o", "json"], true);
}
public async checkRolloutStatus(
resourceType: string,
name: string
): Promise<ExecOutput> {
return await this.execute([
'rollout',
'status',
`${resourceType}/${name}`
])
return await this.execute(["rollout", "status", `${resourceType}/${name}`]);
}
public async getResource(
resourceType: string,
name: string
): Promise<ExecOutput> {
return await this.execute([
'get',
`${resourceType}/${name}`,
'-o',
'json'
])
return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]);
}
public executeCommand(command: string, args?: string) {
if (!command) throw new Error('Command must be defined')
return args ? this.execute([command, args]) : this.execute([command])
if (!command) throw new Error("Command must be defined");
return args ? this.execute([command, args]) : this.execute([command]);
}
public delete(args: string | string[]) {
if (typeof args === 'string') return this.execute(['delete', args])
return this.execute(['delete', ...args])
if (typeof args === "string") return this.execute(["delete", args]);
return this.execute(["delete", ...args]);
}
private async execute(args: string[], silent: boolean = false) {
if (this.ignoreSSLErrors) {
args.push('--insecure-skip-tls-verify')
args.push("--insecure-skip-tls-verify");
}
if (this.namespace && this.namespace != 'default') {
args = args.concat(['--namespace', this.namespace])
}
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
return await getExecOutput(this.kubectlPath, args, {silent})
args = args.concat(["--namespace", this.namespace]);
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`);
return await getExecOutput(this.kubectlPath, args, { silent });
}
}
export async function getKubectlPath() {
const version = core.getInput('kubectl-version')
const version = core.getInput("kubectl-version");
const kubectlPath = version
? toolCache.find('kubectl', version)
: await io.which('kubectl', true)
? toolCache.find("kubectl", version)
: await io.which("kubectl", true);
if (!kubectlPath)
throw Error(
'kubectl not found. You must install it before running this action'
)
"kubectl not found. You must install it before running this action"
);
return kubectlPath
return kubectlPath;
}
+75 -77
View File
@@ -9,109 +9,107 @@ import {
ResourceKindNotDefinedError,
ServiceTypes,
WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS
} from './kubernetesTypes'
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS,
} from "./kubernetesTypes";
describe('Kubernetes types', () => {
it('contains kubernetes workloads', () => {
expect(KubernetesWorkload.POD).toBe('Pod')
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset')
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment')
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet')
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet')
expect(KubernetesWorkload.JOB).toBe('job')
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob')
})
describe("Kubernetes types", () => {
it("contains kubernetes workloads", () => {
expect(KubernetesWorkload.POD).toBe("Pod");
expect(KubernetesWorkload.REPLICASET).toBe("Replicaset");
expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment");
expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet");
expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet");
expect(KubernetesWorkload.JOB).toBe("job");
expect(KubernetesWorkload.CRON_JOB).toBe("cronjob");
});
it('contains discovery and load balancer resources', () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service')
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress')
})
it("contains discovery and load balancer resources", () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service");
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress");
});
it('contains service types', () => {
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer')
expect(ServiceTypes.NODE_PORT).toBe('NodePort')
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP')
})
it("contains service types", () => {
expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer");
expect(ServiceTypes.NODE_PORT).toBe("NodePort");
expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP");
});
it('contains deployment types', () => {
it("contains deployment types", () => {
const expected = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset'
]
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true)
})
"deployment",
"replicaset",
"daemonset",
"pod",
"statefulset",
];
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true);
});
it('contains workload types', () => {
it("contains workload types", () => {
const expected = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset',
'job',
'cronjob'
]
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true)
})
"deployment",
"replicaset",
"daemonset",
"pod",
"statefulset",
"job",
"cronjob",
];
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true);
});
it('contains workload types with rollout status', () => {
const expected = ['deployment', 'daemonset', 'statefulset']
it("contains workload types with rollout status", () => {
const expected = ["deployment", "daemonset", "statefulset"];
expect(
expected.every((val) =>
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val)
)
).toBe(true)
})
expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val))
).toBe(true);
});
it('checks if kind is deployment entity', () => {
it("checks if kind is deployment entity", () => {
// throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow(
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
expect(() => isWorkloadEntity(undefined)).toThrow(
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
expect(() => isServiceEntity(undefined)).toThrow(
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
expect(() => isIngressEntity(undefined)).toThrow(
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);
});
});
+45 -45
View File
@@ -1,81 +1,81 @@
export class KubernetesWorkload {
public static POD: string = 'Pod'
public static REPLICASET: string = 'Replicaset'
public static DEPLOYMENT: string = 'Deployment'
public static STATEFUL_SET: string = 'StatefulSet'
public static DAEMON_SET: string = 'DaemonSet'
public static JOB: string = 'job'
public static CRON_JOB: string = 'cronjob'
public static POD: string = "Pod";
public static REPLICASET: string = "Replicaset";
public static DEPLOYMENT: string = "Deployment";
public static STATEFUL_SET: string = "StatefulSet";
public static DAEMON_SET: string = "DaemonSet";
public static JOB: string = "job";
public static CRON_JOB: string = "cronjob";
}
export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = 'service'
public static INGRESS: string = 'ingress'
public static SERVICE: string = "service";
public static INGRESS: string = "ingress";
}
export class ServiceTypes {
public static LOAD_BALANCER: string = 'LoadBalancer'
public static NODE_PORT: string = 'NodePort'
public static CLUSTER_IP: string = 'ClusterIP'
public static LOAD_BALANCER: string = "LoadBalancer";
public static NODE_PORT: string = "NodePort";
public static CLUSTER_IP: string = "ClusterIP";
}
export const DEPLOYMENT_TYPES: string[] = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset'
]
"deployment",
"replicaset",
"daemonset",
"pod",
"statefulset",
];
export const WORKLOAD_TYPES: string[] = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset',
'job',
'cronjob'
]
"deployment",
"replicaset",
"daemonset",
"pod",
"statefulset",
"job",
"cronjob",
];
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
'deployment',
'daemonset',
'statefulset'
]
"deployment",
"daemonset",
"statefulset",
];
export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
if (!kind) throw ResourceKindNotDefinedError;
return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase()
})
return type.toLowerCase() === kind.toLowerCase();
});
}
export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
if (!kind) throw ResourceKindNotDefinedError;
return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase()
)
);
}
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 {
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 NullInputObjectError = Error('Null inputObject')
export const ResourceKindNotDefinedError = Error("Resource kind not defined");
export const NullInputObjectError = Error("Null inputObject");
export const InputObjectKindNotDefinedError = Error(
'Input object kind not defined'
)
"Input object kind not defined"
);
export const InputObjectMetadataNotDefinedError = Error(
'Input object metatada not defined'
)
"Input object metatada not defined"
);
+18 -18
View File
@@ -1,22 +1,22 @@
import {parseRouteStrategy, RouteStrategy} from './routeStrategy'
import { parseRouteStrategy, RouteStrategy } from "./routeStrategy";
describe('Route strategy type', () => {
test('it has required values', () => {
const vals = <any>Object.values(RouteStrategy)
expect(vals.includes('ingress')).toBe(true)
expect(vals.includes('smi')).toBe(true)
expect(vals.includes('service')).toBe(true)
})
describe("Route strategy type", () => {
test("it has required values", () => {
const vals = <any>Object.values(RouteStrategy);
expect(vals.includes("ingress")).toBe(true);
expect(vals.includes("smi")).toBe(true);
expect(vals.includes("service")).toBe(true);
});
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)
})
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);
});
test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy('invalid')).toBe(undefined)
expect(parseRouteStrategy('unsupportedType')).toBe(undefined)
})
})
expect(parseRouteStrategy("invalid")).toBe(undefined);
expect(parseRouteStrategy("unsupportedType")).toBe(undefined);
});
});
+4 -4
View File
@@ -1,7 +1,7 @@
export enum RouteStrategy {
INGRESS = 'ingress',
SMI = 'smi',
SERVICE = 'service'
INGRESS = "ingress",
SMI = "smi",
SERVICE = "service",
}
export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
@@ -9,4 +9,4 @@ export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy
]
];
+20 -17
View File
@@ -1,21 +1,24 @@
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod'
import {
parseTrafficSplitMethod,
TrafficSplitMethod,
} from "./trafficSplitMethod";
describe('Traffic split method type', () => {
test('it has required values', () => {
const vals = <any>Object.values(TrafficSplitMethod)
expect(vals.includes('pod')).toBe(true)
expect(vals.includes('smi')).toBe(true)
})
describe("Traffic split method type", () => {
test("it has required values", () => {
const vals = <any>Object.values(TrafficSplitMethod);
expect(vals.includes("pod")).toBe(true);
expect(vals.includes("smi")).toBe(true);
});
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)
})
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);
});
test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod('invalid')).toBe(undefined)
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined)
})
})
expect(parseTrafficSplitMethod("invalid")).toBe(undefined);
expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined);
});
});
+3 -3
View File
@@ -1,6 +1,6 @@
export enum TrafficSplitMethod {
POD = 'pod',
SMI = 'smi'
POD = "pod",
SMI = "smi",
}
/**
@@ -16,4 +16,4 @@ export const parseTrafficSplitMethod = (
(k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod
]
];
+10 -10
View File
@@ -1,12 +1,12 @@
import {createInlineArray} from './arrayUtils'
import { createInlineArray } from "./arrayUtils";
describe('array utilities', () => {
it('creates an inline array', () => {
const strings = ['str1', 'str2', 'str3']
expect(createInlineArray(strings)).toBe(strings.join(','))
describe("array utilities", () => {
it("creates an inline array", () => {
const strings = ["str1", "str2", "str3"];
expect(createInlineArray(strings)).toBe(strings.join(","));
const string = 'str1'
expect(createInlineArray([string])).toBe(string)
expect(createInlineArray(string)).toBe(string)
})
})
const string = "str1";
expect(createInlineArray([string])).toBe(string);
expect(createInlineArray(string)).toBe(string);
});
});
+3 -3
View File
@@ -1,6 +1,6 @@
export function createInlineArray(str: string | string[]): string {
if (typeof str === 'string') {
return str
if (typeof str === "string") {
return str;
}
return str.join(',')
return str.join(",");
}
+11 -11
View File
@@ -1,15 +1,15 @@
import * as io from '@actions/io'
import {checkDockerPath} from './dockerUtils'
import * as io from "@actions/io";
import { checkDockerPath } from "./dockerUtils";
describe('docker utilities', () => {
it('checks if docker is installed', async () => {
describe("docker utilities", () => {
it("checks if docker is installed", async () => {
// docker installed
const path = 'path'
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
expect(() => checkDockerPath()).not.toThrow()
const path = "path";
jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(() => checkDockerPath()).not.toThrow();
// docker not installed
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => checkDockerPath()).rejects.toThrow()
})
})
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => checkDockerPath()).rejects.toThrow();
});
});
+30 -30
View File
@@ -1,41 +1,41 @@
import * as io from '@actions/io'
import {DeploymentConfig} from '../types/deploymentConfig'
import * as core from '@actions/core'
import {DockerExec} from '../types/docker'
import {getNormalizedPath} from './githubUtils'
import * as io from "@actions/io";
import { DeploymentConfig } from "../types/deploymentConfig";
import * as core from "@actions/core";
import { DockerExec } from "../types/docker";
import { getNormalizedPath } from "./githubUtils";
export async function getDeploymentConfig(): Promise<DeploymentConfig> {
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) =>
getNormalizedPath(helmchart.trim())
)
);
let inputManifestFiles: string[] =
core
.getInput('manifests')
.getInput("manifests")
.split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || []
.filter((manifest) => manifest.trim().length > 0) || [];
if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile)
)
);
}
const imageNames = core.getInput('images').split('\n') || []
const imageDockerfilePathMap: {[id: string]: string} = {}
const imageNames = core.getInput("images").split("\n") || [];
const imageDockerfilePathMap: { [id: string]: string } = {};
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false')
const pullImages = !(core.getInput("pull-images").toLowerCase() === "false");
if (pullImages) {
//Fetching from image label if available
for (const image of imageNames) {
try {
imageDockerfilePathMap[image] = await getDockerfilePath(image)
imageDockerfilePathMap[image] = await getDockerfilePath(image);
} catch (ex) {
core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} `
)
);
}
}
}
@@ -43,33 +43,33 @@ export async function getDeploymentConfig(): Promise<DeploymentConfig> {
return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap
})
dockerfilePaths: imageDockerfilePathMap,
});
}
async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath()
const dockerExec: DockerExec = new DockerExec('docker')
await dockerExec.pull(image, [], false)
await checkDockerPath();
const dockerExec: DockerExec = new DockerExec("docker");
await dockerExec.pull(image, [], false);
const imageInspectResult: string = await dockerExec.inspect(image, [], false)
const imageConfig = JSON.parse(imageInspectResult)[0]
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path'
const imageInspectResult: string = await dockerExec.inspect(image, [], false);
const imageConfig = JSON.parse(imageInspectResult)[0];
const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path";
let pathValue: string = ''
let pathValue: string = "";
if (
imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY]
pathValue = getNormalizedPath(pathLabel)
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY];
pathValue = getNormalizedPath(pathLabel);
}
return Promise.resolve(pathValue)
return Promise.resolve(pathValue);
}
export async function checkDockerPath() {
const dockerPath = await io.which('docker', false)
const dockerPath = await io.which("docker", false);
if (!dockerPath) {
throw new Error('Docker is not installed.')
throw new Error("Docker is not installed.");
}
}
+29 -42
View File
@@ -1,61 +1,48 @@
import {getFilesFromDirectories} from './fileUtils'
import {
getFilesFromDirectories
} from "./fileUtils";
import * as path from 'path'
import * as path from "path";
describe('File utils', () => {
it('detects files in nested directories and ignores non-manifest files and empty dirs', () => {
const testPath = path.join('test', 'unit', 'manifests')
describe("File utils", () => {
it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
const testPath = path.join("test", "unit", "manifests")
const testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = [
'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-service.yml'
const expectedManifests =
[
"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-service.yml"
]
// is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(5)
expect(testSearch).toHaveLength(5);
expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(fileName)
})
})
it('crashes when an invalid file is provided', () => {
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
const goodPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
});
expect(() => {
getFilesFromDirectories([badPath, goodPath])
}).toThrowError()
})
it("crashes when an invalid file is provided", () => {
const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml")
const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir")
expect(() => {getFilesFromDirectories([badPath, goodPath])}).toThrowError()
});
it("doesn't duplicate files when nested dir included", () => {
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'
)
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(
getFilesFromDirectories([outerPath, fileAtOuter, innerPath])
).toHaveLength(5)
})
expect(getFilesFromDirectories([outerPath, fileAtOuter, innerPath])).toHaveLength(5)
})
});
// files that don't exist / nested files that don't exist / something else with non-manifest
// lots of combinations of pointing to a directory and non yaml/yaml file
+35 -42
View File
@@ -1,41 +1,41 @@
import * as fs from 'fs'
import * as path from 'path'
import * as core from '@actions/core'
import * as os from 'os'
import {getCurrentTime} from './timeUtils'
import * as fs from "fs";
import * as path from "path";
import * as core from "@actions/core";
import * as os from "os";
import { getCurrentTime } from "./timeUtils";
export function getTempDirectory(): string {
return process.env['runner.tempDirectory'] || os.tmpdir()
return process.env["runner.tempDirectory"] || os.tmpdir();
}
export function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = []
const newFilePaths = [];
inputObjects.forEach((inputObject: any) => {
try {
const inputObjectString = JSON.stringify(inputObject)
const inputObjectString = JSON.stringify(inputObject);
if (inputObject?.metadata?.name) {
const fileName = getManifestFileName(
inputObject.kind,
inputObject.metadata.name
)
fs.writeFileSync(path.join(fileName), inputObjectString)
newFilePaths.push(fileName)
);
fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName);
} else {
core.debug(
'Input object is not proper K8s resource object. Object: ' +
"Input object is not proper K8s resource object. Object: " +
inputObjectString
)
);
}
} catch (ex) {
core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}`
)
);
}
})
});
return newFilePaths
return newFilePaths;
}
export function writeManifestToFile(
@@ -45,48 +45,44 @@ export function writeManifestToFile(
): string {
if (inputObjectString) {
try {
const fileName = getManifestFileName(kind, name)
fs.writeFileSync(path.join(fileName), inputObjectString)
return fileName
const fileName = getManifestFileName(kind, name);
fs.writeFileSync(path.join(fileName), inputObjectString);
return fileName;
} catch (ex) {
throw Error(
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
)
);
}
}
}
function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`
const tempDirectory = getTempDirectory()
return path.join(tempDirectory, path.basename(filePath))
const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`;
const tempDirectory = getTempDirectory();
return path.join(tempDirectory, path.basename(filePath));
}
export function getFilesFromDirectories(filePaths: string[]): string[] {
export function getFilesFromDirectories(
filePaths: string[]
): string[]{
const fullPathSet: Set<string> = new Set<string>()
filePaths.forEach((fileName) => {
filePaths.forEach((fileName => {
try {
if(fs.lstatSync(fileName).isDirectory()){
recurisveManifestGetter(fileName).forEach((file) => {
fullPathSet.add(file)
})
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
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... `
)
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
}
} catch (ex) {
throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
)
);
}
})
}))
return Array.from(fullPathSet)
}
@@ -98,10 +94,7 @@ function recurisveManifestGetter(dirName: string): string[] {
const fnwd: string = path.join(dirName, fileName)
if(fs.lstatSync(fnwd).isDirectory()){
toRet.push(...recurisveManifestGetter(fnwd))
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
} else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
toRet.push(path.join(dirName, fileName))
} else{
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
@@ -112,5 +105,5 @@ function recurisveManifestGetter(dirName: string): string[] {
}
function getFileExtension(fileName: string){
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
return fileName.slice((fileName.lastIndexOf(".") - 1 >>> 0) + 2)
}
+34 -34
View File
@@ -1,48 +1,48 @@
import {
getNormalizedPath,
isHttpUrl,
normalizeWorkflowStrLabel
} from './githubUtils'
normalizeWorkflowStrLabel,
} from "./githubUtils";
describe('Github utils', () => {
it('normalizes workflow string labels', () => {
const workflowsPath = '.github/workflows/'
describe("Github utils", () => {
it("normalizes workflow string labels", () => {
const workflowsPath = ".github/workflows/";
const path = 'test/path/test'
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path)
expect(normalizeWorkflowStrLabel(path)).toBe(path)
const path = "test/path/test";
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path);
expect(normalizeWorkflowStrLabel(path)).toBe(path);
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath
)
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe(
path + '_' + path
)
})
);
expect(normalizeWorkflowStrLabel(path + " " + path)).toBe(
path + "_" + path
);
});
it('normalizes path', () => {
const httpUrl = 'http://www.test.com'
expect(getNormalizedPath(httpUrl)).toBe(httpUrl)
it("normalizes path", () => {
const httpUrl = "http://www.test.com";
expect(getNormalizedPath(httpUrl)).toBe(httpUrl);
const httpsUrl = 'https://www.test.com'
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl)
const httpsUrl = "https://www.test.com";
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl);
const repo = 'gh_repo'
const sha = 'gh_sha'
const path = 'path'
process.env.GITHUB_REPOSITORY = repo
process.env.GITHUB_SHA = sha
const repo = "gh_repo";
const sha = "gh_sha";
const path = "path";
process.env.GITHUB_REPOSITORY = repo;
process.env.GITHUB_SHA = sha;
expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}`
)
})
);
});
it('checks if url is http', () => {
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)
it("checks if url is http", () => {
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('https://www.test.com')).toBe(true)
expect(isHttpUrl('http://wwww.test.com')).toBe(true)
})
})
expect(isHttpUrl("https://www.test.com")).toBe(true);
expect(isHttpUrl("http://wwww.test.com")).toBe(true);
});
});
+18 -18
View File
@@ -1,54 +1,54 @@
import {GitHubClient, OkStatusCode} from '../types/githubClient'
import * as core from '@actions/core'
import { GitHubClient, OkStatusCode } from "../types/githubClient";
import * as core from "@actions/core";
export async function getWorkflowFilePath(
githubToken: string
): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW
if (!workflowFilePath.startsWith('.github/workflows/')) {
let workflowFilePath = process.env.GITHUB_WORKFLOW;
if (!workflowFilePath.startsWith(".github/workflows/")) {
const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY,
githubToken
)
const response = await githubClient.getWorkflows()
);
const response = await githubClient.getWorkflows();
if (response) {
if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path
break
workflowFilePath = workflow.path;
break;
}
}
}
} 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`)
core.error(`Failed to get response from workflow list API`);
}
}
return Promise.resolve(workflowFilePath)
return Promise.resolve(workflowFilePath);
}
export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = '.github/workflows/'
const workflowsPath = ".github/workflows/";
workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, '')
: workflowName
return workflowName.replace(/ /g, '_')
? workflowName.replace(workflowsPath, "")
: workflowName;
return workflowName.replace(/ /g, "_");
}
export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) {
//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) {
return /^https?:\/\/.*$/.test(url)
return /^https?:\/\/.*$/.test(url);
}
+41 -41
View File
@@ -1,61 +1,61 @@
import * as core from '@actions/core'
import {ExecOutput} from '@actions/exec'
import {checkForErrors} from './kubectlUtils'
import * as core from "@actions/core";
import { ExecOutput } from "@actions/exec";
import { checkForErrors } from "./kubectlUtils";
describe('Kubectl utils', () => {
it('checks for errors', () => {
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0}
describe("Kubectl utils", () => {
it("checks for errors", () => {
const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 };
const successWithStderr: ExecOutput = {
stderr: 'error',
stdout: '',
exitCode: 0
}
stderr: "error",
stdout: "",
exitCode: 0,
};
const failWithExitCode: ExecOutput = {
stderr: '',
stdout: '',
exitCode: 1
}
stderr: "",
stdout: "",
exitCode: 1,
};
const failWithExitWithStderr: ExecOutput = {
stderr: 'error',
stdout: '',
exitCode: 2
}
stderr: "error",
stdout: "",
exitCode: 2,
};
// with throw behavior
expect(() => checkForErrors([success])).not.toThrow()
expect(() => checkForErrors([successWithStderr])).not.toThrow()
expect(() => checkForErrors([success, successWithStderr])).not.toThrow()
expect(() => checkForErrors([failWithExitCode])).toThrow()
expect(() => checkForErrors([failWithExitWithStderr])).toThrow()
expect(() => checkForErrors([success, failWithExitCode])).toThrow()
expect(() => checkForErrors([success])).not.toThrow();
expect(() => checkForErrors([successWithStderr])).not.toThrow();
expect(() => checkForErrors([success, successWithStderr])).not.toThrow();
expect(() => checkForErrors([failWithExitCode])).toThrow();
expect(() => checkForErrors([failWithExitWithStderr])).toThrow();
expect(() => checkForErrors([success, failWithExitCode])).toThrow();
expect(() =>
checkForErrors([successWithStderr, failWithExitCode])
).toThrow()
).toThrow();
expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow()
).toThrow();
expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow()
).toThrow();
// with warn behavior
jest.spyOn(core, 'warning').mockImplementation(() => {})
let warningCalls = 0
expect(() => checkForErrors([success], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(warningCalls)
jest.spyOn(core, "warning").mockImplementation(() => {});
let warningCalls = 0;
expect(() => checkForErrors([success], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(warningCalls);
expect(() => checkForErrors([successWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([successWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() =>
checkForErrors([success, successWithStderr], true)
).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
})
})
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls);
});
});
+27 -31
View File
@@ -1,25 +1,25 @@
import * as core from '@actions/core'
import {ExecOutput} from '@actions/exec'
import {Kubectl} from '../types/kubectl'
import * as core from "@actions/core";
import { ExecOutput } from "@actions/exec";
import { Kubectl } from "../types/kubectl";
export function checkForErrors(
execResults: ExecOutput[],
warnIfError?: boolean
) {
let stderr = ''
let stderr = "";
execResults.forEach((result) => {
if (result?.exitCode !== 0) {
stderr += result?.stderr + ' \n'
stderr += result?.stderr + " \n";
} else if (result?.stderr) {
core.warning(result.stderr)
core.warning(result.stderr);
}
})
});
if (stderr.length > 0) {
if (warnIfError) {
core.warning(stderr.trim())
core.warning(stderr.trim());
} else {
throw new Error(stderr.trim())
throw new Error(stderr.trim());
}
}
}
@@ -30,22 +30,22 @@ export async function getLastSuccessfulRunSha(
annotationKey: string
): Promise<string> {
try {
const result = await kubectl.getResource('namespace', namespaceName)
const result = await kubectl.getResource("namespace", namespaceName);
if (result?.stderr) {
core.warning(result.stderr)
return process.env.GITHUB_SHA
core.warning(result.stderr);
return process.env.GITHUB_SHA;
} else if (result?.stdout) {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations
const annotationsSet = JSON.parse(result.stdout).metadata.annotations;
if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit
.commit;
} else {
return 'NA'
return "NA";
}
}
} catch (ex) {
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`)
return ''
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`);
return "";
}
}
@@ -56,31 +56,27 @@ export async function annotateChildPods(
annotationKeyValStr: string,
allPods
): Promise<ExecOutput[]> {
let owner = resourceName
if (resourceType.toLowerCase().indexOf('deployment') > -1) {
owner = await kubectl.getNewReplicaSet(resourceName)
let owner = resourceName;
if (resourceType.toLowerCase().indexOf("deployment") > -1) {
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
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
kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr)
);
break;
}
}
}
})
});
}
return await Promise.all(commandExecutionResults)
return await Promise.all(commandExecutionResults);
}
+15 -19
View File
@@ -1,20 +1,19 @@
import {KubernetesWorkload} from '../types/kubernetesTypes'
import { KubernetesWorkload } from "../types/kubernetesTypes";
export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null
if (!inputObject?.spec) return null;
if (
inputObject.kind.toLowerCase() ===
KubernetesWorkload.CRON_JOB.toLowerCase()
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
)
return inputObject?.spec?.jobTemplate?.spec?.template?.spec
?.imagePullSecrets
?.imagePullSecrets;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets
return inputObject.spec.imagePullSecrets;
if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets
return inputObject.spec.template.spec.imagePullSecrets;
}
}
@@ -22,27 +21,24 @@ export function setImagePullSecrets(
inputObject: any,
newImagePullSecrets: any
) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return;
if (
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
) {
inputObject.spec.imagePullSecrets = newImagePullSecrets
return
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.spec.imagePullSecrets = newImagePullSecrets;
return;
}
if (
inputObject.kind.toLowerCase() ===
KubernetesWorkload.CRON_JOB.toLowerCase()
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
) {
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
newImagePullSecrets
return
newImagePullSecrets;
return;
}
if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets
return
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
return;
}
}
+24 -26
View File
@@ -2,72 +2,70 @@ import {
InputObjectKindNotDefinedError,
isServiceEntity,
KubernetesWorkload,
NullInputObjectError
} from '../types/kubernetesTypes'
NullInputObjectError,
} from "../types/kubernetesTypes";
export function updateSpecLabels(
inputObject: any,
newLabels: Map<string, string>,
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) {
existingLabels = newLabels
existingLabels = newLabels;
} else {
existingLabels = existingLabels || new Map<string, string>()
existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
);
}
setSpecLabels(inputObject, existingLabels)
setSpecLabels(inputObject, existingLabels);
}
function getSpecLabels(inputObject: any) {
if (!inputObject) return null
if (!inputObject) return null;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels
return inputObject.metadata.labels;
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) {
if (!inputObject || !newLabels) return null
if (!inputObject || !newLabels) return null;
if (
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
) {
inputObject.metadata.labels = newLabels
return
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.metadata.labels = newLabels;
return;
}
if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels
return
inputObject.spec.template.metatada.labels = newLabels;
return;
}
}
export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector
else return inputObject.spec.selector.matchLabels
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector;
else return inputObject.spec.selector.matchLabels;
}
}
export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels
else inputObject.spec.selector.matchLabels = newLabels
inputObject.spec.selector = newLabels;
else inputObject.spec.selector.matchLabels = newLabels;
}
}
+69 -74
View File
@@ -1,16 +1,16 @@
import * as core from '@actions/core'
import * as KubernetesConstants from '../types/kubernetesTypes'
import {Kubectl, Resource} from '../types/kubectl'
import {checkForErrors} from './kubectlUtils'
import {sleep} from './timeUtils'
import * as core from "@actions/core";
import * as KubernetesConstants from "../types/kubernetesTypes";
import { Kubectl, Resource } from "../types/kubectl";
import { checkForErrors } from "./kubectlUtils";
import { sleep } from "./timeUtils";
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[]
): Promise<void> {
let rolloutStatusHasErrors = false
let rolloutStatusHasErrors = false;
for (let i = 0; i < resources.length; i++) {
const resource = resources[i]
const resource = resources[i];
if (
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
@@ -21,23 +21,21 @@ export async function checkManifestStability(
const result = await kubectl.checkRolloutStatus(
resource.type,
resource.name
)
checkForErrors([result])
);
checkForErrors([result]);
} catch (ex) {
core.error(ex)
await kubectl.describe(resource.type, resource.name)
rolloutStatusHasErrors = true
core.error(ex);
await kubectl.describe(resource.type, resource.name);
rolloutStatusHasErrors = true;
}
}
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
try {
await checkPodStatus(kubectl, resource.name)
await checkPodStatus(kubectl, resource.name);
} catch (ex) {
core.warning(
`Could not determine pod status: ${JSON.stringify(ex)}`
)
await kubectl.describe(resource.type, resource.name)
core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`);
await kubectl.describe(resource.type, resource.name);
}
}
if (
@@ -45,31 +43,28 @@ export async function checkManifestStability(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
) {
try {
const service = await getService(kubectl, resource.name)
const {spec, status} = service
const service = await getService(kubectl, resource.name);
const { spec, status } = service;
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
if (!isLoadBalancerIPAssigned(status)) {
await waitForServiceExternalIPAssignment(
kubectl,
resource.name
)
await waitForServiceExternalIPAssignment(kubectl, resource.name);
} else {
core.info(
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
)
);
}
}
} catch (ex) {
core.warning(
`Could not determine service status of: ${resource.name} Error: ${ex}`
)
await kubectl.describe(resource.type, resource.name)
);
await kubectl.describe(resource.type, resource.name);
}
}
}
if (rolloutStatusHasErrors) {
throw new Error('Rollout status error')
throw new Error("Rollout status error");
}
}
@@ -77,113 +72,113 @@ export async function checkPodStatus(
kubectl: Kubectl,
podName: string
): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout
const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout
let podStatus
let kubectlDescribeNeeded = false
let podStatus;
let kubectlDescribeNeeded = false;
for (let i = 0; i < iterations; i++) {
await sleep(sleepTimeout)
await sleep(sleepTimeout);
core.debug(`Polling for pod status: ${podName}`)
podStatus = await getPodStatus(kubectl, podName)
core.debug(`Polling for pod status: ${podName}`);
podStatus = await getPodStatus(kubectl, podName);
if (
podStatus &&
podStatus?.phase !== 'Pending' &&
podStatus?.phase !== 'Unknown'
podStatus?.phase !== "Pending" &&
podStatus?.phase !== "Unknown"
) {
break
break;
}
}
podStatus = await getPodStatus(kubectl, podName)
podStatus = await getPodStatus(kubectl, podName);
switch (podStatus.phase) {
case 'Succeeded':
case 'Running':
case "Succeeded":
case "Running":
if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`)
console.log(`pod/${podName} is successfully rolled out`);
} else {
kubectlDescribeNeeded = true
kubectlDescribeNeeded = true;
}
break
case 'Pending':
break;
case "Pending":
if (!isPodReady(podStatus)) {
core.warning(`pod/${podName} rollout status check timed out`)
kubectlDescribeNeeded = true
core.warning(`pod/${podName} rollout status check timed out`);
kubectlDescribeNeeded = true;
}
break
case 'Failed':
core.error(`pod/${podName} rollout failed`)
kubectlDescribeNeeded = true
break
break;
case "Failed":
core.error(`pod/${podName} rollout failed`);
kubectlDescribeNeeded = true;
break;
default:
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`)
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
}
if (kubectlDescribeNeeded) {
await kubectl.describe('pod', podName)
await kubectl.describe("pod", podName);
}
}
async function getPodStatus(kubectl: Kubectl, podName: string) {
const podResult = await kubectl.getResource('pod', podName)
checkForErrors([podResult])
const podResult = await kubectl.getResource("pod", podName);
checkForErrors([podResult]);
return JSON.parse(podResult.stdout).status
return JSON.parse(podResult.stdout).status;
}
function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true
let allContainersAreReady = true;
podStatus.containerStatuses.forEach((container) => {
if (container.ready === false) {
core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}`
)
allContainersAreReady = false
);
allContainersAreReady = false;
}
})
});
if (!allContainersAreReady) {
core.warning('All containers not in ready state')
core.warning("All containers not in ready state");
}
return allContainersAreReady
return allContainersAreReady;
}
async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
serviceName
)
);
checkForErrors([serviceResult])
return JSON.parse(serviceResult.stdout)
checkForErrors([serviceResult]);
return JSON.parse(serviceResult.stdout);
}
async function waitForServiceExternalIPAssignment(
kubectl: Kubectl,
serviceName: string
): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
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 : ${serviceName}`)
await sleep(sleepTimeout)
core.info(`Wait for service ip assignment : ${serviceName}`);
await sleep(sleepTimeout);
const status = (await getService(kubectl, serviceName)).status
const status = (await getService(kubectl, serviceName)).status;
if (isLoadBalancerIPAssigned(status)) {
core.info(
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
)
return
);
return;
}
}
core.warning(`Wait for service ip assignment timed out${serviceName}`)
core.warning(`Wait for service ip assignment timed out${serviceName}`);
}
function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0
return status?.loadBalancer?.ingress?.length > 0;
}
+104 -107
View File
@@ -1,65 +1,65 @@
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as path from 'path'
import * as fileHelper from './fileUtils'
import {getTempDirectory} from './fileUtils'
import * as core from "@actions/core";
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as path from "path";
import * as fileHelper from "./fileUtils";
import { getTempDirectory } from "./fileUtils";
import {
InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError,
isWorkloadEntity,
KubernetesWorkload,
NullInputObjectError
} from '../types/kubernetesTypes'
NullInputObjectError,
} from "../types/kubernetesTypes";
import {
getSpecSelectorLabels,
setSpecSelectorLabels
} from './manifestSpecLabelUtils'
setSpecSelectorLabels,
} from "./manifestSpecLabelUtils";
import {
getImagePullSecrets,
setImagePullSecrets
} from './manifestPullSecretUtils'
import {Resource} from '../types/kubectl'
setImagePullSecrets,
} from "./manifestPullSecretUtils";
import { Resource } from "../types/kubectl";
export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) {
throw new Error('Manifest files not provided')
throw new Error("Manifest files not provided");
}
// update container images
const containers: string[] = core.getInput('images').split('\n')
const containers: string[] = core.getInput("images").split("\n");
const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths,
containers
)
);
// update pull secrets
const imagePullSecrets: string[] = core
.getInput('imagepullsecrets')
.split('\n')
.filter((secret) => secret.trim().length > 0)
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets)
.getInput("imagepullsecrets")
.split("\n")
.filter((secret) => secret.trim().length > 0);
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets);
}
export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) {
return
return;
}
// Unset cluster specific details in the object
if (!!resource) {
const {metadata, status} = resource
const { metadata, status } = resource;
if (!!metadata) {
resource.metadata = {
annotations: metadata.annotations,
labels: metadata.labels,
name: metadata.name
}
name: metadata.name,
};
}
if (!!status) {
resource.status = {}
resource.status = {};
}
}
}
@@ -68,18 +68,18 @@ function updateContainerImagesInManifestFiles(
filePaths: string[],
containers: string[]
): string[] {
if (filePaths?.length <= 0) return filePaths
if (filePaths?.length <= 0) return filePaths;
const newFilePaths = []
const newFilePaths = [];
// update container images
filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString()
let contents = fs.readFileSync(filePath).toString();
containers.forEach((container: string) => {
let [imageName] = container.split(':')
if (imageName.indexOf('@') > 0) {
imageName = imageName.split('@')[0]
let [imageName] = container.split(":");
if (imageName.indexOf("@") > 0) {
imageName = imageName.split("@")[0];
}
if (contents.indexOf(imageName) > 0)
@@ -87,17 +87,17 @@ function updateContainerImagesInManifestFiles(
contents,
imageName,
container
)
})
);
});
// write updated files
const tempDirectory = getTempDirectory()
const fileName = path.join(tempDirectory, path.basename(filePath))
fs.writeFileSync(path.join(fileName), contents)
newFilePaths.push(fileName)
})
const tempDirectory = getTempDirectory();
const fileName = path.join(tempDirectory, path.basename(filePath));
fs.writeFileSync(path.join(fileName), contents);
newFilePaths.push(fileName);
});
return newFilePaths
return newFilePaths;
}
/*
@@ -116,45 +116,45 @@ export function substituteImageNameInSpecFile(
imageName: string,
imageNameWithNewTag: string
) {
if (spec.indexOf(imageName) < 0) return spec
if (spec.indexOf(imageName) < 0) return spec;
return spec.split('\n').reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/)
return spec.split("\n").reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/);
if (imageKeyword) {
let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing
.split(':')
.replace(/[',"]/g, "") // replace allowed quotes with nothing
.split(":");
if (currentImageName?.indexOf(' ') > 0) {
currentImageName = currentImageName.split(' ')[0] // remove comments
if (currentImageName?.indexOf(" ") > 0) {
currentImageName = currentImageName.split(" ")[0]; // remove comments
}
if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
}
}
return acc + line + '\n'
}, '')
return acc + line + "\n";
}, "");
}
export function getReplicaCount(inputObject: any): any {
if (!inputObject) throw NullInputObjectError
if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) {
throw InputObjectKindNotDefinedError
throw InputObjectKindNotDefinedError;
}
const {kind} = inputObject
const { kind } = inputObject;
if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
)
return inputObject.spec.replicas
return inputObject.spec.replicas;
return 0
return 0;
}
export function updateObjectLabels(
@@ -162,23 +162,23 @@ export function updateObjectLabels(
newLabels: Map<string, string>,
override: boolean = false
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject) throw NullInputObjectError;
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
if (!newLabels) return
if (!newLabels) return;
if (override) {
inputObject.metadata.labels = newLabels
inputObject.metadata.labels = newLabels;
} else {
let existingLabels =
inputObject.metadata.labels || new Map<string, string>()
inputObject.metadata.labels || new Map<string, string>();
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
);
inputObject.metadata.labels = existingLabels
inputObject.metadata.labels = existingLabels;
}
}
@@ -187,23 +187,23 @@ export function updateObjectAnnotations(
newAnnotations: Map<string, string>,
override: boolean = false
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject) throw NullInputObjectError;
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
if (!newAnnotations) return
if (!newAnnotations) return;
if (override) {
inputObject.metadata.annotations = newAnnotations
inputObject.metadata.annotations = newAnnotations;
} else {
const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>()
inputObject.metadata.annotations || new Map<string, string>();
Object.keys(newAnnotations).forEach(
(key) => (existingAnnotations[key] = newAnnotations[key])
)
);
inputObject.metadata.annotations = existingAnnotations
inputObject.metadata.annotations = existingAnnotations;
}
}
@@ -212,27 +212,24 @@ export function updateImagePullSecrets(
newImagePullSecrets: string[],
override: boolean = false
) {
if (!inputObject?.spec || !newImagePullSecrets) return
if (!inputObject?.spec || !newImagePullSecrets) return;
const newImagePullSecretsObjects = Array.from(
newImagePullSecrets,
(name) => {
return {name}
}
)
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => {
return { name };
});
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
if (override) {
existingImagePullSecretObjects = newImagePullSecretsObjects
existingImagePullSecretObjects = newImagePullSecretsObjects;
} else {
existingImagePullSecretObjects = existingImagePullSecretObjects || []
existingImagePullSecretObjects = existingImagePullSecretObjects || [];
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
newImagePullSecretsObjects
)
);
}
setImagePullSecrets(inputObject, existingImagePullSecretObjects)
setImagePullSecrets(inputObject, existingImagePullSecretObjects);
}
export function updateSelectorLabels(
@@ -240,39 +237,39 @@ export function updateSelectorLabels(
newLabels: Map<string, string>,
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;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return
return;
let existingLabels = getSpecSelectorLabels(inputObject)
let existingLabels = getSpecSelectorLabels(inputObject);
if (override) {
existingLabels = newLabels
existingLabels = newLabels;
} else {
existingLabels = existingLabels || new Map<string, string>()
existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
);
}
setSpecSelectorLabels(inputObject, existingLabels)
setSpecSelectorLabels(inputObject, existingLabels);
}
export function getResources(
filePaths: string[],
filterResourceTypes: string[]
): Resource[] {
if (!filePaths) return []
if (!filePaths) return [];
const resources: Resource[] = []
const resources: Resource[] = [];
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => {
const inputObjectKind = inputObject?.kind || ''
const inputObjectKind = inputObject?.kind || "";
if (
filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
@@ -280,34 +277,34 @@ export function getResources(
) {
resources.push({
type: inputObject.kind,
name: inputObject.metadata.name
})
name: inputObject.metadata.name,
});
}
})
})
});
});
return resources
return resources;
}
function updateImagePullSecretsInManifestFiles(
filePaths: string[],
imagePullSecrets: string[]
): string[] {
if (imagePullSecrets?.length <= 0) return filePaths
if (imagePullSecrets?.length <= 0) return filePaths;
const newObjectsList = []
const newObjectsList = [];
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) {
const {kind} = inputObject
const { kind } = inputObject;
if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets)
updateImagePullSecrets(inputObject, imagePullSecrets);
}
newObjectsList.push(inputObject)
newObjectsList.push(inputObject);
}
})
})
});
});
return fileHelper.writeObjectsToFile(newObjectsList)
return fileHelper.writeObjectsToFile(newObjectsList);
}
+2 -2
View File
@@ -1,7 +1,7 @@
export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout))
return new Promise((resolve) => setTimeout(resolve, timeout));
}
export function getCurrentTime(): number {
return new Date().getTime()
return new Date().getTime();
}
+7 -7
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(
kubectl: Kubectl
): Promise<string> {
const result = await kubectl.executeCommand('api-versions')
const result = await kubectl.executeCommand("api-versions");
const trafficSplitAPIVersion = result.stdout
.split('\n')
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix))
.split("\n")
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix));
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;
}
+15 -30
View File
@@ -1,33 +1,18 @@
import {
cleanLabel,
prefixObjectKeys
} from '../utilities/workflowAnnotationUtils'
import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils";
describe('WorkflowAnnotationUtils', () => {
describe('prefixObjectKeys', () => {
it('should prefix an object with a given prefix', () => {
describe("WorkflowAnnotationUtils", () => {
describe("prefixObjectKeys", () => {
it("should prefix an object with a given prefix", () => {
const obj = {
foo: 'bar',
baz: 'qux'
}
const prefix = 'prefix.'
foo: "bar",
baz: "qux",
};
const prefix = "prefix.";
const expected = {
'prefix.foo': 'bar',
'prefix.baz': 'qux'
}
expect(prefixObjectKeys(obj, prefix)).toEqual(expected)
})
})
describe('cleanLabel', () => {
it('should clean label', () => {
const alreadyClean = 'alreadyClean'
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
'withS0MEinvalidchars'
)
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
})
})
})
"prefix.foo": "bar",
"prefix.baz": "qux",
};
expect(prefixObjectKeys(obj, prefix)).toEqual(expected);
});
});
});
+14 -28
View File
@@ -1,12 +1,12 @@
import {DeploymentConfig} from '../types/deploymentConfig'
import { DeploymentConfig } from "../types/deploymentConfig";
const ANNOTATION_PREFIX = 'actions.github.com/'
const ANNOTATION_PREFIX = "actions.github.com/";
export function prefixObjectKeys(obj: any, prefix: string): any {
return Object.keys(obj).reduce((newObj, key) => {
newObj[prefix + key] = obj[key]
return newObj
}, {})
newObj[prefix + key] = obj[key];
return newObj;
}, {});
}
export function getWorkflowAnnotations(
@@ -18,7 +18,7 @@ export function getWorkflowAnnotations(
run: process.env.GITHUB_RUN_ID,
repository: process.env.GITHUB_REPOSITORY,
workflow: process.env.GITHUB_WORKFLOW,
workflowFileName: workflowFilePath.replace('.github/workflows/', ''),
workflowFileName: workflowFilePath.replace(".github/workflows/", ""),
jobName: process.env.GITHUB_JOB,
createdBy: process.env.GITHUB_ACTOR,
runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`,
@@ -29,32 +29,18 @@ export function getWorkflowAnnotations(
dockerfilePaths: deploymentConfig.dockerfilePaths,
manifestsPaths: deploymentConfig.manifestFilePaths,
helmChartPaths: deploymentConfig.helmChartFilePaths,
provider: 'GitHub'
}
const prefixedAnnotationObject = prefixObjectKeys(
annotationObject,
ANNOTATION_PREFIX
)
return JSON.stringify(prefixedAnnotationObject)
provider: "GitHub",
};
const prefixedAnnotationObject = prefixObjectKeys(annotationObject, ANNOTATION_PREFIX);
return JSON.stringify(prefixedAnnotationObject);
}
export function getWorkflowAnnotationKeyLabel(
workflowFilePath: string
): string {
const hashKey = require('crypto')
.createHash('MD5')
const hashKey = require("crypto")
.createHash("MD5")
.update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`)
.digest('hex')
return `githubWorkflow_${hashKey}`
}
/**
* Cleans label to match valid kubernetes label specification by removing invalid characters
* @param label
* @returns cleaned label
*/
export function cleanLabel(label: string): string {
const removedInvalidChars = label.replace(/[^-A-Za-z0-9_.]/gi, '')
const regex = /([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]/
return regex.exec(removedInvalidChars)[0] || ''
.digest("hex");
return `githubWorkflow_${hashKey}`;
}
+6 -10
View File
@@ -9,8 +9,8 @@ image:
pullPolicy: IfNotPresent
imagePullSecrets: []
nameOverride: ''
fullnameOverride: ''
nameOverride: ""
fullnameOverride: ""
serviceAccount:
# Specifies whether a service account should be created
@@ -19,12 +19,10 @@ serviceAccount:
# If not set and create is true, a name is generated using the fullname template
name:
podSecurityContext:
{}
podSecurityContext: {}
# fsGroup: 2000
securityContext:
{}
securityContext: {}
# capabilities:
# drop:
# - ALL
@@ -38,8 +36,7 @@ service:
ingress:
enabled: false
annotations:
{}
annotations: {}
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
hosts:
@@ -50,8 +47,7 @@ ingress:
# hosts:
# - chart-example.local
resources:
{}
resources: {}
# We usually recommend not to specify default resources and to leave this as a conscious
# choice for the user. This also increases chances charts run on environments with little
# resources, such as Minikube. If you do want to specify resources, uncomment the following