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
95 changed files with 15980 additions and 18224 deletions
-36
View File
@@ -1,36 +0,0 @@
name: Bug Report
description: File a bug report specifying all inputs you provided for the action, we will respond to this thread with any questions.
title: 'Bug: '
labels: ['bug', 'triage']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: What-happened
attributes:
label: What happened?
description: Tell us what happened and how is it different from the expected?
placeholder: Tell us what you see!
validations:
required: true
- type: checkboxes
id: Version
attributes:
label: Version
options:
- label: I am using the latest version
required: true
- type: input
id: Runner
attributes:
label: Runner
description: What runner are you using?
placeholder: Mention the runner info (self-hosted, operating system)
validations:
required: true
- type: textarea
id: Logs
attributes:
label: Relevant log output
description: Run in debug mode for the most verbose logs. Please feel free to attach a screenshot of the logs
validations:
required: true
-6
View File
@@ -1,6 +0,0 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Action "k8s-deploy" Support
url: https://github.com/Azure/k8s-deploy
security: https://github.com/Azure/k8s-deploy/blob/main/SECURITY.md
about: Please ask and answer questions here.
@@ -1,13 +0,0 @@
name: Feature Request
description: File a Feature Request form, we will respond to this thread with any questions.
title: 'Feature Request: '
labels: ['Feature']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: Feature_request
attributes:
label: Feature request
description: Provide example functionality and links to relevant docs
validations:
required: true
+2 -1
View File
@@ -1,4 +1,4 @@
name: 'Code scanning - action' name: "Code scanning - action"
on: on:
push: push:
@@ -8,6 +8,7 @@ on:
jobs: jobs:
CodeQL-Build: CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest # CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest runs-on: ubuntu-latest
+2 -1
View File
@@ -3,7 +3,7 @@ name: setting-default-labels
# Controls when the action will run. # Controls when the action will run.
on: on:
schedule: schedule:
- cron: '0 0/3 * * *' - cron: "0 0/3 * * *"
# A workflow run is made up of one or more jobs that can run sequentially or in parallel # A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs: jobs:
@@ -13,6 +13,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job # Steps represent a sequence of tasks that will be executed as part of the job
steps: steps:
- uses: actions/stale@v3 - uses: actions/stale@v3
name: Setting issue as idle name: Setting issue as idle
with: 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: workflow_dispatch:
inputs: inputs:
release: release:
description: 'Define release version (ex: v1, v2, v3)' description: "Define release version (ex: v1, v2, v3)"
required: true required: true
jobs: jobs:
+6 -6
View File
@@ -4,12 +4,12 @@ on:
branches: branches:
- master - master
- main - main
- 'releases/*' - "releases/*"
push: push:
branches: branches:
- master - master
- main - main
- 'releases/*' - "releases/*"
workflow_dispatch: workflow_dispatch:
jobs: jobs:
@@ -43,9 +43,9 @@ jobs:
name: Setup Minikube name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2 uses: manusa/actions-setup-minikube@v2.4.2
with: with:
minikube version: 'v1.24.0' minikube version: "v1.24.0"
kubernetes version: 'v1.17.8' kubernetes version: "v1.17.8"
driver: 'none' driver: "none"
timeout-minutes: 3 timeout-minutes: 3
- name: Create namespace to run tests - name: Create namespace to run tests
@@ -54,7 +54,7 @@ jobs:
- uses: actions/setup-python@v2 - uses: actions/setup-python@v2
name: Install Python name: Install Python
with: with:
python-version: '3.x' python-version: "3.x"
- name: Cleaning any previously created items - name: Cleaning any previously created items
run: | 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 on: # rebuild any PRs and main branch changes
pull_request: pull_request:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
push: push:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
jobs: jobs:
build: # make sure build/ci works properly build: # make sure build/ci works properly
-2
View File
@@ -3,5 +3,3 @@ node_modules
.DS_Store .DS_Store
.idea .idea
lib/ lib/
coverage/
-4
View File
@@ -1,4 +0,0 @@
# dependencies
/node_modules
coverage
/lib
-8
View File
@@ -1,8 +0,0 @@
{
"trailingComma": "none",
"bracketSpacing": false,
"semi": false,
"tabWidth": 3,
"singleQuote": true,
"printWidth": 80
}
+27 -70
View File
@@ -4,15 +4,6 @@ This action is used to deploy manifests to Kubernetes clusters. It requires that
If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
This action requires the following permissions from your workflow:
```yaml
permissions:
id-token: write
contents: read
actions: read
```
## Action capabilities ## Action capabilities
Following are the key capabilities of this action: Following are the key capabilities of this action:
@@ -52,14 +43,6 @@ Following are the key capabilities of this action:
<tr> <tr>
<td>manifests </br></br>(Required)</td> <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> <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>
<tr> <tr>
<td>namespace </br></br>(Optional) <td>namespace </br></br>(Optional)
@@ -79,20 +62,22 @@ Following are the key capabilities of this action:
<td>pull-images</br></br>(Optional)</td> <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> <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>
<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> <tr>
<td>traffic-split-method </br></br>(Optional)</td> <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> <td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>
</tr> </tr>
<tr>
<td>traffic-split-annotations </br></br>(Optional)</td>
<td>Annotations in the form of key/value pair to be added to TrafficSplit.</td>
<tr> <tr>
<td>percentage </br></br>(Optional but required if strategy is canary)</td> <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> <td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td>
</tr> </tr>
<tr> <tr>
<td>baseline-and-canary-replicas </br></br> (Optional and relevant only if strategy is canary and traffic-split-method is smi)</td> <td>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</td>
<td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas each, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td> <td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td>
</tr> </tr>
<tr> <tr>
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
@@ -105,10 +90,6 @@ Following are the key capabilities of this action:
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td> <td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
</tr> </tr>
<tr>
<td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td>
<td>Acceptable values: true, false</br>Default value: false.</td>
</tr>
<tr> <tr>
<td>force </br></br>(Optional)</td> <td>force </br></br>(Optional)</td>
<td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td> <td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
@@ -126,42 +107,22 @@ Following are the key capabilities of this action:
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
manifests: | manifests: |
dir/manifestsDirectory dir/manifestsDirectory
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
``` ```
### Private cluster deployment
```yaml
- uses: Azure/k8s-deploy@v4
with:
resource-group: yourResourceGroup
name: yourClusterName
action: deploy
strategy: basic
private-cluster: true
manifests: |
manifests/azure-vote-backend-deployment.yaml
manifests/azure-vote-backend-service.yaml
manifests/azure-vote-frontend-deployment.yaml
manifests/azure-vote-frontend-service.yaml
images: |
registry.azurecr.io/containername
```
### Canary deployment without service mesh ### Canary deployment without service mesh
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -179,8 +140,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -197,8 +158,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -218,8 +179,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} ' images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -237,8 +198,8 @@ To promote/reject the canary created by the above snippet, the following YAML sn
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -257,8 +218,8 @@ To promote/reject the green workload created by the above snippet, the following
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
@@ -301,7 +262,7 @@ jobs:
# Set the target AKS cluster. # Set the target AKS cluster.
- uses: Azure/aks-set-context@v1 - uses: Azure/aks-set-context@v1
with: with:
creds: '${{ secrets.AZURE_CREDENTIALS }}' creds: "${{ secrets.AZURE_CREDENTIALS }}"
cluster-name: contoso cluster-name: contoso
resource-group: contoso-rg resource-group: contoso-rg
@@ -420,7 +381,7 @@ jobs:
# Set the target AKS cluster. # Set the target AKS cluster.
- uses: Azure/aks-set-context@v1 - uses: Azure/aks-set-context@v1
with: with:
creds: '${{ secrets.AZURE_CREDENTIALS }}' creds: "${{ secrets.AZURE_CREDENTIALS }}"
cluster-name: contoso cluster-name: contoso
resource-group: contoso-rg resource-group: contoso-rg
@@ -434,12 +395,12 @@ jobs:
- uses: azure/k8s-bake@v2 - uses: azure/k8s-bake@v2
with: with:
renderEngine: 'helm' renderEngine: "helm"
helmChart: './aks-helloworld/' helmChart: "./aks-helloworld/"
overrideFiles: './aks-helloworld/values-override.yaml' overrideFiles: "./aks-helloworld/values-override.yaml"
overrides: | overrides: |
replicas:2 replicas:2
helm-version: 'latest' helm-version: "latest"
id: bake id: bake
- uses: Azure/k8s-deploy@v1.2 - uses: Azure/k8s-deploy@v1.2
@@ -471,7 +432,3 @@ provided by the bot. You will only need to do this once across all repos using o
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Support
k8s-deploy is an open source project that is [**not** covered by the Microsoft Azure support policy](https://support.microsoft.com/en-us/help/2941892/support-for-linux-and-open-source-technology-in-azure). [Please search open issues here](https://github.com/Azure/k8s-deploy/issues), and if your issue isn't already represented please [open a new one](https://github.com/Azure/k8s-deploy/issues/new/choose). The project maintainers will respond to the best of their abilities.
+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/). Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>) of a security vulnerability, please report it to us as described below. If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
## Reporting Security Issues ## Reporting Security Issues
@@ -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: Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue * Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL) * The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue * Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue * Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible) * Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue * Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly. This information will help us triage your report more quickly.
+26 -39
View File
@@ -1,80 +1,67 @@
name: 'Deploy to Kubernetes cluster' name: "Deploy to Kubernetes cluster"
description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters' description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters"
inputs: inputs:
# Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action # Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action
# You also need to have kubectl installed (azure/setup-kubectl) # You also need to have kubectl installed (azure/setup-kubectl)
namespace: namespace:
description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.' description: "Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace."
required: false required: false
manifests: manifests:
description: 'Path to the manifest files which will be used for deployment.' description: "Path to the manifest files which will be used for deployment."
required: true required: true
images: images:
description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test' description: "Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test"
required: false required: false
imagepullsecrets: imagepullsecrets:
description: 'Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files' description: "Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files"
required: false required: false
pull-images: pull-images:
description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations" description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations"
required: false required: false
default: true default: true
strategy: strategy:
description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green' description: "Deployment strategy to be used. Allowed values are none, canary and blue-green"
required: true
default: 'basic'
route-method:
description: 'Route based on service, ingress or SMI for blue-green strategy'
required: false 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: version-switch-buffer:
description: 'Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)' description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)"
required: false required: false
default: 0 default: 0
traffic-split-method: traffic-split-method:
description: 'Traffic split method to be used. Allowed values are pod and smi' description: "Traffic split method to be used. Allowed values are pod and smi"
required: false
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'
required: false required: false
default: "pod"
baseline-and-canary-replicas: 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 required: false
default: '' default: 0
percentage: percentage:
description: 'Percentage of traffic redirect to canary deployment' description: "Percentage of traffic redirect to canary deployment"
required: false required: false
default: 0 default: 0
action: action:
description: 'deploy, promote, or reject' description: "deploy, promote, or reject"
required: true required: true
default: 'deploy' default: "deploy"
force: 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 required: false
default: false default: false
token: token:
description: 'Github token' description: "Github token"
default: ${{ github.token }} default: ${{ github.token }}
required: true required: true
annotate-namespace: annotate-namespace:
description: 'Annotate the target namespace' description: "Annotate the target namespace"
required: false required: false
default: true default: true
private-cluster:
description: 'True if cluster is AKS private cluster'
required: false
default: false
resource-group:
description: 'Name of resource group - Only required if using private cluster'
required: false
name:
description: 'Resource group name - Only required if using private cluster'
required: false
branding: branding:
color: 'green' color: "green"
runs: runs:
using: 'node16' using: "node12"
main: 'lib/index.js' main: "lib/index.js"
+1986 -2477
View File
File diff suppressed because it is too large Load Diff
+4 -8
View File
@@ -4,14 +4,11 @@
"author": "Deepak Sattiraju", "author": "Deepak Sattiraju",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"build": "ncc build src/run.ts -o lib", "build": "tsc --outDir ./lib --rootDir ./src",
"test": "jest", "test": "jest"
"coverage": "jest --coverage=true",
"format": "prettier --write .",
"format-check": "prettier --check ."
}, },
"dependencies": { "dependencies": {
"@actions/core": "^1.9.1", "@actions/core": "^1.2.6",
"@actions/exec": "^1.0.0", "@actions/exec": "^1.0.0",
"@actions/io": "^1.0.0", "@actions/io": "^1.0.0",
"@actions/tool-cache": "1.1.2", "@actions/tool-cache": "1.1.2",
@@ -25,8 +22,7 @@
"@types/js-yaml": "^3.12.7", "@types/js-yaml": "^3.12.7",
"@types/node": "^12.20.41", "@types/node": "^12.20.41",
"jest": "^26.0.0", "jest": "^26.0.0",
"prettier": "^2.7.1", "ts-jest": "^25.5.1",
"ts-jest": "^26.0.0",
"typescript": "3.9.5" "typescript": "3.9.5"
} }
} }
+40 -34
View File
@@ -1,18 +1,20 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper";
import { import {
annotateAndLabelResources, annotateAndLabelResources,
checkManifestStability, checkManifestStability,
deployManifests deployManifests,
} from '../strategyHelpers/deploymentHelper' } from "../strategyHelpers/deploymentHelper";
import {DeploymentStrategy} from '../types/deploymentStrategy' import { DeploymentStrategy } from "../types/deploymentStrategy";
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod' import { parseTrafficSplitMethod } from "../types/trafficSplitMethod";
import { parseRouteStrategy } from "../types/routeStrategy";
export async function deploy( export async function deploy(
kubectl: Kubectl, kubectl: Kubectl,
@@ -20,60 +22,64 @@ export async function deploy(
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
// update manifests // update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths) const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths);
core.debug(`Input manifest files: ${inputManifestFiles}`) core.debug("Input manifest files: " + inputManifestFiles);
// deploy manifests // deploy manifests
core.startGroup('Deploying manifests') core.info("Deploying manifests");
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true}) core.getInput("traffic-split-method", { required: true })
) );
const deployedManifestFiles = await deployManifests( const deployedManifestFiles = await deployManifests(
inputManifestFiles, inputManifestFiles,
deploymentStrategy, deploymentStrategy,
kubectl, kubectl,
trafficSplitMethod trafficSplitMethod
) );
core.debug(`Deployed manifest files: ${deployedManifestFiles}`) core.debug("Deployed manifest files: " + deployedManifestFiles);
core.endGroup()
// check manifest stability // check manifest stability
core.startGroup('Checking manifest stability') core.info("Checking manifest stability");
const resourceTypes: Resource[] = getResources( const resourceTypes: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
]) ])
) );
await checkManifestStability(kubectl, resourceTypes) await checkManifestStability(kubectl, resourceTypes);
core.endGroup()
if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
core.info("Routing blue green");
const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true })
);
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy);
}
// print ingresses // print ingresses
core.startGroup('Printing ingresses') core.info("Printing ingresses");
const ingressResources: Resource[] = getResources(deployedManifestFiles, [ const ingressResources: Resource[] = getResources(deployedManifestFiles, [
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
]) ]);
for (const ingressResource of ingressResources) { for (const ingressResource of ingressResources) {
await kubectl.getResource( await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name ingressResource.name
) );
} }
core.endGroup()
// annotate resources // annotate resources
core.startGroup('Annotating resources') core.info("Annotating resources");
let allPods let allPods;
try { try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout) allPods = JSON.parse((await kubectl.getAllPods()).stdout);
} catch (e) { } catch (e) {
core.debug(`Unable to parse pods: ${e}`) core.debug("Unable to parse pods: " + e);
} }
await annotateAndLabelResources( await annotateAndLabelResources(
deployedManifestFiles, deployedManifestFiles,
kubectl, kubectl,
resourceTypes, resourceTypes,
allPods allPods
) );
core.endGroup()
} }
+89 -106
View File
@@ -1,41 +1,41 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as deploy from "./deploy";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as PodCanaryHelper from '../strategyHelpers/canary/podCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import { import {
deleteGreenObjects, BlueGreenManifests,
deleteWorkloadsAndServicesWithLabel,
deleteWorkloadsWithLabel,
getManifestObjects, getManifestObjects,
NONE_LABEL_VALUE GREEN_LABEL_VALUE,
} from '../strategyHelpers/blueGreen/blueGreenHelper' NONE_LABEL_VALUE,
} from "../strategyHelpers/blueGreen/blueGreenHelper";
import {BlueGreenManifests} from '../types/blueGreenTypes' import {
promoteBlueGreenService,
routeBlueGreenService,
} from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import { import {
promoteBlueGreenIngress, promoteBlueGreenIngress,
promoteBlueGreenService, routeBlueGreenIngress,
promoteBlueGreenSMI } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
} from '../strategyHelpers/blueGreen/promote'
import { import {
routeBlueGreenService, cleanupSMI,
routeBlueGreenIngressUnchanged, promoteBlueGreenSMI,
routeBlueGreenSMI routeBlueGreenSMI,
} from '../strategyHelpers/blueGreen/route' } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
import { Kubectl, Resource } from "../types/kubectl";
import {cleanupSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper' import { DeploymentStrategy } from "../types/deploymentStrategy";
import {Kubectl, Resource} from '../types/kubectl'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod TrafficSplitMethod,
} from '../types/trafficSplitMethod' } from "../types/trafficSplitMethod";
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
export async function promote( export async function promote(
kubectl: Kubectl, kubectl: Kubectl,
@@ -44,146 +44,129 @@ export async function promote(
) { ) {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: case DeploymentStrategy.CANARY:
await promoteCanary(kubectl, manifests) await promoteCanary(kubectl, manifests);
break break;
case DeploymentStrategy.BLUE_GREEN: case DeploymentStrategy.BLUE_GREEN:
await promoteBlueGreen(kubectl, manifests) await promoteBlueGreen(kubectl, manifests);
break break;
default: default:
throw Error('Invalid promote deployment strategy') throw Error("Invalid promote deployment strategy");
} }
} }
async function promoteCanary(kubectl: Kubectl, manifests: string[]) { async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false let includeServices = false;
const manifestFilesForDeployment: string[] = updateManifestFiles(manifests)
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true}) core.getInput("traffic-split-method", { required: true })
) );
if (trafficSplitMethod == TrafficSplitMethod.SMI) { 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 // 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 // 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( await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
kubectl, kubectl,
manifests manifests
) );
core.endGroup()
core.startGroup( core.info("Deploying input manifests with SMI canary strategy");
'Deploying input manifests with SMI canary strategy from promote' await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
)
await SMICanaryDeploymentHelper.deploySMICanary(
manifestFilesForDeployment,
kubectl,
true
)
core.endGroup()
core.startGroup('Redirecting traffic to stable deployment') core.info("Redirecting traffic to stable deployment");
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl, kubectl,
manifests manifests
) );
core.endGroup()
} else { } else {
core.startGroup('Deploying input manifests from promote') core.info("Deploying input manifests");
await PodCanaryHelper.deployPodCanary( await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
manifestFilesForDeployment,
kubectl,
true
)
core.endGroup()
} }
core.startGroup('Deleting canary and baseline workloads') core.info("Deleting canary and baseline workloads");
try { try {
await canaryDeploymentHelper.deleteCanaryDeployment( await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl, kubectl,
manifests, manifests,
includeServices includeServices
) );
} catch (ex) { } catch (ex) {
core.warning( 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[]) { async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// update container images and pull secrets // update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests) const inputManifestFiles: string[] = updateManifestFiles(manifests);
const manifestObjects: BlueGreenManifests = const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles) getManifestObjects(inputManifestFiles);
const routeStrategy = parseRouteStrategy( const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true}) core.getInput("route-method", { required: true })
) );
core.startGroup('Deleting old deployment and making new stable deployment') core.info("Deleting old deployment and making new one");
let result;
const {deployResult} = await (async () => { if (routeStrategy == RouteStrategy.INGRESS) {
switch (routeStrategy) { result = await promoteBlueGreenIngress(kubectl, manifestObjects);
case RouteStrategy.INGRESS: } else if (routeStrategy == RouteStrategy.SMI) {
return await promoteBlueGreenIngress(kubectl, manifestObjects) result = await promoteBlueGreenSMI(kubectl, manifestObjects);
case RouteStrategy.SMI: } else {
return await promoteBlueGreenSMI(kubectl, manifestObjects) result = await promoteBlueGreenService(kubectl, manifestObjects);
default:
return await promoteBlueGreenService(kubectl, manifestObjects)
} }
})()
core.endGroup()
// checking stability of newly created deployments // checking stability of newly created deployments
core.startGroup('Checking manifest stability') core.info("Checking manifest stability");
const deployedManifestFiles = deployResult.manifestFiles const deployedManifestFiles = result.newFilePaths;
const resources: Resource[] = getResources( const resources: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE models.DiscoveryAndLoadBalancerResource.SERVICE,
]) ])
) );
await KubernetesManifestUtility.checkManifestStability(kubectl, resources) await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
core.endGroup()
core.startGroup( core.info(
'Routing to new deployments and deleting old workloads and services' "Routing to new deployments and deleting old workloads and services"
) );
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngressUnchanged( await routeBlueGreenIngress(
kubectl, kubectl,
null,
manifestObjects.serviceNameMap, manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList manifestObjects.ingressEntityList
) );
await deleteWorkloadsAndServicesWithLabel(
await deleteGreenObjects(
kubectl, kubectl,
[].concat( GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
) );
)
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI( await routeBlueGreenSMI(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
) );
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList) await deleteWorkloadsWithLabel(
await cleanupSMI(kubectl, manifestObjects.serviceEntityList) kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
} else { } else {
await routeBlueGreenService( await routeBlueGreenService(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
) );
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList) await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
} }
core.endGroup()
} }
+31 -40
View File
@@ -1,20 +1,16 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
import {BlueGreenManifests} from '../types/blueGreenTypes' import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import { import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
rejectBlueGreenIngress, import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
rejectBlueGreenService, import { DeploymentStrategy } from "../types/deploymentStrategy";
rejectBlueGreenSMI
} from '../strategyHelpers/blueGreen/reject'
import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod TrafficSplitMethod,
} from '../types/trafficSplitMethod' } from "../types/trafficSplitMethod";
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
export async function reject( export async function reject(
kubectl: Kubectl, kubectl: Kubectl,
@@ -23,55 +19,50 @@ export async function reject(
) { ) {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: case DeploymentStrategy.CANARY:
await rejectCanary(kubectl, manifests) await rejectCanary(kubectl, manifests);
break break;
case DeploymentStrategy.BLUE_GREEN: case DeploymentStrategy.BLUE_GREEN:
await rejectBlueGreen(kubectl, manifests) await rejectBlueGreen(kubectl, manifests);
break break;
default: default:
throw 'Invalid delete deployment strategy' throw "Invalid delete deployment strategy";
} }
} }
async function rejectCanary(kubectl: Kubectl, manifests: string[]) { async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false let includeServices = false;
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true}) core.getInput("traffic-split-method", { required: true })
) );
if (trafficSplitMethod == TrafficSplitMethod.SMI) { if (trafficSplitMethod == TrafficSplitMethod.SMI) {
core.startGroup('Rejecting deployment with SMI canary strategy') core.info("Rejecting deployment with SMI canary strategy");
includeServices = true includeServices = true;
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl, kubectl,
manifests manifests
) );
core.endGroup()
} }
core.startGroup('Deleting baseline and canary workloads') core.info("Deleting baseline and canary workloads");
await canaryDeploymentHelper.deleteCanaryDeployment( await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl, kubectl,
manifests, manifests,
includeServices includeServices
) );
core.endGroup()
} }
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) { async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
const routeStrategy = parseRouteStrategy( core.info("Rejecting deployment with blue green strategy");
core.getInput('route-method', {required: true})
)
core.startGroup('Rejecting deployment with blue green strategy')
core.info(`using routeMethod ${routeStrategy}`)
const manifestObjects: BlueGreenManifests = getManifestObjects(manifests)
const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true })
);
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
await rejectBlueGreenIngress(kubectl, manifestObjects) await rejectBlueGreenIngress(kubectl, manifests);
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
await rejectBlueGreenSMI(kubectl, manifestObjects) await rejectBlueGreenSMI(kubectl, manifests);
} else { } else {
await rejectBlueGreenService(kubectl, manifestObjects) await rejectBlueGreenService(kubectl, manifests);
} }
core.endGroup()
} }
-16
View File
@@ -1,16 +0,0 @@
import * as core from '@actions/core'
import {parseAnnotations} from './types/annotations'
export const inputAnnotations = parseAnnotations(
core.getInput('annotations', {required: false})
)
export function getBufferTime(): number {
const inputBufferTime = parseInt(
core.getInput('version-switch-buffer') || '0'
)
if (inputBufferTime < 0 || inputBufferTime > 300)
throw Error('Version switch buffer must be between 0 and 300 (inclusive)')
return inputBufferTime
}
+28 -41
View File
@@ -1,69 +1,56 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {getKubectlPath, Kubectl} from './types/kubectl' import { getKubectlPath, Kubectl } from "./types/kubectl";
import {deploy} from './actions/deploy' import { deploy } from "./actions/deploy";
import {promote} from './actions/promote' import { promote } from "./actions/promote";
import {reject} from './actions/reject' import { reject } from "./actions/reject";
import {Action, parseAction} from './types/action' import { Action, parseAction } from "./types/action";
import {parseDeploymentStrategy} from './types/deploymentStrategy' import { parseDeploymentStrategy } from "./types/deploymentStrategy";
import {getFilesFromDirectories} from './utilities/fileUtils' import { getFilesFromDirectories } from "./utilities/fileUtils";
import {PrivateKubectl} from './types/privatekubectl'
export async function run() { export async function run() {
// verify kubeconfig is set // verify kubeconfig is set
if (!process.env['KUBECONFIG']) if (!process.env["KUBECONFIG"])
core.warning( 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 // get inputs
const action: Action | undefined = parseAction( const action: Action | undefined = parseAction(
core.getInput('action', {required: true}) core.getInput("action", { required: true })
) );
const strategy = parseDeploymentStrategy(core.getInput('strategy')) const strategy = parseDeploymentStrategy(core.getInput("strategy"));
const manifestsInput = core.getInput('manifests', {required: true}) const manifestsInput = core.getInput("manifests", { required: true });
const manifestFilePaths = manifestsInput const manifestFilePaths = manifestsInput
.split(/[\n,;]+/) // split into each individual manifest .split(/[\n,;]+/) // split into each individual manifest
.map((manifest) => manifest.trim()) // remove surrounding whitespace .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) const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
const kubectlPath = await getKubectlPath() // create kubectl
const namespace = core.getInput('namespace') || 'default' const kubectlPath = await getKubectlPath();
const isPrivateCluster = const namespace = core.getInput("namespace") || "default";
core.getInput('private-cluster').toLowerCase() === 'true' const kubectl = new Kubectl(kubectlPath, namespace, true);
const resourceGroup = core.getInput('resource-group') || ''
const resourceName = core.getInput('name') || ''
const kubectl = isPrivateCluster
? new PrivateKubectl(
kubectlPath,
namespace,
true,
resourceGroup,
resourceName
)
: new Kubectl(kubectlPath, namespace, true)
// run action // run action
switch (action) { switch (action) {
case Action.DEPLOY: { case Action.DEPLOY: {
await deploy(kubectl, fullManifestFilePaths, strategy) await deploy(kubectl, fullManifestFilePaths, strategy);
break break;
} }
case Action.PROMOTE: { case Action.PROMOTE: {
await promote(kubectl, fullManifestFilePaths, strategy) await promote(kubectl, fullManifestFilePaths, strategy);
break break;
} }
case Action.REJECT: { case Action.REJECT: {
await reject(kubectl, fullManifestFilePaths, strategy) await reject(kubectl, fullManifestFilePaths, strategy);
break break;
} }
default: { default: {
throw Error( throw Error(
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".' 'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
) );
} }
} }
} }
run().catch(core.setFailed) run().catch(core.setFailed);
@@ -1,196 +0,0 @@
import {
deployWithLabel,
deleteGreenObjects,
fetchResource,
getDeploymentMatchLabels,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
isServiceRouted
} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import {K8sObject} from '../../types/k8sObject'
import * as manifestUpdateUtils from '../../utilities/manifestUpdateUtils'
import {ExecOutput} from '@actions/exec'
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('bluegreenhelper functions', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(['test/unit/manifests/test-ingress.yml'])
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly deletes services and workloads according to label', async () => {
jest.spyOn(bgHelper, 'deleteObjects').mockReturnValue({} as Promise<void>)
const value = await deleteGreenObjects(
kubectl,
[].concat(
testObjects.deploymentEntityList,
testObjects.serviceEntityList
)
)
expect(value).toHaveLength(2)
expect(value).toContainEqual({
name: 'nginx-service-green',
kind: 'Service'
})
expect(value).toContainEqual({
name: 'nginx-deployment-green',
kind: 'Deployment'
})
})
test('parses objects correctly from one file (getManifestObjects)', () => {
expect(testObjects.deploymentEntityList[0].kind).toBe('Deployment')
expect(testObjects.serviceEntityList[0].kind).toBe('Service')
expect(testObjects.ingressEntityList[0].kind).toBe('Ingress')
expect(
testObjects.deploymentEntityList[0].spec.selector.matchLabels.app
).toBe('nginx')
})
test('parses other kinds of objects (getManifestObjects)', () => {
const otherObjectsCollection = getManifestObjects([
'test/unit/manifests/anomaly-objects-test.yml'
])
expect(
otherObjectsCollection.unroutedServiceEntityList[0].metadata.name
).toBe('unrouted-service')
expect(otherObjectsCollection.otherObjects[0].metadata.name).toBe(
'foobar-rollout'
)
})
test('correctly classifies routed services', () => {
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(true)
testObjects.serviceEntityList[0].spec.selector.app = 'fakeapp'
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(false)
})
test('correctly makes labeled workloads', async () => {
const cwlResult: BlueGreenDeployment = await deployWithLabel(
kubectl,
testObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
expect(cwlResult.deployResult.manifestFiles[0]).toBe('')
})
test('correctly makes new blue green object (getNewBlueGreenObject and addBlueGreenLabelsAndAnnotations)', () => {
const modifiedDeployment = getNewBlueGreenObject(
testObjects.deploymentEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedDeployment.metadata.name).toBe('nginx-deployment-green')
expect(modifiedDeployment.metadata.labels['k8s.deploy.color']).toBe(
'green'
)
const modifiedSvc = getNewBlueGreenObject(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedSvc.metadata.name).toBe('nginx-service-green')
expect(modifiedSvc.metadata.labels['k8s.deploy.color']).toBe('green')
})
test('correctly fetches k8s objects', async () => {
const mockExecOutput = {
stderr: '',
stdout: JSON.stringify(testObjects.deploymentEntityList[0]),
exitCode: 0
}
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
const fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched.metadata.name).toBe('nginx-deployment')
})
test('exits when fails to fetch k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
let fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched).toBe(null)
jest.spyOn(kubectl, 'getResource').mockImplementation()
fetched = await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
expect(fetched).toBe(null)
})
test('returns null when fetch fails to unset k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(manifestUpdateUtils, 'UnsetClusterSpecificDetails')
.mockImplementation(() => {
throw new Error('test error')
})
expect(
await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
).toBe(null)
})
test('gets deployment labels', () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
const mockPodObject: K8sObject = {
kind: 'Pod',
metadata: {name: 'testPod', labels: mockLabels},
spec: {}
}
expect(
getDeploymentMatchLabels(mockPodObject)[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(GREEN_LABEL_VALUE)
expect(
getDeploymentMatchLabels(testObjects.deploymentEntityList[0])['app']
).toBe('nginx')
})
})
+215 -126
View File
@@ -1,104 +1,196 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import { Kubectl } from "../../types/kubectl";
import {DeployResult} from '../../types/deployResult'
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import { import {
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload KubernetesWorkload,
} from '../../types/kubernetesTypes' } from "../../types/kubernetesTypes";
import { import * as fileHelper from "../../utilities/fileUtils";
BlueGreenDeployment, import { routeBlueGreenService } from "./serviceBlueGreenHelper";
BlueGreenManifests import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
} from '../../types/blueGreenTypes' import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
import * as fileHelper from '../../utilities/fileUtils'
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
import { import {
UnsetClusterSpecificDetails, UnsetClusterSpecificDetails,
updateObjectLabels, updateObjectLabels,
updateSelectorLabels updateSelectorLabels,
} from '../../utilities/manifestUpdateUtils' } 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 GREEN_LABEL_VALUE = "green";
export const NONE_LABEL_VALUE = 'None' export const NONE_LABEL_VALUE = "None";
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color' export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color";
export const GREEN_SUFFIX = '-green' export const GREEN_SUFFIX = "-green";
export const STABLE_SUFFIX = '-stable' export const STABLE_SUFFIX = "-stable";
export async function deleteGreenObjects( export interface BlueGreenManifests {
kubectl: Kubectl, serviceEntityList: any[];
toDelete: K8sObject[] serviceNameMap: Map<string, string>;
): Promise<K8sDeleteObject[]> { unroutedServiceEntityList: any[];
// const resourcesToDelete: K8sDeleteObject[] = [] deploymentEntityList: any[];
const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => { ingressEntityList: any[];
return { otherObjects: any[];
name: getBlueGreenResourceName(obj.metadata.name, GREEN_SUFFIX),
kind: obj.kind
}
})
core.debug(`deleting green objects: ${JSON.stringify(resourcesToDelete)}`)
await deleteObjects(kubectl, resourcesToDelete)
return resourcesToDelete
} }
export async function deleteObjects( export async function routeBlueGreen(
kubectl: Kubectl, kubectl: Kubectl,
deleteList: K8sDeleteObject[] inputManifestFiles: string[],
routeStrategy: RouteStrategy
) { ) {
// sleep for buffer time
const bufferTime: number = parseInt(
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();
core.info(
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
);
await sleep(bufferTime * 1000 * 60);
const endSleepDate = new Date();
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
);
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles);
core.debug("Manifest objects: " + JSON.stringify(manifestObjects));
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
} else {
await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
}
}
export async function deleteWorkloadsWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[]
) {
const resourcesToDelete = [];
deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete new green deployments
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteWorkloadsAndServicesWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[],
serviceEntityList: any[]
) {
// need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
const resourcesToDelete = [];
deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete green labels
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// delete services and deployments // delete services and deployments
for (const delObject of deleteList) { for (const delObject of deleteList) {
try { try {
const result = await kubectl.delete([delObject.kind, delObject.name]) const result = await kubectl.delete([delObject.kind, delObject.name]);
checkForErrors([result]) checkForErrors([result]);
} catch (ex) { } catch (ex) {
core.debug(`failed to delete object ${delObject.name}: ${ex}`) // Ignore failures of delete if it doesn't exist
} }
} }
} }
// other common functions // other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests { export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList: K8sObject[] = [] const deploymentEntityList = [];
const routedServiceEntityList: K8sObject[] = [] const routedServiceEntityList = [];
const unroutedServiceEntityList: K8sObject[] = [] const unroutedServiceEntityList = [];
const ingressEntityList: K8sObject[] = [] const ingressEntityList = [];
const otherEntitiesList: K8sObject[] = [] const otherEntitiesList = [];
const serviceNameMap = new Map<string, string>() const serviceNameMap = new Map<string, string>();
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString() const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) { if (!!inputObject) {
const kind = inputObject.kind const kind = inputObject.kind;
const name = inputObject.metadata.name const name = inputObject.metadata.name;
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject) deploymentEntityList.push(inputObject);
} else if (isServiceEntity(kind)) { } else if (isServiceEntity(kind)) {
if (isServiceRouted(inputObject, deploymentEntityList)) { if (isServiceRouted(inputObject, deploymentEntityList)) {
routedServiceEntityList.push(inputObject) routedServiceEntityList.push(inputObject);
serviceNameMap.set( serviceNameMap.set(
name, name,
getBlueGreenResourceName(name, GREEN_SUFFIX) getBlueGreenResourceName(name, GREEN_SUFFIX)
) );
} else { } else {
unroutedServiceEntityList.push(inputObject) unroutedServiceEntityList.push(inputObject);
} }
} else if (isIngressEntity(kind)) { } else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject) ingressEntityList.push(inputObject);
} else { } else {
otherEntitiesList.push(inputObject) otherEntitiesList.push(inputObject);
} }
} }
}) });
}) });
return { return {
serviceEntityList: routedServiceEntityList, serviceEntityList: routedServiceEntityList,
@@ -106,62 +198,72 @@ export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
unroutedServiceEntityList: unroutedServiceEntityList, unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList, deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList, ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList otherObjects: otherEntitiesList,
} };
} }
export function isServiceRouted( export function isServiceRouted(
serviceObject: any[], serviceObject: any[],
deploymentEntityList: any[] deploymentEntityList: any[]
): boolean { ): boolean {
const serviceSelector: any = getServiceSelector(serviceObject) let shouldBeRouted: boolean = false;
const serviceSelector: any = getServiceSelector(serviceObject);
return ( if (serviceSelector) {
serviceSelector && if (
deploymentEntityList.some((depObject) => { deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets // finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject) const matchLabels: any = getDeploymentMatchLabels(depObject);
return ( return (
matchLabels && matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels) isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
) );
}) })
) ) {
shouldBeRouted = true;
}
} }
export async function deployWithLabel( return shouldBeRouted;
}
export async function createWorkloadsWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deploymentObjectList: any[], deploymentObjectList: any[],
nextLabel: string nextLabel: string
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = deploymentObjectList.map((inputObject) => const newObjectsList = [];
getNewBlueGreenObject(inputObject, nextLabel) deploymentObjectList.forEach((inputObject) => {
) // creating deployment with label
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel);
core.debug( core.debug(
`objects deployed with label are ${JSON.stringify(newObjectsList)}` "New blue-green object is: " + JSON.stringify(newBlueGreenObject)
) );
const deployResult = await deployObjects(kubectl, newObjectsList) newObjectsList.push(newBlueGreenObject);
return {deployResult, objects: newObjectsList} });
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const result = await kubectl.apply(manifestFiles);
return { result: result, newFilePaths: manifestFiles };
} }
export function getNewBlueGreenObject( export function getNewBlueGreenObject(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Updating name only if label is green label is given // Updating name only if label is green label is given
if (labelValue === GREEN_LABEL_VALUE) { if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
GREEN_SUFFIX GREEN_SUFFIX
) );
} }
// Adding labels and annotations // Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export function addBlueGreenLabelsAndAnnotations( export function addBlueGreenLabelsAndAnnotations(
@@ -169,21 +271,21 @@ export function addBlueGreenLabelsAndAnnotations(
labelValue: string labelValue: string
) { ) {
//creating the k8s.deploy.color label //creating the k8s.deploy.color label
const newLabels = new Map<string, string>() const newLabels = new Map<string, string>();
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
// updating object labels and selector labels // updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false) updateObjectLabels(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false) updateSelectorLabels(inputObject, newLabels, false);
// updating spec labels if it is not a service // updating spec labels if it is a service
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false) updateSpecLabels(inputObject, newLabels, false);
} }
} }
export function getBlueGreenResourceName(name: string, suffix: string) { export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}` return `${name}${suffix}`;
} }
export function getDeploymentMatchLabels(deploymentObject: any): any { export function getDeploymentMatchLabels(deploymentObject: any): any {
@@ -192,15 +294,15 @@ export function getDeploymentMatchLabels(deploymentObject: any): any {
KubernetesWorkload.POD.toUpperCase() && KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels deploymentObject?.metadata?.labels
) { ) {
return deploymentObject.metadata.labels return deploymentObject.metadata.labels;
} else if (deploymentObject?.spec?.selector?.matchLabels) { } else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels return deploymentObject.spec.selector.matchLabels;
} }
} }
export function getServiceSelector(serviceObject: any): any { export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) { if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector return serviceObject.spec.selector;
} }
} }
@@ -208,59 +310,46 @@ export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any, serviceSelector: any,
matchLabels: any matchLabels: any
): boolean { ): boolean {
const serviceSelectorMap = new Map() const serviceSelectorMap = new Map();
const matchLabelsMap = new Map() const matchLabelsMap = new Map();
JSON.parse(JSON.stringify(serviceSelector), (key, value) => { JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value) serviceSelectorMap.set(key, value);
}) });
JSON.parse(JSON.stringify(matchLabels), (key, value) => { JSON.parse(JSON.stringify(matchLabels), (key, value) => {
matchLabelsMap.set(key, value) matchLabelsMap.set(key, value);
}) });
let isMatch = true let isMatch = true;
serviceSelectorMap.forEach((value, key) => { serviceSelectorMap.forEach((value, key) => {
if ( if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value)
!!key && isMatch = false;
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value });
)
isMatch = false
})
return isMatch return isMatch;
} }
export async function fetchResource( export async function fetchResource(
kubectl: Kubectl, kubectl: Kubectl,
kind: string, kind: string,
name: string name: string
): Promise<K8sObject> { ) {
const result = await kubectl.getResource(kind, name) const result = await kubectl.getResource(kind, name);
if (result == null || !!result.stderr) { if (result == null || !!result.stderr) {
return null return null;
} }
if (!!result.stdout) { if (!!result.stdout) {
const resource = JSON.parse(result.stdout) as K8sObject const resource = JSON.parse(result.stdout);
try { try {
UnsetClusterSpecificDetails(resource) UnsetClusterSpecificDetails(resource);
return resource return resource;
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while Parsing ${resource} in Json object: ${ex}` `Exception occurred while Parsing ${resource} in Json object: ${ex}`
) );
} }
} }
} }
export async function deployObjects(
kubectl: Kubectl,
objectsList: any[]
): Promise<DeployResult> {
const manifestFiles = fileHelper.writeObjectsToFile(objectsList)
const execResult = await kubectl.apply(manifestFiles)
return {execResult, manifestFiles}
}
@@ -1,75 +0,0 @@
import {getManifestObjects} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployBlueGreen, deployBlueGreenIngress} from './deploy'
import * as routeTester from './route'
import {Kubectl} from '../../types/kubectl'
import {RouteStrategy} from '../../types/routeStrategy'
import * as TSutils from '../../utilities/trafficSplitUtils'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
describe('deploy tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('correctly determines deploy type and acts accordingly', async () => {
const kubectl = new Kubectl('')
const mockBgDeployment: BlueGreenDeployment = {
deployResult: {
execResult: {exitCode: 0, stderr: '', stdout: ''},
manifestFiles: []
},
objects: []
}
jest
.spyOn(routeTester, 'routeBlueGreenForDeploy')
.mockImplementation(() => Promise.resolve(mockBgDeployment))
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(2)
const result = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(result.objects.length).toBe(2)
const smiResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects.length).toBe(3)
})
test('correctly deploys blue/green ingress', async () => {
const kc = new Kubectl('')
const value = await deployBlueGreenIngress(kc, ingressFilepath)
const nol = value.objects.map((obj) => {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service-green')
}
if (obj.kind === 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment-green')
}
})
})
})
-136
View File
@@ -1,136 +0,0 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {RouteStrategy} from '../../types/routeStrategy'
import {
deployWithLabel,
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {setupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenForDeploy} from './route'
export async function deployBlueGreen(
kubectl: Kubectl,
files: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
const blueGreenDeployment = await (async () => {
switch (routeStrategy) {
case RouteStrategy.INGRESS:
return await deployBlueGreenIngress(kubectl, files)
case RouteStrategy.SMI:
return await deployBlueGreenSMI(kubectl, files)
default:
return await deployBlueGreenService(kubectl, files)
}
})()
core.startGroup('Routing blue green')
await routeBlueGreenForDeploy(kubectl, files, routeStrategy)
core.endGroup()
return blueGreenDeployment
}
export async function deployBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create services and other objects
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.serviceEntityList,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, newObjectsList)
// make extraservices and trafficsplit
await setupSMI(kubectl, manifestObjects.serviceEntityList)
// create new deloyments
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
return {
deployResult: blueGreenDeployment.deployResult,
objects: [].concat(blueGreenDeployment.objects, newObjectsList)
}
}
export async function deployBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const servicesAndDeployments = [].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
const workloadDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
servicesAndDeployments,
GREEN_LABEL_VALUE
)
const otherObjects = [].concat(
manifestObjects.otherObjects,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, otherObjects)
core.debug(
`new objects after processing services and other objects: \n
${JSON.stringify(servicesAndDeployments)}`
)
return {
deployResult: workloadDeployment.deployResult,
objects: [].concat(workloadDeployment.objects, otherObjects)
}
}
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
// create other non deployment and non service entities
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, newObjectsList)
// returning deployment details to check for rollout stability
return {
deployResult: blueGreenDeployment.deployResult,
objects: [].concat(blueGreenDeployment.objects, newObjectsList)
}
}
@@ -1,123 +0,0 @@
import {getManifestObjects, GREEN_LABEL_VALUE} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted,
validateIngresses
} from './ingressBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
const betaFilepath = ['test/unit/manifests/test-ingress.yml']
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('ingress blue green helpers', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('it should correctly classify ingresses', () => {
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
testObjects.ingressEntityList[0].spec.rules[0].http.paths = {}
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(false)
expect(
isIngressRouted(
getManifestObjects(betaFilepath).ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
})
test('it should correctly update ingresses', () => {
const updatedIng = getUpdatedBlueGreenIngress(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.name).toBe('nginx-ingress')
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
const oldIngObjects = getManifestObjects(betaFilepath)
const oldIng = getUpdatedBlueGreenIngress(
oldIngObjects.ingressEntityList[0],
oldIngObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
})
test('it should validate ingresses', async () => {
// what if nothing gets returned from fetchResource?
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
let validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test valid ingress
let mockIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service-green'
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
mockIngress.metadata.labels = mockLabels
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockIngress))
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(true)
// test invalid labels
mockIngress.metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL] =
bgHelper.NONE_LABEL_VALUE
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service'
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test missing fields
mockIngress = {}
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
})
})
@@ -1,48 +1,212 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sIngress} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests,
createWorkloadsWithLabel,
deleteWorkloadsAndServicesWithLabel,
fetchResource,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
fetchResource NONE_LABEL_VALUE,
} from './blueGreenHelper' } from "./blueGreenHelper";
import {Kubectl} from '../../types/kubectl' 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);
// create deployments with green label value
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create new services and other objects
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function promoteBlueGreenIngress(
kubectl: Kubectl,
manifestObjects
) {
//checking if anything to promote
if (
!validateIngressesState(
kubectl,
manifestObjects.ingressEntityList,
manifestObjects.serviceNameMap
)
) {
throw "Ingress not in promote state";
}
// create stable deployments with new configuration
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
// create stable services with new configuration
const newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route ingress to stables services
await routeBlueGreenIngress(
kubectl,
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
// delete green services and deployments
await deleteWorkloadsAndServicesWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
);
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
nextLabel: string,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
) {
let newObjectsList = [];
if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
);
} else {
ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
inputObject,
serviceNameMap,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenIngressObject);
} else {
newObjectsList.push(inputObject);
}
});
}
core.debug("New objects: " + JSON.stringify(newObjectsList));
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
export function validateIngressesState(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): boolean {
let areIngressesTargetingNewServices: boolean = true;
ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
);
if (!!existingIngress) {
const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL];
// if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false;
} else {
// no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false;
}
}
});
return areIngressesTargetingNewServices;
}
function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false;
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
if (key === "serviceName" && serviceNameMap.has(value)) {
isIngressRouted = true;
}
return value;
});
return isIngressRouted;
}
export function getUpdatedBlueGreenIngress( export function getUpdatedBlueGreenIngress(
inputObject: any, inputObject: any,
serviceNameMap: Map<string, string>, serviceNameMap: Map<string, string>,
type: string type: string
): K8sIngress { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) if (!type) {
return inputObject;
}
const newObject = JSON.parse(JSON.stringify(inputObject));
// add green labels and values // add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type) addBlueGreenLabelsAndAnnotations(newObject, type);
// update ingress labels // update ingress labels
if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') { return updateIngressBackend(newObject, serviceNameMap);
return updateIngressBackendBetaV1(newObject, serviceNameMap)
}
return updateIngressBackend(newObject, serviceNameMap)
}
export function updateIngressBackendBetaV1(
inputObject: any,
serviceNameMap: Map<string, string>
): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if (key.toLowerCase() === BACKEND) {
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)
}
}
return value
})
return inputObject
} }
export function updateIngressBackend( export function updateIngressBackend(
@@ -50,71 +214,16 @@ export function updateIngressBackend(
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): any { ): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if ( if (key.toUpperCase() === BACKEND) {
key.toLowerCase() === BACKEND && const { serviceName } = value;
serviceNameMap.has(value.service.name) if (serviceNameMap.has(serviceName)) {
) { // update service name with corresponding bluegreen name only if service is provied in given manifests
value.service.name = serviceNameMap.get(value.service.name) value.serviceName = serviceNameMap.get(serviceName);
}
return value
})
return inputObject
}
export function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
isIngressRouted =
isIngressRouted ||
(key === 'service' &&
value.hasOwnProperty('name') &&
serviceNameMap.has(value.name))
isIngressRouted =
isIngressRouted || (key === 'serviceName' && serviceNameMap.has(value))
return value
})
return isIngressRouted
}
export async function validateIngresses(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): Promise<{areValid: boolean; invalidIngresses: string[]}> {
let areValid: boolean = true
const invalidIngresses = []
for (const inputObject of ingressEntityList) {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
)
const isValid =
!!existingIngress &&
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL] ===
GREEN_LABEL_VALUE
if (!isValid) {
core.debug(
`Invalid ingress detected (must be in green state): ${JSON.stringify(
inputObject
)}`
)
invalidIngresses.push(inputObject.metadata.name)
}
// to be valid, ingress should exist and should be green
areValid = areValid && isValid
} }
} }
return {areValid, invalidIngresses}
return value;
});
return inputObject;
} }
@@ -1,158 +0,0 @@
import * as core from '@actions/core'
import {getManifestObjects} from './blueGreenHelper'
import {
promoteBlueGreenIngress,
promoteBlueGreenService,
promoteBlueGreenSMI
} from './promote'
import {TrafficSplitObject} from '../../types/k8sObject'
import * as servicesTester from './serviceBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {MAX_VAL, MIN_VAL, TRAFFIC_SPLIT_OBJECT} from './smiBlueGreenHelper'
import * as smiTester from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('promote tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('promote blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
const value = await promoteBlueGreenIngress(kubectl, testObjects)
const objects = value.objects
expect(objects).toHaveLength(2)
for (const obj of objects) {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service')
} else if (obj.kind == 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment')
}
expect(obj.metadata.labels['k8s.deploy.color']).toBe('None')
}
})
test('fail to promote invalid blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
await expect(
promoteBlueGreenIngress(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockLabels},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
let value = await promoteBlueGreenService(kubectl, testObjects)
expect(value.objects).toHaveLength(1)
expect(
value.objects[0].metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL]
).toBe(bgHelper.NONE_LABEL_VALUE)
expect(value.objects[0].metadata.name).toBe('nginx-deployment')
})
test('fail to promote invalid blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
jest
.spyOn(servicesTester, 'validateServicesState')
.mockImplementationOnce(() => Promise.resolve(false))
await expect(
promoteBlueGreenService(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green SMI', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
const deployResult = await promoteBlueGreenSMI(kubectl, testObjects)
expect(deployResult.objects).toHaveLength(1)
expect(deployResult.objects[0].metadata.name).toBe('nginx-deployment')
expect(
deployResult.objects[0].metadata.labels[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(bgHelper.NONE_LABEL_VALUE)
})
test('promote blue/green SMI with bad trafficsplit', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest
.spyOn(smiTester, 'validateTrafficSplitsState')
.mockImplementation(() => Promise.resolve(false))
expect(promoteBlueGreenSMI(kubectl, testObjects)).rejects.toThrowError()
})
})
-81
View File
@@ -1,81 +0,0 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployWithLabel, NONE_LABEL_VALUE} from './blueGreenHelper'
import {validateIngresses} from './ingressBlueGreenHelper'
import {validateServicesState} from './serviceBlueGreenHelper'
import {validateTrafficSplitsState} from './smiBlueGreenHelper'
export async function promoteBlueGreenIngress(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
//checking if anything to promote
const {areValid, invalidIngresses} = await validateIngresses(
kubectl,
manifestObjects.ingressEntityList,
manifestObjects.serviceNameMap
)
if (!areValid) {
throw new Error(
`Ingresses are not in promote state: ${invalidIngresses.toString()}`
)
}
// create stable deployments with new configuration
const result: BlueGreenDeployment = await deployWithLabel(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
),
NONE_LABEL_VALUE
)
// create stable services with new configuration
return result
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw new Error('Found services not in promote state')
}
// creating stable deployments with new configurations
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
export async function promoteBlueGreenSMI(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl,
manifestObjects.serviceEntityList
))
) {
throw Error('Not in promote state SMI')
}
// create stable deployments with new configuration
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
@@ -1,66 +0,0 @@
import {getManifestObjects} from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenRejectResult} from '../../types/blueGreenTypes'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {
rejectBlueGreenIngress,
rejectBlueGreenService,
rejectBlueGreenSMI
} from './reject'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('reject tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('reject blue/green ingress', async () => {
const value = await rejectBlueGreenIngress(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(2)
for (const obj of deleteResult) {
if (obj.kind == 'Service') {
expect(obj.name).toBe('nginx-service-green')
}
if (obj.kind == 'Deployment') {
expect(obj.name).toBe('nginx-deployment-green')
}
}
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-ingress')
})
test('reject blue/green service', async () => {
const value = await rejectBlueGreenService(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(1)
expect(deleteResult[0].name).toBe('nginx-deployment-green')
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-service')
})
test('reject blue/green SMI', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const rejectResult = await rejectBlueGreenSMI(kubectl, testObjects)
expect(rejectResult.deleteResult).toHaveLength(4)
})
})
-81
View File
@@ -1,81 +0,0 @@
import {K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests,
BlueGreenRejectResult
} from '../../types/blueGreenTypes'
import {deleteGreenObjects, NONE_LABEL_VALUE} from './blueGreenHelper'
import {routeBlueGreenSMI} from './route'
import {cleanupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenIngressUnchanged, routeBlueGreenService} from './route'
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// get all kubernetes objects defined in manifest files
// route ingress to stables services
const routeResult = await routeBlueGreenIngressUnchanged(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
// delete green services and deployments
const deleteResult = await deleteGreenObjects(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route to stable objects
const routeResult = await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete new deployments with green suffix
const deleteResult = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenSMI(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route trafficsplit to stable deployments
const routeResult = await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete rejected new bluegreen deployments
const deletedObjects = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
// delete trafficsplit and extra services
const cleanupResult = await cleanupSMI(
kubectl,
manifestObjects.serviceEntityList
)
return {routeResult, deleteResult: [].concat(deletedObjects, cleanupResult)}
}
-119
View File
@@ -1,119 +0,0 @@
import * as core from '@actions/core'
import {K8sIngress, TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {getBufferTime} from '../../inputUtils'
import * as inputUtils from '../../inputUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import {
routeBlueGreenIngress,
routeBlueGreenService,
routeBlueGreenForDeploy
} from './route'
jest.mock('../../types/kubectl')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kc = new Kubectl('')
describe('route function tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly prepares blue/green ingresses for deployment', async () => {
const unroutedIngCopy: K8sIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
unroutedIngCopy.metadata.name = 'nginx-ingress-unrouted'
unroutedIngCopy.spec.rules[0].http.paths[0].backend.service.name =
'fake-service'
testObjects.ingressEntityList.push(unroutedIngCopy)
const value = await routeBlueGreenIngress(
kc,
testObjects.serviceNameMap,
testObjects.ingressEntityList
)
expect(value.objects).toHaveLength(2)
expect(value.objects[0].metadata.name).toBe('nginx-ingress')
expect(
(value.objects[0] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('nginx-service-green')
expect(value.objects[1].metadata.name).toBe('nginx-ingress-unrouted')
// unrouted services shouldn't get their service name changed
expect(
(value.objects[1] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('fake-service')
})
test('correctly prepares blue/green services for deployment', async () => {
const value = await routeBlueGreenService(
kc,
GREEN_LABEL_VALUE,
testObjects.serviceEntityList
)
expect(value.objects).toHaveLength(1)
expect(value.objects[0].metadata.name).toBe('nginx-service')
expect(value.objects[0].metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('correctly identifies route pattern and acts accordingly', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(1)
expect(ingressResult.objects[0].metadata.name).toBe('nginx-ingress')
const serviceResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(serviceResult.objects.length).toBe(1)
expect(serviceResult.objects[0].metadata.name).toBe('nginx-service')
const smiResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects).toHaveLength(1)
expect(smiResult.objects[0].metadata.name).toBe(
'nginx-service-trafficsplit'
)
expect(
(smiResult.objects as TrafficSplitObject[])[0].spec.backends
).toHaveLength(2)
})
})
-141
View File
@@ -1,141 +0,0 @@
import {sleep} from '../../utilities/timeUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted
} from './ingressBlueGreenHelper'
import {getUpdatedBlueGreenService} from './serviceBlueGreenHelper'
import {createTrafficSplitObject} from './smiBlueGreenHelper'
import * as core from '@actions/core'
import {K8sObject, TrafficSplitObject} from '../../types/k8sObject'
import {getBufferTime} from '../../inputUtils'
export async function routeBlueGreenForDeploy(
kubectl: Kubectl,
inputManifestFiles: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
// sleep for buffer time
const bufferTime: number = getBufferTime()
const startSleepDate = new Date()
core.info(
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
)
await sleep(bufferTime * 1000 * 60)
const endSleepDate = new Date()
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
)
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles)
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
return await routeBlueGreenIngress(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
} else if (routeStrategy == RouteStrategy.SMI) {
return await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
} else {
return await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
}
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
// const newObjectsList = []
const newObjectsList: K8sObject[] = ingressEntityList.map((obj) => {
if (isIngressRouted(obj, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
obj,
serviceNameMap,
GREEN_LABEL_VALUE
)
return newBlueGreenIngressObject
} else {
core.debug(`unrouted ingress detected ${obj.metadata.name}`)
return obj
}
})
const deployResult = await deployObjects(kubectl, newObjectsList)
return {deployResult, objects: newObjectsList}
}
export async function routeBlueGreenIngressUnchanged(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = serviceEntityList.map((serviceObject) =>
getUpdatedBlueGreenService(serviceObject, nextLabel)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenSMI(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
// let tsObjects: TrafficSplitObject[] = []
const tsObjects: TrafficSplitObject[] = await Promise.all(
serviceEntityList.map(async (serviceObject) => {
const tsObject: TrafficSplitObject = await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
)
return tsObject
})
)
const deployResult = await deployObjects(kubectl, tsObjects)
return {deployResult, objects: tsObjects}
}
@@ -1,65 +0,0 @@
import * as core from '@actions/core'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {
getServiceSpecLabel,
getUpdatedBlueGreenService,
validateServicesState
} from './serviceBlueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('blue/green service helper tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('getUpdatedBlueGreenService', () => {
const newService = getUpdatedBlueGreenService(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(newService.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
expect(newService.spec.selector[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateServicesState', async () => {
const mockLabels = new Map<string, string>()
mockLabels[BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
const mockSelectors = new Map<string, string>()
mockSelectors[BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockSelectors},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
expect(
await validateServicesState(kubectl, testObjects.serviceEntityList)
).toBe(true)
})
test('getServiceSpecLabel', () => {
testObjects.serviceEntityList[0].spec.selector[BLUE_GREEN_VERSION_LABEL] =
GREEN_LABEL_VALUE
expect(getServiceSpecLabel(testObjects.serviceEntityList[0])).toBe(
GREEN_LABEL_VALUE
)
})
})
@@ -1,30 +1,118 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sServiceObject} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import {Kubectl} from '../../types/kubectl'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests,
createWorkloadsWithLabel,
deleteWorkloadsWithLabel,
fetchResource, fetchResource,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE GREEN_LABEL_VALUE
} from './blueGreenHelper' );
// create other non deployment and non service entities
const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
if (manifestFiles.length > 0) await kubectl.apply(manifestFiles);
// returning deployment details to check for rollout stability
return result;
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
) {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw "Not inP promote state";
}
// creating stable deployments with new configurations
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route to stable objects
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
);
// delete new deployments with green suffix
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
) {
const newObjectsList = [];
serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject,
nextLabel
);
newObjectsList.push(newBlueGreenServiceObject);
});
// configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
// add green labels to configure existing service // add green labels to configure existing service
export function getUpdatedBlueGreenService( function getUpdatedBlueGreenService(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sServiceObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Adding labels and annotations. // Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export async function validateServicesState( export async function validateServicesState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let areServicesGreen: boolean = true let areServicesGreen: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
// finding the existing routed service // finding the existing routed service
@@ -32,18 +120,27 @@ export async function validateServicesState(
kubectl, kubectl,
serviceObject.kind, serviceObject.kind,
serviceObject.metadata.name serviceObject.metadata.name
) );
let isServiceGreen = if (!!existingService) {
!!existingService && const currentLabel: string = getServiceSpecLabel(existingService);
getServiceSpecLabel(existingService as K8sServiceObject) == if (currentLabel != GREEN_LABEL_VALUE) {
GREEN_LABEL_VALUE // service should be targeting deployments with green label
areServicesGreen = areServicesGreen && isServiceGreen areServicesGreen = false;
}
} else {
// service targeting deployment doesn't exist
areServicesGreen = false;
}
} }
return areServicesGreen return areServicesGreen;
} }
export function getServiceSpecLabel(inputObject: K8sServiceObject): string { export function getServiceSpecLabel(inputObject: any): string {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL] if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL];
}
return "";
} }
@@ -1,203 +0,0 @@
import * as core from '@actions/core'
import {TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
import {
cleanupSMI,
createTrafficSplitObject,
getGreenSMIServiceResource,
getStableSMIServiceResource,
MAX_VAL,
MIN_VAL,
setupSMI,
TRAFFIC_SPLIT_OBJECT,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX,
validateTrafficSplitsState
} from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
jest.mock('../../types/kubectl')
const kc = new Kubectl('')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
describe('SMI Helper tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve(''))
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('setupSMI tests', async () => {
const smiResults = await setupSMI(kc, testObjects.serviceEntityList)
let found = 0
for (const obj of smiResults.objects) {
if (obj.metadata.name === 'nginx-service-stable') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(obj.spec.selector.app).toBe('nginx')
found++
}
if (obj.metadata.name === 'nginx-service-green') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
found++
}
if (obj.metadata.name === 'nginx-service-trafficsplit') {
found++
// expect stable weight to be max val
const casted = obj as TrafficSplitObject
expect(casted.spec.backends).toHaveLength(2)
for (const be of casted.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
}
}
expect(found).toBe(3)
})
test('createTrafficSplitObject tests', async () => {
const noneTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
NONE_LABEL_VALUE
)
expect(noneTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (let be of noneTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
const greenTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
GREEN_LABEL_VALUE
)
expect(greenTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (const be of greenTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MIN_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MAX_VAL)
}
}
})
test('getSMIServiceResource test', () => {
const stableResult = getStableSMIServiceResource(
testObjects.serviceEntityList[0]
)
const greenResult = getGreenSMIServiceResource(
testObjects.serviceEntityList[0]
)
expect(stableResult.metadata.name).toBe('nginx-service-stable')
expect(stableResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(greenResult.metadata.name).toBe('nginx-service-green')
expect(greenResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateTrafficSplitsState', async () => {
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
let valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(true)
const mockTsCopy = JSON.parse(JSON.stringify(mockTsObject))
mockTsCopy.spec.backends[0].weight = MAX_VAL
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsCopy))
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
})
test('cleanupSMI test', async () => {
const deleteObjects = await cleanupSMI(kc, testObjects.serviceEntityList)
expect(deleteObjects).toHaveLength(3)
expect(deleteObjects[0].name).toBe('nginx-service-trafficsplit')
expect(deleteObjects[1].name).toBe('nginx-service-green')
expect(deleteObjects[1].kind).toBe('Service')
expect(deleteObjects[2].name).toBe('nginx-service-stable')
expect(deleteObjects[2].kind).toBe('Service')
})
})
@@ -1,181 +1,248 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {Kubectl} from '../../types/kubectl' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as fileHelper from "../../utilities/fileUtils";
import { import {
BlueGreenManifests,
createWorkloadsWithLabel,
deleteObjects, deleteObjects,
deployObjects, deleteWorkloadsWithLabel,
fetchResource, fetchResource,
getBlueGreenResourceName, getBlueGreenResourceName,
getManifestObjects,
getNewBlueGreenObject, getNewBlueGreenObject,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
GREEN_SUFFIX, GREEN_SUFFIX,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
STABLE_SUFFIX STABLE_SUFFIX,
} from './blueGreenHelper' } from "./blueGreenHelper";
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {
K8sDeleteObject,
K8sObject,
TrafficSplitObject
} from '../../types/k8sObject'
import {DeployResult} from '../../types/deployResult'
import {inputAnnotations} from '../../inputUtils'
export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit' const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit";
export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit' const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export const MIN_VAL = 0 const MIN_VAL = 0;
export const MAX_VAL = 100 const MAX_VAL = 100;
export async function setupSMI( export async function deployBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] filePaths: string[]
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = [] // get all kubernetes objects defined in manifest files
const trafficObjectList = [] const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// 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);
// make extraservices and trafficsplit
await setupSMI(kubectl, manifestObjects.serviceEntityList);
// create new deloyments
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
}
export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
// checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl,
manifestObjects.serviceEntityList
))
) {
throw Error("Not in promote state SMI");
}
// create stable deployments with new configuration
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
}
export async function rejectBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route trafficsplit to stable deploymetns
await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
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);
}
export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const newObjectsList = [];
const trafficObjectList = [];
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service // create a trafficsplit for service
trafficObjectList.push(serviceObject) trafficObjectList.push(serviceObject);
// set up the services for trafficsplit // set up the services for trafficsplit
const newStableService = getStableSMIServiceResource(serviceObject) const newStableService = getSMIServiceResource(
const newGreenService = getGreenSMIServiceResource(serviceObject) serviceObject,
newObjectsList.push(newStableService) STABLE_SUFFIX
newObjectsList.push(newGreenService) );
}) const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX);
newObjectsList.push(newStableService);
const tsObjects: TrafficSplitObject[] = [] newObjectsList.push(newGreenService);
// route to stable service });
for (const svc of trafficObjectList) {
const tsObject = await createTrafficSplitObject(
kubectl,
svc.metadata.name,
NONE_LABEL_VALUE
)
tsObjects.push(tsObject as TrafficSplitObject)
}
const objectsToDeploy = [].concat(newObjectsList, tsObjects)
// create services // create services
const smiDeploymentResult: DeployResult = await deployObjects( const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// route to stable service
trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject(
kubectl, kubectl,
objectsToDeploy inputObject.metadata.name,
) NONE_LABEL_VALUE
);
return { });
objects: objectsToDeploy,
deployResult: smiDeploymentResult
}
} }
let trafficSplitAPIVersion = '' let trafficSplitAPIVersion = "";
export async function createTrafficSplitObject( async function createTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
name: string, name: string,
nextLabel: string nextLabel: string
): Promise<TrafficSplitObject> { ): Promise<any> {
// cache traffic split api version // cache traffic split api version
if (!trafficSplitAPIVersion) if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl kubectl
) );
// retrieve annotations for TS object
const annotations = inputAnnotations
// decide weights based on nextlabel // decide weights based on nextlabel
const stableWeight: number = const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL;
const greenWeight: number = const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL;
const trafficSplitObject: TrafficSplitObject = { const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion, apiVersion: trafficSplitAPIVersion,
kind: TRAFFIC_SPLIT_OBJECT, kind: "TrafficSplit",
metadata: { metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX), name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
annotations: annotations,
labels: new Map<string, string>()
}, },
spec: { spec: {
service: name, service: name,
backends: [ backends: [
{ {
service: getBlueGreenResourceName(name, STABLE_SUFFIX), service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight weight: stableWeight,
}, },
{ {
service: getBlueGreenResourceName(name, GREEN_SUFFIX), 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);
} }
return trafficSplitObject export function getSMIServiceResource(
} inputObject: any,
suffix: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject));
export function getStableSMIServiceResource(inputObject: K8sObject): K8sObject { if (suffix === STABLE_SUFFIX) {
const newObject = JSON.parse(JSON.stringify(inputObject))
// adding stable suffix to service name // adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
) );
return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE) return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE);
} else {
// green label will be added for these
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE);
}
} }
export function getGreenSMIServiceResource(inputObject: K8sObject): K8sObject { export async function routeBlueGreenSMI(
const newObject = JSON.parse(JSON.stringify(inputObject)) kubectl: Kubectl,
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE) nextLabel: string,
serviceEntityList: any[]
) {
for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label
await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
);
}
} }
export async function validateTrafficSplitsState( export async function validateTrafficSplitsState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let trafficSplitsInRightState: boolean = true let trafficSplitsInRightState: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name const name = serviceObject.metadata.name;
let trafficSplitObject = await fetchResource( let trafficSplitObject = await fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX) getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
) );
core.debug(
`ts object extracted was ${JSON.stringify(trafficSplitObject)}`
)
if (!trafficSplitObject) { if (!trafficSplitObject) {
core.debug(`no traffic split exits for ${name}`) // no traffic split exits
trafficSplitsInRightState = false trafficSplitsInRightState = false;
continue
} }
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
trafficSplitObject.spec.backends.forEach((element) => { trafficSplitObject.spec.backends.forEach((element) => {
// checking if trafficsplit in right state to deploy // checking if trafficsplit in right state to deploy
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) { if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
trafficSplitsInRightState = if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
trafficSplitsInRightState && element.weight == MAX_VAL
} }
if ( if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) {
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX) if (element.weight != MIN_VAL) trafficSplitsInRightState = false;
) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MIN_VAL
} }
}) });
}
return trafficSplitsInRightState
} }
export async function cleanupSMI( return trafficSplitsInRightState;
kubectl: Kubectl, }
serviceEntityList: any[]
): Promise<K8sDeleteObject[]> { export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const deleteList: K8sDeleteObject[] = [] const deleteList = [];
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
deleteList.push({ deleteList.push({
@@ -183,28 +250,23 @@ export async function cleanupSMI(
serviceObject.metadata.name, serviceObject.metadata.name,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
), ),
kind: TRAFFIC_SPLIT_OBJECT kind: TRAFFIC_SPLIT_OBJECT,
}) });
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX),
serviceObject.metadata.name, kind: serviceObject.kind,
GREEN_SUFFIX });
),
kind: serviceObject.kind
})
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
), ),
kind: serviceObject.kind kind: serviceObject.kind,
}) });
}) });
// delete all objects // delete all objects
await deleteObjects(kubectl, deleteList) await deleteObjects(kubectl, deleteList);
return deleteList
} }
+65 -91
View File
@@ -1,29 +1,28 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec'
import { import {
isDeploymentEntity, isDeploymentEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload KubernetesWorkload,
} from '../../types/kubernetesTypes' } from "../../types/kubernetesTypes";
import * as utils from '../../utilities/manifestUpdateUtils' import * as utils from "../../utilities/manifestUpdateUtils";
import { import {
updateObjectAnnotations, updateObjectAnnotations,
updateObjectLabels, updateObjectLabels,
updateSelectorLabels updateSelectorLabels,
} from '../../utilities/manifestUpdateUtils' } from "../../utilities/manifestUpdateUtils";
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils' import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import {checkForErrors} from '../../utilities/kubectlUtils' import { checkForErrors } from "../../utilities/kubectlUtils";
export const CANARY_VERSION_LABEL = 'workflow/version' export const CANARY_VERSION_LABEL = "workflow/version";
const BASELINE_SUFFIX = '-baseline' const BASELINE_SUFFIX = "-baseline";
export const BASELINE_LABEL_VALUE = 'baseline' export const BASELINE_LABEL_VALUE = "baseline";
const CANARY_SUFFIX = '-canary' const CANARY_SUFFIX = "-canary";
export const CANARY_LABEL_VALUE = 'canary' export const CANARY_LABEL_VALUE = "canary";
export const STABLE_SUFFIX = '-stable' export const STABLE_SUFFIX = "-stable";
export const STABLE_LABEL_VALUE = 'stable' export const STABLE_LABEL_VALUE = "stable";
export async function deleteCanaryDeployment( export async function deleteCanaryDeployment(
kubectl: Kubectl, kubectl: Kubectl,
@@ -31,48 +30,48 @@ export async function deleteCanaryDeployment(
includeServices: boolean includeServices: boolean
) { ) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) { if (manifestFilePaths == null || manifestFilePaths.length == 0) {
throw new Error('Manifest files for deleting canary deployment 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 { export function markResourceAsStable(inputObject: any): object {
if (isResourceMarkedAsStable(inputObject)) { if (isResourceMarkedAsStable(inputObject)) {
return inputObject return inputObject;
} }
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE) addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE);
return newObject return newObject;
} }
export function isResourceMarkedAsStable(inputObject: any): boolean { export function isResourceMarkedAsStable(inputObject: any): boolean {
return ( return (
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
) );
} }
export function getStableResource(inputObject: any): object { export function getStableResource(inputObject: any): object {
const replicaCount = specContainsReplicas(inputObject.kind) const replicaCount = specContainsReplicas(inputObject.kind)
? inputObject.spec.replicas ? inputObject.metadata.replicas
: 0 : 0;
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE) return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
} }
export function getNewBaselineResource( export function getNewBaselineResource(
stableObject: any, stableObject: any,
replicas?: number replicas?: number
): object { ): object {
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE) return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE);
} }
export function getNewCanaryResource( export function getNewCanaryResource(
inputObject: any, inputObject: any,
replicas?: number replicas?: number
): object { ): object {
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE) return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE);
} }
export async function fetchResource( export async function fetchResource(
@@ -80,61 +79,36 @@ export async function fetchResource(
kind: string, kind: string,
name: string name: string
) { ) {
let result: ExecOutput const result = await kubectl.getResource(kind, name);
try {
result = await kubectl.getResource(kind, name)
} catch (e) {
core.debug(`detected error while fetching resources: ${e}`)
}
if (!result || result?.stderr) { if (!result || result?.stderr) {
return null return null;
} }
if (result.stdout) { if (result.stdout) {
const resource = JSON.parse(result.stdout) const resource = JSON.parse(result.stdout);
try { try {
utils.UnsetClusterSpecificDetails(resource) utils.UnsetClusterSpecificDetails(resource);
return resource return resource;
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while parsing ${resource} in JSON object: ${ex}` `Exception occurred while Parsing ${resource} in JSON object: ${ex}`
) );
} }
} }
} }
export function getCanaryResourceName(name: string) { export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX return name + CANARY_SUFFIX;
} }
export function getBaselineResourceName(name: string) { export function getBaselineResourceName(name: string) {
return name + BASELINE_SUFFIX return name + BASELINE_SUFFIX;
} }
export function getStableResourceName(name: string) { export function getStableResourceName(name: string) {
return name + STABLE_SUFFIX return name + STABLE_SUFFIX;
}
export function getBaselineDeploymentFromStableDeployment(
inputObject: any,
replicaCount: number
): object {
// TODO: REFACTOR TO MAKE EVERYTHING TYPE SAFE
const oldName = inputObject.metadata.name
const newName =
oldName.substring(0, oldName.length - STABLE_SUFFIX.length) +
BASELINE_SUFFIX
const newObject = getNewCanaryObject(
inputObject,
replicaCount,
BASELINE_LABEL_VALUE
) as any
newObject.metadata.name = newName
return newObject
} }
function getNewCanaryObject( function getNewCanaryObject(
@@ -142,26 +116,26 @@ function getNewCanaryObject(
replicas: number, replicas: number,
type: string type: string
): object { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Updating name // Updating name
if (type === CANARY_LABEL_VALUE) { 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) { } else if (type === STABLE_LABEL_VALUE) {
newObject.metadata.name = getStableResourceName(inputObject.metadata.name) newObject.metadata.name = getStableResourceName(inputObject.metadata.name);
} else { } else {
newObject.metadata.name = getBaselineResourceName( newObject.metadata.name = getBaselineResourceName(
inputObject.metadata.name inputObject.metadata.name
) );
} }
addCanaryLabelsAndAnnotations(newObject, type) addCanaryLabelsAndAnnotations(newObject, type);
if (specContainsReplicas(newObject.kind)) { if (specContainsReplicas(newObject.kind)) {
newObject.spec.replicas = replicas newObject.spec.replicas = replicas;
} }
return newObject return newObject;
} }
function specContainsReplicas(kind: string) { function specContainsReplicas(kind: string) {
@@ -169,19 +143,19 @@ function specContainsReplicas(kind: string) {
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
!isServiceEntity(kind) !isServiceEntity(kind)
) );
} }
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) { function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newLabels = new Map<string, string>() const newLabels = new Map<string, string>();
newLabels[CANARY_VERSION_LABEL] = type newLabels[CANARY_VERSION_LABEL] = type;
updateObjectLabels(inputObject, newLabels, false) updateObjectLabels(inputObject, newLabels, false);
updateObjectAnnotations(inputObject, newLabels, false) updateObjectAnnotations(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false) updateSelectorLabels(inputObject, newLabels, false);
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false) updateSpecLabels(inputObject, newLabels, false);
} }
} }
@@ -192,30 +166,30 @@ async function cleanUpCanary(
) { ) {
const deleteObject = async function (kind, name) { const deleteObject = async function (kind, name) {
try { try {
const result = await kubectl.delete([kind, name]) const result = await kubectl.delete([kind, name]);
checkForErrors([result]) checkForErrors([result]);
} catch (ex) { } catch (ex) {
// Ignore failures of delete if it doesn't exist // Ignore failures of delete if it doesn't exist
} }
} };
for (const filePath of files) { 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) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name const name = inputObject.metadata.name;
const kind = inputObject.kind const kind = inputObject.kind;
if ( if (
isDeploymentEntity(kind) || isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind)) (includeServices && isServiceEntity(kind))
) { ) {
const canaryObjectName = getCanaryResourceName(name) const canaryObjectName = getCanaryResourceName(name);
const baselineObjectName = getBaselineResourceName(name) const baselineObjectName = getBaselineResourceName(name);
await deleteObject(kind, canaryObjectName) await deleteObject(kind, canaryObjectName);
await deleteObject(kind, baselineObjectName) await deleteObject(kind, baselineObjectName);
} }
} }
} }
+58 -52
View File
@@ -1,84 +1,90 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import {isDeploymentEntity} from '../../types/kubernetesTypes' import { isDeploymentEntity } from "../../types/kubernetesTypes";
import {getReplicaCount} from '../../utilities/manifestUpdateUtils' import { getReplicaCount } from "../../utilities/manifestUpdateUtils";
export async function deployPodCanary( export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
filePaths: string[], const newObjectsList = [];
kubectl: Kubectl, const percentage = parseInt(core.getInput("percentage"));
onlyDeployStable: boolean = false
) {
const newObjectsList = []
const percentage = parseInt(core.getInput('percentage', {required: true}))
if (percentage < 0 || percentage > 100) 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) { for (const filePath of filePaths) {
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) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name const name = inputObject.metadata.name;
const kind = inputObject.kind const kind = inputObject.kind;
if (!onlyDeployStable && isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
core.debug('Calculating replica count for canary') core.debug("Calculating replica count for canary");
const canaryReplicaCount = calculateReplicaCountForCanary( const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject, inputObject,
percentage percentage
) );
core.debug('Replica count is ' + canaryReplicaCount) core.debug("Replica count is " + canaryReplicaCount);
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( // Get stable object
inputObject, core.debug("Querying stable object");
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
// if there's already a stable object, deploy baseline as well
const stableObject = await canaryDeploymentHelper.fetchResource( const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
kind, kind,
name name
) );
if (stableObject) {
if (!stableObject) {
core.debug("Stable object not found. Creating canary object");
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
);
newObjectsList.push(newCanaryObject);
} else {
core.debug( core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects` "Creating canary and baseline objects. Stable object found: " +
) JSON.stringify(stableObject)
);
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
);
core.debug("New canary object: " + JSON.stringify(newCanaryObject));
const newBaselineObject = const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource( canaryDeploymentHelper.getNewBaselineResource(
stableObject, stableObject,
canaryReplicaCount canaryReplicaCount
) );
core.debug( core.debug(
'New baseline object: ' + JSON.stringify(newBaselineObject) "New baseline object: " + JSON.stringify(newBaselineObject)
) );
newObjectsList.push(newBaselineObject)
newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject);
} }
} else { } else {
// deploy non deployment entity or regular deployments for promote as they are // update non deployment entity as it is
newObjectsList.push(inputObject) newObjectsList.push(inputObject);
} }
} }
} }
core.debug('New objects list: ' + JSON.stringify(newObjectsList)) core.debug("New objects list: " + JSON.stringify(newObjectsList));
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(manifestFiles, forceDeployment) const result = await kubectl.apply(manifestFiles, forceDeployment);
return {result, newFilePaths: manifestFiles} return { result, newFilePaths: manifestFiles };
} }
export function calculateReplicaCountForCanary( function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
inputObject: any, const inputReplicaCount = getReplicaCount(inputObject);
percentage: number return Math.round((inputReplicaCount * percentage) / 100);
) {
const inputReplicaCount = getReplicaCount(inputObject)
return Math.max(1, Math.round((inputReplicaCount * percentage) / 100))
} }
+130 -162
View File
@@ -1,209 +1,178 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import * as podCanaryHelper from './podCanaryHelper' import {
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes' isDeploymentEntity,
import {checkForErrors} from '../../utilities/kubectlUtils' isServiceEntity,
import {inputAnnotations} from '../../inputUtils' } from "../../types/kubernetesTypes";
import { checkForErrors } from "../../utilities/kubectlUtils";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout' const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout";
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit' const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export async function deploySMICanary( export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
filePaths: string[], const canaryReplicaCount = parseInt(
kubectl: Kubectl, core.getInput("baseline-and-canary-replicas")
onlyDeployStable: boolean = false );
) { if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
const canaryReplicasInput = core.getInput('baseline-and-canary-replicas') throw Error("Baseline-and-canary-replicas must be between 0 and 100");
let canaryReplicaCount
let calculateReplicas = true
if (canaryReplicasInput !== '') {
canaryReplicaCount = parseInt(canaryReplicasInput)
calculateReplicas = false
core.debug(
`read replica count ${canaryReplicaCount} from input: ${canaryReplicasInput}`
)
}
if (canaryReplicaCount < 0 && canaryReplicaCount > 100) const newObjectsList = [];
throw Error('Baseline-and-canary-replicas must be between 0 and 100') filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
const newObjectsList = [] if (isDeploymentEntity(kind)) {
for await (const filePath of filePaths) { const stableObject = canaryDeploymentHelper.fetchResource(
const fileContents = fs.readFileSync(filePath).toString() kubectl,
const inputObjects = yaml.safeLoadAll(fileContents) kind,
for (const inputObject of inputObjects) { name
const name = inputObject.metadata.name );
const kind = inputObject.kind
if (!onlyDeployStable && isDeploymentEntity(kind)) { if (!stableObject) {
if (calculateReplicas) { core.debug("Stable object not found. Creating only canary object");
// calculate for each object
const percentage = parseInt(
core.getInput('percentage', {required: true})
)
canaryReplicaCount =
podCanaryHelper.calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug(`calculated replica count ${canaryReplicaCount}`)
}
core.debug('Creating canary object')
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject, inputObject,
canaryReplicaCount canaryReplicaCount
) );
newObjectsList.push(newCanaryObject) newObjectsList.push(newCanaryObject);
} else {
if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) {
throw Error(`StableSpecSelectorNotExist : ${name}`);
}
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
)
if (stableObject) {
core.debug( core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects` "Stable object found. Creating canary and baseline objects"
) );
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
);
const newBaselineObject = const newBaselineObject =
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment( canaryDeploymentHelper.getNewBaselineResource(
stableObject, stableObject,
canaryReplicaCount canaryReplicaCount
) );
newObjectsList.push(newBaselineObject) newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject);
} }
} else if (isDeploymentEntity(kind)) {
core.debug(
`creating stable deployment with ${inputObject.spec.replicas} replicas`
)
const stableDeployment =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(stableDeployment)
} else { } else {
// Update non deployment entity or stable deployment as it is // Update non deployment entity as it is
newObjectsList.push(inputObject) newObjectsList.push(inputObject);
} }
} });
} });
core.debug(
`deploying canary objects with SMI: \n ${JSON.stringify(newObjectsList)}` const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList);
) const forceDeployment = core.getInput("force").toLowerCase() === "true";
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList) const result = await kubectl.apply(newFilePaths, forceDeployment);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' await createCanaryService(kubectl, filePaths);
const result = await kubectl.apply(newFilePaths, forceDeployment) return { result, newFilePaths };
await createCanaryService(kubectl, filePaths)
return {result, newFilePaths}
} }
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) { async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
const newObjectsList = [] const newObjectsList = [];
const trafficObjectsList: string[] = [] const trafficObjectsList = [];
for (const filePath of filePaths) { for (const filePath of filePaths) {
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) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name const name = inputObject.metadata.name;
const kind = inputObject.kind const kind = inputObject.kind;
if (isServiceEntity(kind)) { if (isServiceEntity(kind)) {
core.debug(`Creating services for ${kind} ${name}`)
const newCanaryServiceObject = const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject) canaryDeploymentHelper.getNewCanaryResource(inputObject);
newObjectsList.push(newCanaryServiceObject) newObjectsList.push(newCanaryServiceObject);
const newBaselineServiceObject = const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject) canaryDeploymentHelper.getNewBaselineResource(inputObject);
newObjectsList.push(newBaselineServiceObject) newObjectsList.push(newBaselineServiceObject);
const stableObject = await canaryDeploymentHelper.fetchResource( const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
kind, kind,
canaryDeploymentHelper.getStableResourceName(name) canaryDeploymentHelper.getStableResourceName(name)
) );
if (!stableObject) { if (!stableObject) {
const newStableServiceObject = const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject) canaryDeploymentHelper.getStableResource(inputObject);
newObjectsList.push(newStableServiceObject) 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( const trafficObject = await createTrafficSplitManifestFile(
kubectl, kubectl,
name, name,
0, 0,
0, 0,
1000 1000
) );
trafficObjectsList.push(trafficObject) trafficObjectsList.push(trafficObject);
} else { } else {
let updateTrafficObject = true let updateTrafficObject = true;
const trafficObject = await canaryDeploymentHelper.fetchResource( const trafficObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name) getTrafficSplitResourceName(name)
) );
if (trafficObject) { if (trafficObject) {
const trafficJObject = JSON.parse( const trafficJObject = JSON.parse(JSON.stringify(trafficObject));
JSON.stringify(trafficObject)
)
if (trafficJObject?.spec?.backends) { if (trafficJObject?.spec?.backends) {
trafficJObject.spec.backends.forEach((s) => { trafficJObject.spec.backends.forEach((s) => {
if ( if (
s.service === s.service ===
canaryDeploymentHelper.getCanaryResourceName( canaryDeploymentHelper.getCanaryResourceName(name) &&
name s.weight === "1000m"
) &&
s.weight === '1000m'
) { ) {
core.debug('Update traffic objcet not required') core.debug("Update traffic objcet not required");
updateTrafficObject = false updateTrafficObject = false;
} }
}) });
} }
} }
if (updateTrafficObject) { if (updateTrafficObject) {
core.debug( 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 name
) );
trafficObjectsList.push( trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
await updateTrafficSplitObject(kubectl, name)
)
} }
} }
} }
} }
} }
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
manifestFiles.push(...trafficObjectsList) manifestFiles.push(...trafficObjectsList);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(manifestFiles, forceDeployment) const result = await kubectl.apply(manifestFiles, forceDeployment);
checkForErrors([result]) checkForErrors([result]);
} }
export async function redirectTrafficToCanaryDeployment( export async function redirectTrafficToCanaryDeployment(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[] manifestFilePaths: string[]
) { ) {
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000) await adjustTraffic(kubectl, manifestFilePaths, 0, 1000);
} }
export async function redirectTrafficToStableDeployment( export async function redirectTrafficToStableDeployment(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[] manifestFilePaths: string[]
) { ) {
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0) await adjustTraffic(kubectl, manifestFilePaths, 1000, 0);
} }
async function adjustTraffic( async function adjustTraffic(
@@ -213,16 +182,16 @@ async function adjustTraffic(
canaryWeight: number canaryWeight: number
) { ) {
if (!manifestFilePaths || manifestFilePaths?.length == 0) { if (!manifestFilePaths || manifestFilePaths?.length == 0) {
return return;
} }
const trafficSplitManifests = [] const trafficSplitManifests = [];
for (const filePath of manifestFilePaths) { for (const filePath of manifestFilePaths) {
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) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name const name = inputObject.metadata.name;
const kind = inputObject.kind const kind = inputObject.kind;
if (isServiceEntity(kind)) { if (isServiceEntity(kind)) {
trafficSplitManifests.push( trafficSplitManifests.push(
@@ -233,47 +202,47 @@ async function adjustTraffic(
0, 0,
canaryWeight canaryWeight
) )
) );
} }
} }
} }
if (trafficSplitManifests.length <= 0) { if (trafficSplitManifests.length <= 0) {
return return;
} }
const forceDeployment = core.getInput('force').toLowerCase() === 'true' const forceDeployment = core.getInput("force").toLowerCase() === "true";
const result = await kubectl.apply(trafficSplitManifests, forceDeployment) const result = await kubectl.apply(trafficSplitManifests, forceDeployment);
checkForErrors([result]) checkForErrors([result]);
} }
async function updateTrafficSplitObject( async function updateTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
serviceName: string serviceName: string
): Promise<string> { ): Promise<string> {
const percentage = parseInt(core.getInput('percentage', {required: true})) const percentage = parseInt(core.getInput("percentage"));
if (percentage < 0 || percentage > 100) 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 percentageWithMuliplier = percentage * 10;
const baselineAndCanaryWeight = percentageWithMuliplier / 2 const baselineAndCanaryWeight = percentageWithMuliplier / 2;
const stableDeploymentWeight = 1000 - percentageWithMuliplier const stableDeploymentWeight = 1000 - percentageWithMuliplier;
core.debug( core.debug(
'Creating the traffic object with canary weight: ' + "Creating the traffic object with canary weight: " +
baselineAndCanaryWeight + baselineAndCanaryWeight +
', baseline weight: ' + ",baseling weight: " +
baselineAndCanaryWeight + baselineAndCanaryWeight +
', stable weight: ' + ",stable: " +
stableDeploymentWeight stableDeploymentWeight
) );
return await createTrafficSplitManifestFile( return await createTrafficSplitManifestFile(
kubectl, kubectl,
serviceName, serviceName,
stableDeploymentWeight, stableDeploymentWeight,
baselineAndCanaryWeight, baselineAndCanaryWeight,
baselineAndCanaryWeight baselineAndCanaryWeight
) );
} }
async function createTrafficSplitManifestFile( async function createTrafficSplitManifestFile(
@@ -289,21 +258,21 @@ async function createTrafficSplitManifestFile(
stableWeight, stableWeight,
baselineWeight, baselineWeight,
canaryWeight canaryWeight
) );
const manifestFile = fileHelper.writeManifestToFile( const manifestFile = fileHelper.writeManifestToFile(
smiObjectString, smiObjectString,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
serviceName serviceName
) );
if (!manifestFile) { 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( async function getTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
@@ -316,36 +285,35 @@ async function getTrafficSplitObject(
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl kubectl
) );
} }
return JSON.stringify({ return JSON.stringify({
apiVersion: trafficSplitAPIVersion, apiVersion: trafficSplitAPIVersion,
kind: 'TrafficSplit', kind: "TrafficSplit",
metadata: { metadata: {
name: getTrafficSplitResourceName(name), name: getTrafficSplitResourceName(name),
annotations: inputAnnotations
}, },
spec: { spec: {
backends: [ backends: [
{ {
service: canaryDeploymentHelper.getStableResourceName(name), service: canaryDeploymentHelper.getStableResourceName(name),
weight: stableWeight weight: stableWeight,
}, },
{ {
service: canaryDeploymentHelper.getBaselineResourceName(name), service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight weight: baselineWeight,
}, },
{ {
service: canaryDeploymentHelper.getCanaryResourceName(name), service: canaryDeploymentHelper.getCanaryResourceName(name),
weight: canaryWeight weight: canaryWeight,
} },
], ],
service: name service: name,
} },
}) });
} }
function getTrafficSplitResourceName(name: string) { function getTrafficSplitResourceName(name: string) {
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX;
} }
+94 -106
View File
@@ -1,44 +1,40 @@
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as canaryDeploymentHelper from './canary/canaryHelper' import * as canaryDeploymentHelper from "./canary/canaryHelper";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import {isDeploymentEntity} from '../types/kubernetesTypes' import { isDeploymentEntity } from "../types/kubernetesTypes";
import * as fileHelper from '../utilities/fileUtils' import * as fileHelper from "../utilities/fileUtils";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {deployPodCanary} from './canary/podCanaryHelper' import { deployPodCanary } from "./canary/podCanaryHelper";
import {deploySMICanary} from './canary/smiCanaryHelper' import { deploySMICanary } from "./canary/smiCanaryHelper";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import { import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper";
deployBlueGreen, import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper";
deployBlueGreenIngress, import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper";
deployBlueGreenService import { DeploymentStrategy } from "../types/deploymentStrategy";
} from './blueGreen/deploy' import * as core from "@actions/core";
import {deployBlueGreenSMI} from './blueGreen/deploy'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from '@actions/core'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod TrafficSplitMethod,
} from '../types/trafficSplitMethod' } from "../types/trafficSplitMethod";
import {parseRouteStrategy} from '../types/routeStrategy' import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import { import {
getWorkflowAnnotationKeyLabel, getWorkflowAnnotationKeyLabel,
getWorkflowAnnotations, getWorkflowAnnotations,
cleanLabel } from "../utilities/workflowAnnotationUtils";
} from '../utilities/workflowAnnotationUtils'
import { import {
annotateChildPods, annotateChildPods,
checkForErrors, checkForErrors,
getLastSuccessfulRunSha getLastSuccessfulRunSha,
} from '../utilities/kubectlUtils' } from "../utilities/kubectlUtils";
import { import {
getWorkflowFilePath, getWorkflowFilePath,
normalizeWorkflowStrLabel normalizeWorkflowStrLabel,
} from '../utilities/githubUtils' } from "../utilities/githubUtils";
import {getDeploymentConfig} from '../utilities/dockerUtils' import { getDeploymentConfig } from "../utilities/dockerUtils";
export async function deployManifests( export async function deployManifests(
files: string[], files: string[],
@@ -51,90 +47,84 @@ export async function deployManifests(
const { result, newFilePaths } = const { result, newFilePaths } =
trafficSplitMethod == TrafficSplitMethod.SMI trafficSplitMethod == TrafficSplitMethod.SMI
? await deploySMICanary(files, kubectl) ? await deploySMICanary(files, kubectl)
: await deployPodCanary(files, kubectl) : await deployPodCanary(files, kubectl);
checkForErrors([result]) checkForErrors([result]);
return newFilePaths return newFilePaths;
} }
case DeploymentStrategy.BLUE_GREEN: { case DeploymentStrategy.BLUE_GREEN: {
const routeStrategy = parseRouteStrategy( const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true}) core.getInput("route-method", { required: true })
) );
const blueGreenDeployment = await deployBlueGreen(
kubectl,
files,
routeStrategy
)
core.debug(
`objects deployed for ${routeStrategy}: ${JSON.stringify(
blueGreenDeployment.objects
)} `
)
checkForErrors([blueGreenDeployment.deployResult.execResult]) const { result, newFilePaths } = await Promise.resolve(
return blueGreenDeployment.deployResult.manifestFiles (routeStrategy == RouteStrategy.INGRESS &&
deployBlueGreenIngress(kubectl, files)) ||
(routeStrategy == RouteStrategy.SMI &&
deployBlueGreenSMI(kubectl, files)) ||
deployBlueGreenService(kubectl, files)
);
checkForErrors([result]);
return newFilePaths;
} }
case DeploymentStrategy.BASIC: { case undefined: {
const trafficSplitMethod = parseTrafficSplitMethod( core.warning("Deployment strategy is not recognized.");
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
}
default: { 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[] { function appendStableVersionLabelToResource(files: string[]): string[] {
const manifestFiles = [] const manifestFiles = [];
const newObjectsList = [] const newObjectsList = [];
files.forEach((filePath: string) => { files.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString() const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, function (inputObject) { yaml.safeLoadAll(fileContents, function (inputObject) {
const {kind} = inputObject const { kind } = inputObject;
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
const updatedObject = const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject) canaryDeploymentHelper.markResourceAsStable(inputObject);
newObjectsList.push(updatedObject) newObjectsList.push(updatedObject);
} else { } else {
manifestFiles.push(filePath) manifestFiles.push(filePath);
} }
}) });
}) });
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList) const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
manifestFiles.push(...updatedManifestFiles) manifestFiles.push(...updatedManifestFiles);
return manifestFiles return manifestFiles;
} }
export async function checkManifestStability( export async function checkManifestStability(
kubectl: Kubectl, kubectl: Kubectl,
resources: Resource[] resources: Resource[]
): Promise<void> { ): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(kubectl, resources) await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
} }
export async function annotateAndLabelResources( export async function annotateAndLabelResources(
@@ -143,11 +133,11 @@ export async function annotateAndLabelResources(
resourceTypes: Resource[], resourceTypes: Resource[],
allPods: any allPods: any
) { ) {
const githubToken = core.getInput('token') const githubToken = core.getInput("token");
const workflowFilePath = await getWorkflowFilePath(githubToken) const workflowFilePath = await getWorkflowFilePath(githubToken);
const deploymentConfig = await getDeploymentConfig() const deploymentConfig = await getDeploymentConfig();
const annotationKeyLabel = getWorkflowAnnotationKeyLabel() const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath);
await annotateResources( await annotateResources(
files, files,
@@ -157,8 +147,8 @@ export async function annotateAndLabelResources(
annotationKeyLabel, annotationKeyLabel,
workflowFilePath, workflowFilePath,
deploymentConfig deploymentConfig
) );
await labelResources(files, kubectl, annotationKeyLabel) await labelResources(files, kubectl, annotationKeyLabel);
} }
async function annotateResources( async function annotateResources(
@@ -170,36 +160,34 @@ async function annotateResources(
workflowFilePath: string, workflowFilePath: string,
deploymentConfig: DeploymentConfig deploymentConfig: DeploymentConfig
) { ) {
const annotateResults: ExecOutput[] = [] const annotateResults: ExecOutput[] = [];
const namespace = core.getInput('namespace') || 'default' const namespace = core.getInput("namespace") || "default";
const lastSuccessSha = await getLastSuccessfulRunSha( const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl, kubectl,
namespace, namespace,
annotationKey annotationKey
) );
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations( const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
lastSuccessSha, lastSuccessSha,
workflowFilePath, workflowFilePath,
deploymentConfig deploymentConfig
)}` )}`;
const annotateNamespace = !( const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false");
core.getInput('annotate-namespace').toLowerCase() === 'false'
)
if (annotateNamespace) { if (annotateNamespace) {
annotateResults.push( 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) { for (const resource of resourceTypes) {
if ( if (
resource.type.toLowerCase() !== resource.type.toLowerCase() !==
models.KubernetesWorkload.POD.toLowerCase() models.KubernetesWorkload.POD.toLowerCase()
) { ) {
;( (
await annotateChildPods( await annotateChildPods(
kubectl, kubectl,
resource.type, resource.type,
@@ -207,11 +195,11 @@ async function annotateResources(
annotationKeyValStr, annotationKeyValStr,
allPods allPods
) )
).forEach((execResult) => annotateResults.push(execResult)) ).forEach((execResult) => annotateResults.push(execResult));
} }
} }
checkForErrors(annotateResults, true) checkForErrors(annotateResults, true);
} }
async function labelResources( async function labelResources(
@@ -220,11 +208,11 @@ async function labelResources(
label: string label: string
) { ) {
const labels = [ const labels = [
`workflowFriendlyName=${cleanLabel( `workflowFriendlyName=${normalizeWorkflowStrLabel(
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW) 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', () => { describe("Action type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(Action) const vals = <any>Object.values(Action);
expect(vals.includes('deploy')).toBe(true) expect(vals.includes("deploy")).toBe(true);
expect(vals.includes('promote')).toBe(true) expect(vals.includes("promote")).toBe(true);
expect(vals.includes('reject')).toBe(true) expect(vals.includes("reject")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseAction('deploy')).toBe(Action.DEPLOY) expect(parseAction("deploy")).toBe(Action.DEPLOY);
expect(parseAction('Deploy')).toBe(Action.DEPLOY) expect(parseAction("Deploy")).toBe(Action.DEPLOY);
expect(parseAction('DEPLOY')).toBe(Action.DEPLOY) expect(parseAction("DEPLOY")).toBe(Action.DEPLOY);
expect(parseAction('deploY')).toBe(Action.DEPLOY) expect(parseAction("deploY")).toBe(Action.DEPLOY);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction('invalid')).toBe(undefined) expect(parseAction("invalid")).toBe(undefined);
expect(parseAction('unsupportedType')).toBe(undefined) expect(parseAction("unsupportedType")).toBe(undefined);
}) });
}) });
+4 -4
View File
@@ -1,7 +1,7 @@
export enum Action { export enum Action {
DEPLOY = 'deploy', DEPLOY = "deploy",
PROMOTE = 'promote', PROMOTE = "promote",
REJECT = 'reject' REJECT = "reject",
} }
/** /**
@@ -14,4 +14,4 @@ export const parseAction = (str: string): Action | undefined =>
Object.keys(Action).filter( Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase() (k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof Action )[0] as keyof typeof Action
] ];
-8
View File
@@ -1,8 +0,0 @@
export function parseAnnotations(str: string) {
if (str == '') {
return new Map<string, string>()
} else {
const annotation = JSON.parse(str)
return new Map<string, string>(annotation)
}
}
-21
View File
@@ -1,21 +0,0 @@
import {DeployResult} from './deployResult'
import {K8sObject, K8sDeleteObject} from './k8sObject'
export interface BlueGreenDeployment {
deployResult: DeployResult
objects: K8sObject[]
}
export interface BlueGreenManifests {
serviceEntityList: K8sObject[]
serviceNameMap: Map<string, string>
unroutedServiceEntityList: K8sObject[]
deploymentEntityList: K8sObject[]
ingressEntityList: K8sObject[]
otherObjects: K8sObject[]
}
export interface BlueGreenRejectResult {
deleteResult: K8sDeleteObject[]
routeResult: BlueGreenDeployment
}
-6
View File
@@ -1,6 +0,0 @@
import {ExecOutput} from '@actions/exec'
export interface DeployResult {
execResult: ExecOutput
manifestFiles: string[]
}
+3 -3
View File
@@ -1,5 +1,5 @@
export interface DeploymentConfig { export interface DeploymentConfig {
manifestFilePaths: string[] manifestFilePaths: string[];
helmChartFilePaths: string[] helmChartFilePaths: string[];
dockerfilePaths: any dockerfilePaths: any;
} }
+21 -19
View File
@@ -1,25 +1,27 @@
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy' import {
DeploymentStrategy,
parseDeploymentStrategy,
} from "./deploymentStrategy";
describe('Deployment strategy type', () => { describe("Deployment strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(DeploymentStrategy) const vals = <any>Object.values(DeploymentStrategy);
expect(vals.includes('canary')).toBe(true) expect(vals.includes("canary")).toBe(true);
expect(vals.includes('blue-green')).toBe(true) expect(vals.includes("blue-green")).toBe(true);
expect(vals.includes('basic')).toBe(true) });
})
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseDeploymentStrategy('blue-green')).toBe( expect(parseDeploymentStrategy("blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('Blue-green')).toBe( expect(parseDeploymentStrategy("Blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe( expect(parseDeploymentStrategy("BLUE-GREEN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('blue-greeN')).toBe( expect(parseDeploymentStrategy("blue-greeN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
}) });
}) });
+3 -4
View File
@@ -1,7 +1,6 @@
export enum DeploymentStrategy { export enum DeploymentStrategy {
BASIC = 'basic', CANARY = "canary",
CANARY = 'canary', BLUE_GREEN = "blue-green",
BLUE_GREEN = 'blue-green'
} }
/** /**
@@ -17,4 +16,4 @@ export const parseDeploymentStrategy = (
(k) => (k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase() DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy )[0] as keyof typeof DeploymentStrategy
] ];
+63 -63
View File
@@ -1,98 +1,98 @@
import {DockerExec} from './docker' import { DockerExec } from "./docker";
import * as actions from '@actions/exec' import * as actions from "@actions/exec";
const dockerPath = 'dockerPath' const dockerPath = "dockerPath";
const image = 'image' const image = "image";
const args = ['arg1', 'arg2', 'arg3'] const args = ["arg1", "arg2", "arg3"];
describe('Docker class', () => { describe("Docker class", () => {
const docker = new DockerExec(dockerPath) const docker = new DockerExec(dockerPath);
describe('with a success exec return', () => { describe("with a success exec return", () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''} const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await docker.pull(image, args) await docker.pull(image, args);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{ silent: false } { silent: false }
) );
}) });
test('pulls an image silently', async () => { test("pulls an image silently", async () => {
await docker.pull(image, args, true) await docker.pull(image, args, true);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{ silent: true } { silent: true }
) );
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await docker.inspect(image, args) const result = await docker.inspect(image, args);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{ silent: false } { silent: false }
) );
}) });
test('inspects a docker image silently', async () => { test("inspects a docker image silently", async () => {
const result = await docker.inspect(image, args, true) const result = await docker.inspect(image, args, true);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{ silent: true } { silent: true }
) );
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 3, stdout: '', stderr: ''} const execReturn = { exitCode: 3, stdout: "", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'} const execReturn = { exitCode: 0, stdout: "", stderr: "Output" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
}) });
+11 -11
View File
@@ -1,16 +1,16 @@
import {getExecOutput} from '@actions/exec' import { getExecOutput } from "@actions/exec";
export class DockerExec { export class DockerExec {
private readonly dockerPath: string private readonly dockerPath: string;
constructor(dockerPath: string) { constructor(dockerPath: string) {
this.dockerPath = dockerPath this.dockerPath = dockerPath;
} }
public async pull(image: string, args: string[], silent?: boolean) { public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(['pull', image, ...args], silent) const result = await this.execute(["pull", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) { if (result.stderr != "" || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`) throw new Error(`docker images pull failed: ${result.stderr}`);
} }
} }
@@ -19,14 +19,14 @@ export class DockerExec {
args: string[], args: string[],
silent: boolean = false silent: boolean = false
): Promise<string> { ): Promise<string> {
const result = await this.execute(['inspect', image, ...args], silent) const result = await this.execute(["inspect", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) if (result.stderr != "" || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`) throw new Error(`docker inspect failed: ${result.stderr}`);
return result.stdout return result.stdout;
} }
private async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, {silent}) return await getExecOutput(this.dockerPath, args, { silent });
} }
} }
+18 -20
View File
@@ -1,40 +1,38 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {Octokit} from '@octokit/core' import { Octokit } from "@octokit/core";
import {Endpoints} from '@octokit/types' import { Endpoints } from "@octokit/types";
import {retry} from '@octokit/plugin-retry' import { retry } from "@octokit/plugin-retry";
export const OkStatusCode = 200 export const OkStatusCode = 200;
const RetryOctokit = Octokit.plugin(retry) const RetryOctokit = Octokit.plugin(retry);
const RETRY_COUNT = 5 const RETRY_COUNT = 5;
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows' const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows";
type responseType = type responseType =
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response'] Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
export class GitHubClient { export class GitHubClient {
private readonly repository: string private readonly repository: string;
private readonly token: string private readonly token: string;
constructor(repository: string, token: string) { constructor(repository: string, token: string) {
this.repository = repository this.repository = repository;
this.token = token this.token = token;
} }
// prettier-ignore
public async getWorkflows(): Promise<responseType> { public async getWorkflows(): Promise<responseType> {
const octokit = new RetryOctokit({ const octokit = new RetryOctokit({
auth: this.token, auth: this.token,
request: { retries: RETRY_COUNT }, request: { retries: RETRY_COUNT },
baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com", });
}) const [owner, repo] = this.repository.split("/");
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( return Promise.resolve(
await octokit.request(requestUrl, { await octokit.request(requestUrl, {
owner, owner,
repo repo,
}) })
) );
} }
} }
-57
View File
@@ -1,57 +0,0 @@
export interface K8sObject {
metadata: {
name: string
labels: Map<string, string>
}
kind: string
spec: any
}
export interface K8sServiceObject extends K8sObject {
spec: {
selector: Map<string, string>
}
}
export interface K8sDeleteObject {
name: string
kind: string
}
export interface K8sIngress extends K8sObject {
spec: {
rules: [
{
http: {
paths: [
{
backend: {
service: {
name: string
}
}
}
]
}
}
]
}
}
export interface TrafficSplitObject extends K8sObject {
apiVersion: string
metadata: {
name: string
labels: Map<string, string>
annotations: Map<string, string>
}
spec: {
service: string
backends: TrafficSplitBackend[]
}
}
export interface TrafficSplitBackend {
service: string
weight: number
}
+209 -245
View File
@@ -1,367 +1,331 @@
import {getKubectlPath, Kubectl} from './kubectl' import { getKubectlPath, Kubectl } from "./kubectl";
import * as exec from '@actions/exec' import * as exec from "@actions/exec";
import * as io from '@actions/io' import * as io from "@actions/io";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import {config} from 'process' import { config } from "process";
describe('Kubectl path', () => { describe("Kubectl path", () => {
const version = '1.1' const version = "1.1";
const path = 'path' const path = "path";
it('gets the kubectl path', async () => { it("gets the kubectl path", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('gets the kubectl path with version', async () => { it("gets the kubectl path with version", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version) jest.spyOn(core, "getInput").mockImplementationOnce(() => version);
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path) jest.spyOn(toolCache, "find").mockImplementationOnce(() => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('throws if kubectl not found', async () => { it("throws if kubectl not found", async () => {
// without version // without version
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
// with verision // with verision
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
}) });
}) });
const kubectlPath = 'kubectlPath' const kubectlPath = "kubectlPath";
const testNamespace = 'testNamespace' const namespace = "namespace";
const defaultNamespace = 'default' describe("Kubectl class", () => {
describe('Kubectl class', () => { const kubectl = new Kubectl(kubectlPath, namespace);
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace) describe("with a success exec return", () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''} const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => { jest.spyOn(exec, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
describe('omits default namespace from commands', () => { it("applies a configuration with a single config path", async () => {
it('executes a command without appending --namespace arg', async () => { const configPaths = "configPaths";
// no args const result = await kubectl.apply(configPaths);
const command = 'command' expect(result).toBe(execReturn);
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)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace], ["apply", "-f", configPaths, "--namespace", namespace],
{ silent: false } { silent: false }
) );
}) });
it('applies a configuration with multiple config paths', async () => { it("applies a configuration with multiple config paths", async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3'] const configPaths = ["configPath1", "configPath2", "configPath3"];
const result = await kubectl.apply(configPaths) const result = await kubectl.apply(configPaths);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'apply', "apply",
'-f', "-f",
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2], configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('applies a configuration with force when specified', async () => { it("applies a configuration with force when specified", async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3'] const configPaths = ["configPath1", "configPath2", "configPath3"];
const result = await kubectl.apply(configPaths, true) const result = await kubectl.apply(configPaths, true);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'apply', "apply",
'-f', "-f",
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2], configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
'--force', "--force",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('describes a resource', async () => { it("describes a resource", async () => {
const resourceType = 'type' const resourceType = "type";
const resourceName = 'name' const resourceName = "name";
const result = await kubectl.describe(resourceType, resourceName) const result = await kubectl.describe(resourceType, resourceName);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ ["describe", resourceType, resourceName, "--namespace", namespace],
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{ silent: false } { silent: false }
) );
}) });
it('describes a resource silently', async () => { it("describes a resource silently", async () => {
const resourceType = 'type' const resourceType = "type";
const resourceName = 'name' const resourceName = "name";
const result = await kubectl.describe(resourceType, resourceName, true) const result = await kubectl.describe(resourceType, resourceName, true);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ ["describe", resourceType, resourceName, "--namespace", namespace],
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{ silent: true } { silent: true }
) );
}) });
it('annotates resource', async () => { it("annotates resource", async () => {
const resourceType = 'type' const resourceType = "type";
const resourceName = 'name' const resourceName = "name";
const annotation = 'annotation' const annotation = "annotation";
const result = await kubectl.annotate( const result = await kubectl.annotate(
resourceType, resourceType,
resourceName, resourceName,
annotation annotation
) );
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'annotate', "annotate",
resourceType, resourceType,
resourceName, resourceName,
annotation, annotation,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('annotates files with single file', async () => { it("annotates files with single file", async () => {
const file = 'file' const file = "file";
const annotation = 'annotation' const annotation = "annotation";
const result = await kubectl.annotateFiles(file, annotation) const result = await kubectl.annotateFiles(file, annotation);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'annotate', "annotate",
'-f', "-f",
file, file,
annotation, annotation,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('annotates files with mulitple files', async () => { it("annotates files with mulitple files", async () => {
const files = ['file1', 'file2', 'file3'] const files = ["file1", "file2", "file3"];
const annotation = 'annotation' const annotation = "annotation";
const result = await kubectl.annotateFiles(files, annotation) const result = await kubectl.annotateFiles(files, annotation);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'annotate', "annotate",
'-f', "-f",
files.join(','), files.join(","),
annotation, annotation,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('labels files with single file', async () => { it("labels files with single file", async () => {
const file = 'file' const file = "file";
const labels = ['label1', 'label2'] const labels = ["label1", "label2"];
const result = await kubectl.labelFiles(file, labels) const result = await kubectl.labelFiles(file, labels);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'label', "label",
'-f', "-f",
file, file,
...labels, ...labels,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('labels files with multiple files', async () => { it("labels files with multiple files", async () => {
const files = ['file1', 'file2', 'file3'] const files = ["file1", "file2", "file3"];
const labels = ['label1', 'label2'] const labels = ["label1", "label2"];
const result = await kubectl.labelFiles(files, labels) const result = await kubectl.labelFiles(files, labels);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'label', "label",
'-f', "-f",
files.join(','), files.join(","),
...labels, ...labels,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('gets all pods', async () => { it("gets all pods", async () => {
expect(await kubectl.getAllPods()).toBe(execReturn) expect(await kubectl.getAllPods()).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
['get', 'pods', '-o', 'json', '--namespace', testNamespace], ["get", "pods", "-o", "json", "--namespace", namespace],
{ silent: true } { silent: true }
) );
}) });
it('checks rollout status', async () => { it("checks rollout status", async () => {
const resourceType = 'type' const resourceType = "type";
const name = 'name' const name = "name";
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe( expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
execReturn execReturn
) );
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'rollout', "rollout",
'status', "status",
`${resourceType}/${name}`, `${resourceType}/${name}`,
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('gets resource', async () => { it("gets resource", async () => {
const resourceType = 'type' const resourceType = "type";
const name = 'name' const name = "name";
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn) expect(await kubectl.getResource(resourceType, name)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'get', "get",
`${resourceType}/${name}`, `${resourceType}/${name}`,
'-o', "-o",
'json', "json",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{ silent: false } { silent: false }
) );
}) });
it('executes a command', async () => { it("executes a command", async () => {
// no args // no args
const command = 'command' const command = "command";
expect(await kubectl.executeCommand(command)).toBe(execReturn) expect(await kubectl.executeCommand(command)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[command, '--namespace', testNamespace], [command, "--namespace", namespace],
{ silent: false } { silent: false }
) );
// with args // with args
const args = 'args' const args = "args";
expect(await kubectl.executeCommand(command, args)).toBe(execReturn) expect(await kubectl.executeCommand(command, args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[command, args, '--namespace', testNamespace], [command, args, "--namespace", namespace],
{ silent: false } { silent: false }
) );
}) });
it('deletes with single argument', async () => { it("deletes with single argument", async () => {
const arg = 'argument' const arg = "argument";
expect(await kubectl.delete(arg)).toBe(execReturn) expect(await kubectl.delete(arg)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
['delete', arg, '--namespace', testNamespace], ["delete", arg, "--namespace", namespace],
{ silent: false } { silent: false }
) );
}) });
it('deletes with multiple arguments', async () => { it("deletes with multiple arguments", async () => {
const args = ['argument1', 'argument2', 'argument3'] const args = ["argument1", "argument2", "argument3"];
expect(await kubectl.delete(args)).toBe(execReturn) expect(await kubectl.delete(args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
['delete', ...args, '--namespace', testNamespace], ["delete", ...args, "--namespace", namespace],
{ silent: false } { silent: false }
) );
}) });
}) });
it('gets new replica sets', async () => { it("gets new replica sets", async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace) const newReplicaSetName = "newreplicaset";
const name = "name";
const newReplicaSetName = 'newreplicaset'
const name = 'name'
const describeReturn = { const describeReturn = {
exitCode: 0, exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra', stdout: newReplicaSetName + name + " " + "extra",
stderr: '' stderr: "",
} };
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => { jest.spyOn(exec, "getExecOutput").mockImplementationOnce(async () => {
return describeReturn return describeReturn;
}) });
const deployment = 'deployment' const deployment = "deployment";
const result = await kubectl.getNewReplicaSet(deployment) const result = await kubectl.getNewReplicaSet(deployment);
expect(result).toBe(name) expect(result).toBe(name);
}) });
}) });
+64 -90
View File
@@ -1,35 +1,27 @@
import {ExecOutput, getExecOutput} from '@actions/exec' import { ExecOutput, getExecOutput } from "@actions/exec";
import {createInlineArray} from '../utilities/arrayUtils' import { createInlineArray } from "../utilities/arrayUtils";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import * as io from '@actions/io' import * as io from "@actions/io";
import {exec} from 'child_process'
export interface Resource { export interface Resource {
name: string name: string;
type: string type: string;
} }
export class Kubectl { export class Kubectl {
protected readonly kubectlPath: string private readonly kubectlPath: string;
protected readonly namespace: string private readonly namespace: string;
protected readonly ignoreSSLErrors: boolean private readonly ignoreSSLErrors: boolean;
protected readonly resourceGroup: string
protected readonly name: string
protected isPrivateCluster: boolean
constructor( constructor(
kubectlPath: string, kubectlPath: string,
namespace: string = 'default', namespace: string = "default",
ignoreSSLErrors: boolean = false, ignoreSSLErrors: boolean = false
resourceGroup: string = '',
name: string = ''
) { ) {
this.kubectlPath = kubectlPath this.kubectlPath = kubectlPath;
this.ignoreSSLErrors = !!ignoreSSLErrors this.ignoreSSLErrors = !!ignoreSSLErrors;
this.namespace = namespace this.namespace = namespace;
this.resourceGroup = resourceGroup
this.name = name
} }
public async apply( public async apply(
@@ -38,18 +30,18 @@ export class Kubectl {
): Promise<ExecOutput> { ): Promise<ExecOutput> {
try { try {
if (!configurationPaths || configurationPaths?.length === 0) if (!configurationPaths || configurationPaths?.length === 0)
throw Error('Configuration paths must exist') throw Error("Configuration paths must exist");
const applyArgs: string[] = [ const applyArgs: string[] = [
'apply', "apply",
'-f', "-f",
createInlineArray(configurationPaths) createInlineArray(configurationPaths),
] ];
if (force) applyArgs.push('--force') if (force) applyArgs.push("--force");
return await this.execute(applyArgs) return await this.execute(applyArgs);
} catch (err) { } catch (err) {
core.debug('Kubectl apply failed:' + err) core.debug("Kubectl apply failed:" + err);
} }
} }
@@ -58,29 +50,26 @@ export class Kubectl {
resourceName: string, resourceName: string,
silent: boolean = false silent: boolean = false
): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute( return await this.execute(["describe", resourceType, resourceName], silent);
['describe', resourceType, resourceName],
silent
)
} }
public async getNewReplicaSet(deployment: string) { 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) { if (result?.stdout) {
const stdout = result.stdout.split('\n') const stdout = result.stdout.split("\n");
stdout.forEach((line: string) => { stdout.forEach((line: string) => {
const newreplicaset = 'newreplicaset' const newreplicaset = "newreplicaset";
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
newReplicaSet = line newReplicaSet = line
.substring(newreplicaset.length) .substring(newreplicaset.length)
.trim() .trim()
.split(' ')[0] .split(" ")[0];
}) });
} }
return newReplicaSet return newReplicaSet;
} }
public async annotate( public async annotate(
@@ -89,13 +78,13 @@ export class Kubectl {
annotation: string annotation: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
'annotate', "annotate",
resourceType, resourceType,
resourceName, resourceName,
annotation, annotation,
'--overwrite' "--overwrite",
] ];
return await this.execute(args) return await this.execute(args);
} }
public async annotateFiles( public async annotateFiles(
@@ -103,13 +92,13 @@ export class Kubectl {
annotation: string annotation: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
'annotate', "annotate",
'-f', "-f",
createInlineArray(files), createInlineArray(files),
annotation, annotation,
'--overwrite' "--overwrite",
] ];
return await this.execute(args) return await this.execute(args);
} }
public async labelFiles( public async labelFiles(
@@ -117,78 +106,63 @@ export class Kubectl {
labels: string[] labels: string[]
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
'label', "label",
'-f', "-f",
createInlineArray(files), createInlineArray(files),
...labels, ...labels,
'--overwrite' "--overwrite",
] ];
return await this.execute(args) return await this.execute(args);
} }
public async getAllPods(): Promise<ExecOutput> { 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( public async checkRolloutStatus(
resourceType: string, resourceType: string,
name: string name: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute([ return await this.execute(["rollout", "status", `${resourceType}/${name}`]);
'rollout',
'status',
`${resourceType}/${name}`
])
} }
public async getResource( public async getResource(
resourceType: string, resourceType: string,
name: string, name: string
silentFailure: boolean = false
): Promise<ExecOutput> { ): Promise<ExecOutput> {
core.debug( return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]);
'fetching resource of type ' + resourceType + ' and name ' + name
)
return await this.execute(
['get', `${resourceType}/${name}`, '-o', 'json'],
silentFailure
)
} }
public executeCommand(command: string, args?: string) { public executeCommand(command: string, args?: string) {
if (!command) throw new Error('Command must be defined') if (!command) throw new Error("Command must be defined");
return args ? this.execute([command, args]) : this.execute([command]) return args ? this.execute([command, args]) : this.execute([command]);
} }
public delete(args: string | string[]) { public delete(args: string | string[]) {
if (typeof args === 'string') return this.execute(['delete', args]) if (typeof args === "string") return this.execute(["delete", args]);
return this.execute(['delete', ...args]) return this.execute(["delete", ...args]);
} }
protected async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
if (this.ignoreSSLErrors) { 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]);
args = args.concat(['--namespace', this.namespace])
}
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
return await getExecOutput(this.kubectlPath, args, { core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`);
silent return await getExecOutput(this.kubectlPath, args, { silent });
})
} }
} }
export async function getKubectlPath() { export async function getKubectlPath() {
const version = core.getInput('kubectl-version') const version = core.getInput("kubectl-version");
const kubectlPath = version const kubectlPath = version
? toolCache.find('kubectl', version) ? toolCache.find("kubectl", version)
: await io.which('kubectl', true) : await io.which("kubectl", true);
if (!kubectlPath) if (!kubectlPath)
throw Error( 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, ResourceKindNotDefinedError,
ServiceTypes, ServiceTypes,
WORKLOAD_TYPES, WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS WORKLOAD_TYPES_WITH_ROLLOUT_STATUS,
} from './kubernetesTypes' } from "./kubernetesTypes";
describe('Kubernetes types', () => { describe("Kubernetes types", () => {
it('contains kubernetes workloads', () => { it("contains kubernetes workloads", () => {
expect(KubernetesWorkload.POD).toBe('Pod') expect(KubernetesWorkload.POD).toBe("Pod");
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset') expect(KubernetesWorkload.REPLICASET).toBe("Replicaset");
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment') expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment");
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet') expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet");
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet') expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet");
expect(KubernetesWorkload.JOB).toBe('job') expect(KubernetesWorkload.JOB).toBe("job");
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob') expect(KubernetesWorkload.CRON_JOB).toBe("cronjob");
}) });
it('contains discovery and load balancer resources', () => { it("contains discovery and load balancer resources", () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service') expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service");
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress') expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress");
}) });
it('contains service types', () => { it("contains service types", () => {
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer') expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer");
expect(ServiceTypes.NODE_PORT).toBe('NodePort') expect(ServiceTypes.NODE_PORT).toBe("NodePort");
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP') expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP");
}) });
it('contains deployment types', () => { it("contains deployment types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true) expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types', () => { it("contains workload types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true) expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types with rollout status', () => { it("contains workload types with rollout status", () => {
const expected = ['deployment', 'daemonset', 'statefulset'] const expected = ["deployment", "daemonset", "statefulset"];
expect( expect(
expected.every((val) => expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val))
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val) ).toBe(true);
) });
).toBe(true)
})
it('checks if kind is deployment entity', () => { it("checks if kind is deployment entity", () => {
// throws on no kind // throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow( expect(() => isDeploymentEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isDeploymentEntity('deployment')).toBe(true) expect(isDeploymentEntity("deployment")).toBe(true);
expect(isDeploymentEntity('Deployment')).toBe(true) expect(isDeploymentEntity("Deployment")).toBe(true);
expect(isDeploymentEntity('deploymenT')).toBe(true) expect(isDeploymentEntity("deploymenT")).toBe(true);
expect(isDeploymentEntity('DEPLOYMENT')).toBe(true) expect(isDeploymentEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is workload entity', () => { it("checks if kind is workload entity", () => {
// throws on no kind // throws on no kind
expect(() => isWorkloadEntity(undefined)).toThrow( expect(() => isWorkloadEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isWorkloadEntity('deployment')).toBe(true) expect(isWorkloadEntity("deployment")).toBe(true);
expect(isWorkloadEntity('Deployment')).toBe(true) expect(isWorkloadEntity("Deployment")).toBe(true);
expect(isWorkloadEntity('deploymenT')).toBe(true) expect(isWorkloadEntity("deploymenT")).toBe(true);
expect(isWorkloadEntity('DEPLOYMENT')).toBe(true) expect(isWorkloadEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is service entity', () => { it("checks if kind is service entity", () => {
// throws on no kind // throws on no kind
expect(() => isServiceEntity(undefined)).toThrow( expect(() => isServiceEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isServiceEntity('service')).toBe(true) expect(isServiceEntity("service")).toBe(true);
expect(isServiceEntity('Service')).toBe(true) expect(isServiceEntity("Service")).toBe(true);
expect(isServiceEntity('servicE')).toBe(true) expect(isServiceEntity("servicE")).toBe(true);
expect(isServiceEntity('SERVICE')).toBe(true) expect(isServiceEntity("SERVICE")).toBe(true);
}) });
it('checks if kind is ingress entity', () => { it("checks if kind is ingress entity", () => {
// throws on no kind // throws on no kind
expect(() => isIngressEntity(undefined)).toThrow( expect(() => isIngressEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isIngressEntity('ingress')).toBe(true) expect(isIngressEntity("ingress")).toBe(true);
expect(isIngressEntity('Ingress')).toBe(true) expect(isIngressEntity("Ingress")).toBe(true);
expect(isIngressEntity('ingresS')).toBe(true) expect(isIngressEntity("ingresS")).toBe(true);
expect(isIngressEntity('INGRESS')).toBe(true) expect(isIngressEntity("INGRESS")).toBe(true);
}) });
}) });
+45 -45
View File
@@ -1,81 +1,81 @@
export class KubernetesWorkload { export class KubernetesWorkload {
public static POD: string = 'Pod' public static POD: string = "Pod";
public static REPLICASET: string = 'Replicaset' public static REPLICASET: string = "Replicaset";
public static DEPLOYMENT: string = 'Deployment' public static DEPLOYMENT: string = "Deployment";
public static STATEFUL_SET: string = 'StatefulSet' public static STATEFUL_SET: string = "StatefulSet";
public static DAEMON_SET: string = 'DaemonSet' public static DAEMON_SET: string = "DaemonSet";
public static JOB: string = 'job' public static JOB: string = "job";
public static CRON_JOB: string = 'cronjob' public static CRON_JOB: string = "cronjob";
} }
export class DiscoveryAndLoadBalancerResource { export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = 'service' public static SERVICE: string = "service";
public static INGRESS: string = 'ingress' public static INGRESS: string = "ingress";
} }
export class ServiceTypes { export class ServiceTypes {
public static LOAD_BALANCER: string = 'LoadBalancer' public static LOAD_BALANCER: string = "LoadBalancer";
public static NODE_PORT: string = 'NodePort' public static NODE_PORT: string = "NodePort";
public static CLUSTER_IP: string = 'ClusterIP' public static CLUSTER_IP: string = "ClusterIP";
} }
export const DEPLOYMENT_TYPES: string[] = [ export const DEPLOYMENT_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
export const WORKLOAD_TYPES: string[] = [ export const WORKLOAD_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [ export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
'deployment', "deployment",
'daemonset', "daemonset",
'statefulset' "statefulset",
] ];
export function isDeploymentEntity(kind: string): boolean { export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return DEPLOYMENT_TYPES.some((type: string) => { return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase() return type.toLowerCase() === kind.toLowerCase();
}) });
} }
export function isWorkloadEntity(kind: string): boolean { export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return WORKLOAD_TYPES.some( return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase() (type: string) => type.toLowerCase() === kind.toLowerCase()
) );
} }
export function isServiceEntity(kind: string): boolean { export function isServiceEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'service' === kind.toLowerCase() return "service" === kind.toLowerCase();
} }
export function isIngressEntity(kind: string): boolean { export function isIngressEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'ingress' === kind.toLowerCase() return "ingress" === kind.toLowerCase();
} }
export const ResourceKindNotDefinedError = Error('Resource kind not defined') export const ResourceKindNotDefinedError = Error("Resource kind not defined");
export const NullInputObjectError = Error('Null inputObject') export const NullInputObjectError = Error("Null inputObject");
export const InputObjectKindNotDefinedError = Error( export const InputObjectKindNotDefinedError = Error(
'Input object kind not defined' "Input object kind not defined"
) );
export const InputObjectMetadataNotDefinedError = Error( export const InputObjectMetadataNotDefinedError = Error(
'Input object metatada not defined' "Input object metatada not defined"
) );
-135
View File
@@ -1,135 +0,0 @@
import {Kubectl} from './kubectl'
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
import * as core from '@actions/core'
import * as os from 'os'
import * as fs from 'fs'
import * as path from 'path'
export class PrivateKubectl extends Kubectl {
protected async execute(args: string[], silent: boolean = false) {
args.unshift('kubectl')
let kubectlCmd = args.join(' ')
let addFileFlag = false
let eo = <ExecOptions>{silent}
if (this.containsFilenames(kubectlCmd)) {
// For private clusters, files will referenced solely by their basename
kubectlCmd = this.replaceFilnamesWithBasenames(kubectlCmd)
addFileFlag = true
}
const privateClusterArgs = [
'aks',
'command',
'invoke',
'--resource-group',
this.resourceGroup,
'--name',
this.name,
'--command',
kubectlCmd
]
if (addFileFlag) {
const filenames = this.extractFilesnames(kubectlCmd).split(' ')
const tempDirectory =
process.env['runner.tempDirectory'] || os.tmpdir() + '/manifests'
eo.cwd = tempDirectory
privateClusterArgs.push(...['--file', '.'])
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
const file = filenamesArr[index]
if (!file) {
continue
}
this.moveFileToTempManifestDir(file)
}
}
core.debug(
`private cluster Kubectl run with invoke command: ${kubectlCmd}`
)
return await getExecOutput('az', privateClusterArgs, eo)
}
private replaceFilnamesWithBasenames(kubectlCmd: string) {
let exFilenames = this.extractFilesnames(kubectlCmd)
let filenames = exFilenames.split(' ')
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
filenamesArr[index] = path.basename(filenamesArr[index])
}
let baseFilenames = filenamesArr.join()
let result = kubectlCmd.replace(exFilenames, baseFilenames)
return result
}
public extractFilesnames(strToParse: string) {
let start = strToParse.indexOf('-filename')
let offset = 7
if (start == -1) {
start = strToParse.indexOf('-f')
if (start == -1) {
return ''
}
offset = 0
}
let temp = strToParse.substring(start + offset)
let end = temp.indexOf(' -')
//End could be case where the -f flag was last, or -f is followed by some additonal flag and it's arguments
return temp.substring(3, end == -1 ? temp.length : end).trim()
}
private containsFilenames(str: string) {
return str.includes('-f ') || str.includes('filename ')
}
private createTempManifestsDirectory() {
const manifestsDir = '/tmp/manifests'
if (!fs.existsSync('/tmp/manifests')) {
fs.mkdirSync('/tmp/manifests', {recursive: true})
}
}
private moveFileToTempManifestDir(file: string) {
this.createTempManifestsDirectory()
if (!fs.existsSync('/tmp/' + file)) {
core.debug(
'/tmp/' +
file +
' does not exist, and therefore cannot be moved to the manifest directory'
)
}
fs.copyFile('/tmp/' + file, '/tmp/manifests/' + file, function (err) {
if (err) {
core.debug(
'Could not rename ' +
'/tmp/' +
file +
' to ' +
'/tmp/manifests/' +
file +
' ERROR: ' +
err
)
return
}
core.debug(
"Successfully moved file '" +
file +
"' from /tmp to /tmp/manifest directory"
)
})
}
}
+18 -18
View File
@@ -1,22 +1,22 @@
import {parseRouteStrategy, RouteStrategy} from './routeStrategy' import { parseRouteStrategy, RouteStrategy } from "./routeStrategy";
describe('Route strategy type', () => { describe("Route strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(RouteStrategy) const vals = <any>Object.values(RouteStrategy);
expect(vals.includes('ingress')).toBe(true) expect(vals.includes("ingress")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
expect(vals.includes('service')).toBe(true) expect(vals.includes("service")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseRouteStrategy('ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('Ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("Ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('ingresS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingresS")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('INGRESS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("INGRESS")).toBe(RouteStrategy.INGRESS);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy('invalid')).toBe(undefined) expect(parseRouteStrategy("invalid")).toBe(undefined);
expect(parseRouteStrategy('unsupportedType')).toBe(undefined) expect(parseRouteStrategy("unsupportedType")).toBe(undefined);
}) });
}) });
+4 -4
View File
@@ -1,7 +1,7 @@
export enum RouteStrategy { export enum RouteStrategy {
INGRESS = 'ingress', INGRESS = "ingress",
SMI = 'smi', SMI = "smi",
SERVICE = 'service' SERVICE = "service",
} }
export const parseRouteStrategy = (str: string): RouteStrategy | undefined => export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
@@ -9,4 +9,4 @@ export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
Object.keys(RouteStrategy).filter( Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase() (k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy )[0] as keyof typeof RouteStrategy
] ];
+20 -17
View File
@@ -1,21 +1,24 @@
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod' import {
parseTrafficSplitMethod,
TrafficSplitMethod,
} from "./trafficSplitMethod";
describe('Traffic split method type', () => { describe("Traffic split method type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(TrafficSplitMethod) const vals = <any>Object.values(TrafficSplitMethod);
expect(vals.includes('pod')).toBe(true) expect(vals.includes("pod")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseTrafficSplitMethod('pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('Pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("Pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('poD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("poD")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('POD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("POD")).toBe(TrafficSplitMethod.POD);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod('invalid')).toBe(undefined) expect(parseTrafficSplitMethod("invalid")).toBe(undefined);
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined) expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined);
}) });
}) });
+3 -3
View File
@@ -1,6 +1,6 @@
export enum TrafficSplitMethod { export enum TrafficSplitMethod {
POD = 'pod', POD = "pod",
SMI = 'smi' SMI = "smi",
} }
/** /**
@@ -16,4 +16,4 @@ export const parseTrafficSplitMethod = (
(k) => (k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase() TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod )[0] as keyof typeof TrafficSplitMethod
] ];
+10 -10
View File
@@ -1,12 +1,12 @@
import {createInlineArray} from './arrayUtils' import { createInlineArray } from "./arrayUtils";
describe('array utilities', () => { describe("array utilities", () => {
it('creates an inline array', () => { it("creates an inline array", () => {
const strings = ['str1', 'str2', 'str3'] const strings = ["str1", "str2", "str3"];
expect(createInlineArray(strings)).toBe(strings.join(',')) expect(createInlineArray(strings)).toBe(strings.join(","));
const string = 'str1' const string = "str1";
expect(createInlineArray([string])).toBe(string) expect(createInlineArray([string])).toBe(string);
expect(createInlineArray(string)).toBe(string) expect(createInlineArray(string)).toBe(string);
}) });
}) });
+3 -3
View File
@@ -1,6 +1,6 @@
export function createInlineArray(str: string | string[]): string { export function createInlineArray(str: string | string[]): string {
if (typeof str === 'string') { if (typeof str === "string") {
return str return str;
} }
return str.join(',') return str.join(",");
} }
+11 -11
View File
@@ -1,15 +1,15 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {checkDockerPath} from './dockerUtils' import { checkDockerPath } from "./dockerUtils";
describe('docker utilities', () => { describe("docker utilities", () => {
it('checks if docker is installed', async () => { it("checks if docker is installed", async () => {
// docker installed // docker installed
const path = 'path' const path = "path";
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(() => checkDockerPath()).not.toThrow() expect(() => checkDockerPath()).not.toThrow();
// docker not installed // docker not installed
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => checkDockerPath()).rejects.toThrow() await expect(() => checkDockerPath()).rejects.toThrow();
}) });
}) });
+30 -30
View File
@@ -1,41 +1,41 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import * as core from '@actions/core' import * as core from "@actions/core";
import {DockerExec} from '../types/docker' import { DockerExec } from "../types/docker";
import {getNormalizedPath} from './githubUtils' import { getNormalizedPath } from "./githubUtils";
export async function getDeploymentConfig(): Promise<DeploymentConfig> { export async function getDeploymentConfig(): Promise<DeploymentConfig> {
let helmChartPaths: string[] = let helmChartPaths: string[] =
process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') || process.env?.HELM_CHART_PATHS?.split(";").filter((path) => path != "") ||
[] [];
helmChartPaths = helmChartPaths.map((helmchart) => helmChartPaths = helmChartPaths.map((helmchart) =>
getNormalizedPath(helmchart.trim()) getNormalizedPath(helmchart.trim())
) );
let inputManifestFiles: string[] = let inputManifestFiles: string[] =
core core
.getInput('manifests') .getInput("manifests")
.split(/[\n,;]+/) .split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || [] .filter((manifest) => manifest.trim().length > 0) || [];
if (helmChartPaths?.length == 0) { if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) => inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile) getNormalizedPath(manifestFile)
) );
} }
const imageNames = core.getInput('images').split('\n') || [] const imageNames = core.getInput("images").split("\n") || [];
const imageDockerfilePathMap: {[id: string]: string} = {} const imageDockerfilePathMap: { [id: string]: string } = {};
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false') const pullImages = !(core.getInput("pull-images").toLowerCase() === "false");
if (pullImages) { if (pullImages) {
//Fetching from image label if available //Fetching from image label if available
for (const image of imageNames) { for (const image of imageNames) {
try { try {
imageDockerfilePathMap[image] = await getDockerfilePath(image) imageDockerfilePathMap[image] = await getDockerfilePath(image);
} catch (ex) { } catch (ex) {
core.warning( core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} ` `Failed to get dockerfile path for image ${image.toString()}: ${ex} `
) );
} }
} }
} }
@@ -43,33 +43,33 @@ export async function getDeploymentConfig(): Promise<DeploymentConfig> {
return Promise.resolve(<DeploymentConfig>{ return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles, manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths, helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap dockerfilePaths: imageDockerfilePathMap,
}) });
} }
async function getDockerfilePath(image: any): Promise<string> { async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath() await checkDockerPath();
const dockerExec: DockerExec = new DockerExec('docker') const dockerExec: DockerExec = new DockerExec("docker");
await dockerExec.pull(image, [], false) await dockerExec.pull(image, [], false);
const imageInspectResult: string = await dockerExec.inspect(image, [], false) const imageInspectResult: string = await dockerExec.inspect(image, [], false);
const imageConfig = JSON.parse(imageInspectResult)[0] const imageConfig = JSON.parse(imageInspectResult)[0];
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path' const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path";
let pathValue: string = '' let pathValue: string = "";
if ( if (
imageConfig?.Config?.Labels && imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY] imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) { ) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY] const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY];
pathValue = getNormalizedPath(pathLabel) pathValue = getNormalizedPath(pathLabel);
} }
return Promise.resolve(pathValue) return Promise.resolve(pathValue);
} }
export async function checkDockerPath() { export async function checkDockerPath() {
const dockerPath = await io.which('docker', false) const dockerPath = await io.which("docker", false);
if (!dockerPath) { if (!dockerPath) {
throw new Error('Docker is not installed.') throw new Error("Docker is not installed.");
} }
} }
+29 -43
View File
@@ -1,62 +1,48 @@
import {getFilesFromDirectories} from './fileUtils' import {
getFilesFromDirectories
} from "./fileUtils";
import * as path from 'path' import * as path from "path";
describe('File utils', () => { describe("File utils", () => {
it('detects files in nested directories and ignores non-manifest files and empty dirs', () => { it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
const testPath = path.join('test', 'unit', 'manifests') const testPath = path.join("test", "unit", "manifests")
const testSearch: string[] = getFilesFromDirectories([testPath]) const testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = [ 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/another_layer/deep-ingress.yaml",
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml', "test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml",
'test/unit/manifests/test-ingress.yml', "test/unit/manifests/manifest_test_dir/nested-test-service.yaml",
'test/unit/manifests/test-ingress-new.yml', "test/unit/manifests/test-ingress.yml",
'test/unit/manifests/test-service.yml' "test/unit/manifests/test-service.yml"
] ]
// is there a more efficient way to test equality w random order? // is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(7) expect(testSearch).toHaveLength(5);
expectedManifests.forEach((fileName) => { expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(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(() => { it("crashes when an invalid file is provided", () => {
getFilesFromDirectories([badPath, goodPath]) const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml")
}).toThrowError() const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir")
})
expect(() => {getFilesFromDirectories([badPath, goodPath])}).toThrowError()
});
it("doesn't duplicate files when nested dir included", () => { it("doesn't duplicate files when nested dir included", () => {
const outerPath = path.join('test', 'unit', 'manifests') const outerPath = path.join("test", "unit", "manifests")
const fileAtOuter = path.join( const fileAtOuter = path.join("test", "unit", "manifests", "test-service.yml")
'test', const innerPath = path.join("test", "unit", "manifests", "manifest_test_dir")
'unit',
'manifests',
'test-service.yml'
)
const innerPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect( expect(getFilesFromDirectories([outerPath, fileAtOuter, innerPath])).toHaveLength(5)
getFilesFromDirectories([outerPath, fileAtOuter, innerPath])
).toHaveLength(7)
})
}) })
});
// files that don't exist / nested files that don't exist / something else with non-manifest // 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 // 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 fs from "fs";
import * as path from 'path' import * as path from "path";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as os from 'os' import * as os from "os";
import {getCurrentTime} from './timeUtils' import { getCurrentTime } from "./timeUtils";
export function getTempDirectory(): string { export function getTempDirectory(): string {
return process.env['runner.tempDirectory'] || os.tmpdir() return process.env["runner.tempDirectory"] || os.tmpdir();
} }
export function writeObjectsToFile(inputObjects: any[]): string[] { export function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = [] const newFilePaths = [];
inputObjects.forEach((inputObject: any) => { inputObjects.forEach((inputObject: any) => {
try { try {
const inputObjectString = JSON.stringify(inputObject) const inputObjectString = JSON.stringify(inputObject);
if (inputObject?.metadata?.name) { if (inputObject?.metadata?.name) {
const fileName = getManifestFileName( const fileName = getManifestFileName(
inputObject.kind, inputObject.kind,
inputObject.metadata.name inputObject.metadata.name
) );
fs.writeFileSync(path.join(fileName), inputObjectString) fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName) newFilePaths.push(fileName);
} else { } else {
core.debug( core.debug(
'Input object is not proper K8s resource object. Object: ' + "Input object is not proper K8s resource object. Object: " +
inputObjectString inputObjectString
) );
} }
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}` `Exception occurred while writing object to file ${inputObject}: ${ex}`
) );
} }
}) });
return newFilePaths return newFilePaths;
} }
export function writeManifestToFile( export function writeManifestToFile(
@@ -45,48 +45,44 @@ export function writeManifestToFile(
): string { ): string {
if (inputObjectString) { if (inputObjectString) {
try { try {
const fileName = getManifestFileName(kind, name) const fileName = getManifestFileName(kind, name);
fs.writeFileSync(path.join(fileName), inputObjectString) fs.writeFileSync(path.join(fileName), inputObjectString);
return fileName return fileName;
} catch (ex) { } catch (ex) {
throw Error( throw Error(
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}` `Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
) );
} }
} }
} }
function getManifestFileName(kind: string, name: string) { function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_${getCurrentTime().toString()}` const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`;
const tempDirectory = getTempDirectory() const tempDirectory = getTempDirectory();
return path.join(tempDirectory, path.basename(filePath)) 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>() const fullPathSet: Set<string> = new Set<string>()
filePaths.forEach((fileName) => { filePaths.forEach((fileName => {
try { try {
if(fs.lstatSync(fileName).isDirectory()){ if(fs.lstatSync(fileName).isDirectory()){
recurisveManifestGetter(fileName).forEach((file) => { recurisveManifestGetter(fileName).forEach((file) => {fullPathSet.add(file)})
fullPathSet.add(file) } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
})
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
fullPathSet.add(fileName) fullPathSet.add(fileName)
} else{ } else{
core.debug( core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
`Detected non-manifest file, ${fileName}, continuing... `
)
} }
} catch (ex) { } catch (ex) {
throw Error( throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}` `Exception occurred while reading the file ${fileName}: ${ex}`
) );
} }
}) }))
return Array.from(fullPathSet) return Array.from(fullPathSet)
} }
@@ -98,10 +94,7 @@ function recurisveManifestGetter(dirName: string): string[] {
const fnwd: string = path.join(dirName, fileName) const fnwd: string = path.join(dirName, fileName)
if(fs.lstatSync(fnwd).isDirectory()){ if(fs.lstatSync(fnwd).isDirectory()){
toRet.push(...recurisveManifestGetter(fnwd)) toRet.push(...recurisveManifestGetter(fnwd))
} else if ( } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
toRet.push(path.join(dirName, fileName)) toRet.push(path.join(dirName, fileName))
} else{ } else{
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` ) core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
@@ -112,5 +105,5 @@ function recurisveManifestGetter(dirName: string): string[] {
} }
function getFileExtension(fileName: 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 { import {
getNormalizedPath, getNormalizedPath,
isHttpUrl, isHttpUrl,
normalizeWorkflowStrLabel normalizeWorkflowStrLabel,
} from './githubUtils' } from "./githubUtils";
describe('Github utils', () => { describe("Github utils", () => {
it('normalizes workflow string labels', () => { it("normalizes workflow string labels", () => {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
const path = 'test/path/test' const path = "test/path/test";
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path) expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path);
expect(normalizeWorkflowStrLabel(path)).toBe(path) expect(normalizeWorkflowStrLabel(path)).toBe(path);
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe( expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath path + workflowsPath
) );
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe( expect(normalizeWorkflowStrLabel(path + " " + path)).toBe(
path + '_' + path path + "_" + path
) );
}) });
it('normalizes path', () => { it("normalizes path", () => {
const httpUrl = 'http://www.test.com' const httpUrl = "http://www.test.com";
expect(getNormalizedPath(httpUrl)).toBe(httpUrl) expect(getNormalizedPath(httpUrl)).toBe(httpUrl);
const httpsUrl = 'https://www.test.com' const httpsUrl = "https://www.test.com";
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl) expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl);
const repo = 'gh_repo' const repo = "gh_repo";
const sha = 'gh_sha' const sha = "gh_sha";
const path = 'path' const path = "path";
process.env.GITHUB_REPOSITORY = repo process.env.GITHUB_REPOSITORY = repo;
process.env.GITHUB_SHA = sha process.env.GITHUB_SHA = sha;
expect(getNormalizedPath(path)).toBe( expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}` `https://github.com/${repo}/blob/${sha}/${path}`
) );
}) });
it('checks if url is http', () => { it("checks if url is http", () => {
expect(isHttpUrl('www.test.com')).toBe(false) expect(isHttpUrl("www.test.com")).toBe(false);
expect(isHttpUrl('http.test.com')).toBe(false) expect(isHttpUrl("http.test.com")).toBe(false);
expect(isHttpUrl('http:.test.com')).toBe(false) expect(isHttpUrl("http:.test.com")).toBe(false);
expect(isHttpUrl('http:/.test.com')).toBe(false) expect(isHttpUrl("http:/.test.com")).toBe(false);
expect(isHttpUrl('https://www.test.com')).toBe(true) expect(isHttpUrl("https://www.test.com")).toBe(true);
expect(isHttpUrl('http://wwww.test.com')).toBe(true) expect(isHttpUrl("http://wwww.test.com")).toBe(true);
}) });
}) });
+18 -18
View File
@@ -1,54 +1,54 @@
import {GitHubClient, OkStatusCode} from '../types/githubClient' import { GitHubClient, OkStatusCode } from "../types/githubClient";
import * as core from '@actions/core' import * as core from "@actions/core";
export async function getWorkflowFilePath( export async function getWorkflowFilePath(
githubToken: string githubToken: string
): Promise<string> { ): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW let workflowFilePath = process.env.GITHUB_WORKFLOW;
if (!workflowFilePath.startsWith('.github/workflows/')) { if (!workflowFilePath.startsWith(".github/workflows/")) {
const githubClient = new GitHubClient( const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY, process.env.GITHUB_REPOSITORY,
githubToken githubToken
) );
const response = await githubClient.getWorkflows() const response = await githubClient.getWorkflows();
if (response) { if (response) {
if (response.status === OkStatusCode && response.data.total_count) { if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) { if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) { for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) { if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path workflowFilePath = workflow.path;
break break;
} }
} }
} }
} else if (response.status != OkStatusCode) { } else if (response.status != OkStatusCode) {
core.error( core.error(
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}` `An error occurred while getting list of workflows on the repo. Status code: ${response.status}`
) );
} }
} else { } 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 { export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
workflowName = workflowName.startsWith(workflowsPath) workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, '') ? workflowName.replace(workflowsPath, "")
: workflowName : workflowName;
return workflowName.replace(/ /g, '_') return workflowName.replace(/ /g, "_");
} }
export function getNormalizedPath(pathValue: string) { export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) { if (!isHttpUrl(pathValue)) {
//if it is not an http url then convert to link from current repo and commit //if it is not an http url then convert to link from current repo and commit
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}` return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`;
} }
return pathValue return pathValue;
} }
export function isHttpUrl(url: string) { export function isHttpUrl(url: string) {
return /^https?:\/\/.*$/.test(url) return /^https?:\/\/.*$/.test(url);
} }
+41 -41
View File
@@ -1,61 +1,61 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
describe('Kubectl utils', () => { describe("Kubectl utils", () => {
it('checks for errors', () => { it("checks for errors", () => {
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0} const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 };
const successWithStderr: ExecOutput = { const successWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 0 exitCode: 0,
} };
const failWithExitCode: ExecOutput = { const failWithExitCode: ExecOutput = {
stderr: '', stderr: "",
stdout: '', stdout: "",
exitCode: 1 exitCode: 1,
} };
const failWithExitWithStderr: ExecOutput = { const failWithExitWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 2 exitCode: 2,
} };
// with throw behavior // with throw behavior
expect(() => checkForErrors([success])).not.toThrow() expect(() => checkForErrors([success])).not.toThrow();
expect(() => checkForErrors([successWithStderr])).not.toThrow() expect(() => checkForErrors([successWithStderr])).not.toThrow();
expect(() => checkForErrors([success, successWithStderr])).not.toThrow() expect(() => checkForErrors([success, successWithStderr])).not.toThrow();
expect(() => checkForErrors([failWithExitCode])).toThrow() expect(() => checkForErrors([failWithExitCode])).toThrow();
expect(() => checkForErrors([failWithExitWithStderr])).toThrow() expect(() => checkForErrors([failWithExitWithStderr])).toThrow();
expect(() => checkForErrors([success, failWithExitCode])).toThrow() expect(() => checkForErrors([success, failWithExitCode])).toThrow();
expect(() => expect(() =>
checkForErrors([successWithStderr, failWithExitCode]) checkForErrors([successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode]) checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr]) checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow() ).toThrow();
// with warn behavior // with warn behavior
jest.spyOn(core, 'warning').mockImplementation(() => {}) jest.spyOn(core, "warning").mockImplementation(() => {});
let warningCalls = 0 let warningCalls = 0;
expect(() => checkForErrors([success], true)).not.toThrow() expect(() => checkForErrors([success], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(warningCalls) expect(core.warning).toBeCalledTimes(warningCalls);
expect(() => checkForErrors([successWithStderr], true)).not.toThrow() expect(() => checkForErrors([successWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => expect(() =>
checkForErrors([success, successWithStderr], true) checkForErrors([success, successWithStderr], true)
).not.toThrow() ).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow() expect(() => checkForErrors([failWithExitCode], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow() expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
}) });
}) });
+27 -31
View File
@@ -1,25 +1,25 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
export function checkForErrors( export function checkForErrors(
execResults: ExecOutput[], execResults: ExecOutput[],
warnIfError?: boolean warnIfError?: boolean
) { ) {
let stderr = '' let stderr = "";
execResults.forEach((result) => { execResults.forEach((result) => {
if (result?.exitCode !== 0) { if (result?.exitCode !== 0) {
stderr += result?.stderr + ' \n' stderr += result?.stderr + " \n";
} else if (result?.stderr) { } else if (result?.stderr) {
core.warning(result.stderr) core.warning(result.stderr);
} }
}) });
if (stderr.length > 0) { if (stderr.length > 0) {
if (warnIfError) { if (warnIfError) {
core.warning(stderr.trim()) core.warning(stderr.trim());
} else { } else {
throw new Error(stderr.trim()) throw new Error(stderr.trim());
} }
} }
} }
@@ -30,22 +30,22 @@ export async function getLastSuccessfulRunSha(
annotationKey: string annotationKey: string
): Promise<string> { ): Promise<string> {
try { try {
const result = await kubectl.getResource('namespace', namespaceName) const result = await kubectl.getResource("namespace", namespaceName);
if (result?.stderr) { if (result?.stderr) {
core.warning(result.stderr) core.warning(result.stderr);
return process.env.GITHUB_SHA return process.env.GITHUB_SHA;
} else if (result?.stdout) { } else if (result?.stdout) {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations const annotationsSet = JSON.parse(result.stdout).metadata.annotations;
if (annotationsSet && annotationsSet[annotationKey]) { if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"')) return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit .commit;
} else { } else {
return 'NA' return "NA";
} }
} }
} catch (ex) { } catch (ex) {
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`) core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`);
return '' return "";
} }
} }
@@ -56,31 +56,27 @@ export async function annotateChildPods(
annotationKeyValStr: string, annotationKeyValStr: string,
allPods allPods
): Promise<ExecOutput[]> { ): Promise<ExecOutput[]> {
let owner = resourceName let owner = resourceName;
if (resourceType.toLowerCase().indexOf('deployment') > -1) { if (resourceType.toLowerCase().indexOf("deployment") > -1) {
owner = await kubectl.getNewReplicaSet(resourceName) owner = await kubectl.getNewReplicaSet(resourceName);
} }
const commandExecutionResults = [] const commandExecutionResults = [];
if (allPods?.items && allPods.items?.length > 0) { if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => { allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences const owners = pod?.metadata?.ownerReferences;
if (owners) { if (owners) {
for (const ownerRef of owners) { for (const ownerRef of owners) {
if (ownerRef.name === owner) { if (ownerRef.name === owner) {
commandExecutionResults.push( commandExecutionResults.push(
kubectl.annotate( kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr)
'pod', );
pod.metadata.name, break;
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) { export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null if (!inputObject?.spec) return null;
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase()
) )
return inputObject?.spec?.jobTemplate?.spec?.template?.spec return inputObject?.spec?.jobTemplate?.spec?.template?.spec
?.imagePullSecrets ?.imagePullSecrets;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets return inputObject.spec.imagePullSecrets;
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets return inputObject.spec.template.spec.imagePullSecrets;
} }
} }
@@ -22,27 +21,24 @@ export function setImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: any newImagePullSecrets: any
) { ) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return if (!inputObject || !inputObject.spec || !newImagePullSecrets) return;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.spec.imagePullSecrets = newImagePullSecrets;
) { return;
inputObject.spec.imagePullSecrets = newImagePullSecrets
return
} }
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase()
) { ) {
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec) if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
newImagePullSecrets newImagePullSecrets;
return return;
} }
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
return return;
} }
} }
+24 -26
View File
@@ -2,72 +2,70 @@ import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
export function updateSpecLabels( export function updateSpecLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) throw InputObjectKindNotDefinedError if (!inputObject.kind) throw InputObjectKindNotDefinedError;
if (!newLabels) return if (!newLabels) return;
let existingLabels = getSpecLabels(inputObject) let existingLabels = getSpecLabels(inputObject);
if (override) { if (override) {
existingLabels = newLabels existingLabels = newLabels;
} else { } else {
existingLabels = existingLabels || new Map<string, string>() existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
} }
setSpecLabels(inputObject, existingLabels) setSpecLabels(inputObject, existingLabels);
} }
function getSpecLabels(inputObject: any) { function getSpecLabels(inputObject: any) {
if (!inputObject) return null if (!inputObject) return null;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels return inputObject.metadata.labels;
if (inputObject?.spec?.template?.metadata) if (inputObject?.spec?.template?.metadata)
return inputObject.spec.template.metadata.labels return inputObject.spec.template.metadata.labels;
return null return null;
} }
function setSpecLabels(inputObject: any, newLabels: any) { function setSpecLabels(inputObject: any, newLabels: any) {
if (!inputObject || !newLabels) return null if (!inputObject || !newLabels) return null;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.metadata.labels = newLabels;
) { return;
inputObject.metadata.labels = newLabels
return
} }
if (inputObject?.spec?.template?.metatada) { if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels inputObject.spec.template.metatada.labels = newLabels;
return return;
} }
} }
export function getSpecSelectorLabels(inputObject: any) { export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector;
else return inputObject.spec.selector.matchLabels else return inputObject.spec.selector.matchLabels;
} }
} }
export function setSpecSelectorLabels(inputObject: any, newLabels: any) { export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels inputObject.spec.selector = newLabels;
else inputObject.spec.selector.matchLabels = newLabels else inputObject.spec.selector.matchLabels = newLabels;
} }
} }
+69 -74
View File
@@ -1,16 +1,16 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
import {sleep} from './timeUtils' import { sleep } from "./timeUtils";
export async function checkManifestStability( export async function checkManifestStability(
kubectl: Kubectl, kubectl: Kubectl,
resources: Resource[] resources: Resource[]
): Promise<void> { ): Promise<void> {
let rolloutStatusHasErrors = false let rolloutStatusHasErrors = false;
for (let i = 0; i < resources.length; i++) { for (let i = 0; i < resources.length; i++) {
const resource = resources[i] const resource = resources[i];
if ( if (
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf( KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
@@ -21,23 +21,21 @@ export async function checkManifestStability(
const result = await kubectl.checkRolloutStatus( const result = await kubectl.checkRolloutStatus(
resource.type, resource.type,
resource.name resource.name
) );
checkForErrors([result]) checkForErrors([result]);
} catch (ex) { } catch (ex) {
core.error(ex) core.error(ex);
await kubectl.describe(resource.type, resource.name) await kubectl.describe(resource.type, resource.name);
rolloutStatusHasErrors = true rolloutStatusHasErrors = true;
} }
} }
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) { if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
try { try {
await checkPodStatus(kubectl, resource.name) await checkPodStatus(kubectl, resource.name);
} catch (ex) { } catch (ex) {
core.warning( core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`);
`Could not determine pod status: ${JSON.stringify(ex)}` await kubectl.describe(resource.type, resource.name);
)
await kubectl.describe(resource.type, resource.name)
} }
} }
if ( if (
@@ -45,31 +43,28 @@ export async function checkManifestStability(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
) { ) {
try { try {
const service = await getService(kubectl, resource.name) const service = await getService(kubectl, resource.name);
const {spec, status} = service const { spec, status } = service;
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) { if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
if (!isLoadBalancerIPAssigned(status)) { if (!isLoadBalancerIPAssigned(status)) {
await waitForServiceExternalIPAssignment( await waitForServiceExternalIPAssignment(kubectl, resource.name);
kubectl,
resource.name
)
} else { } else {
core.info( core.info(
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}` `ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
) );
} }
} }
} catch (ex) { } catch (ex) {
core.warning( core.warning(
`Could not determine service status of: ${resource.name} Error: ${ex}` `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) { if (rolloutStatusHasErrors) {
throw new Error('Rollout status error') throw new Error("Rollout status error");
} }
} }
@@ -77,113 +72,113 @@ export async function checkPodStatus(
kubectl: Kubectl, kubectl: Kubectl,
podName: string podName: string
): Promise<void> { ): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout
let podStatus let podStatus;
let kubectlDescribeNeeded = false let kubectlDescribeNeeded = false;
for (let i = 0; i < iterations; i++) { for (let i = 0; i < iterations; i++) {
await sleep(sleepTimeout) await sleep(sleepTimeout);
core.debug(`Polling for pod status: ${podName}`) core.debug(`Polling for pod status: ${podName}`);
podStatus = await getPodStatus(kubectl, podName) podStatus = await getPodStatus(kubectl, podName);
if ( if (
podStatus && podStatus &&
podStatus?.phase !== 'Pending' && podStatus?.phase !== "Pending" &&
podStatus?.phase !== 'Unknown' podStatus?.phase !== "Unknown"
) { ) {
break break;
} }
} }
podStatus = await getPodStatus(kubectl, podName) podStatus = await getPodStatus(kubectl, podName);
switch (podStatus.phase) { switch (podStatus.phase) {
case 'Succeeded': case "Succeeded":
case 'Running': case "Running":
if (isPodReady(podStatus)) { if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`) console.log(`pod/${podName} is successfully rolled out`);
} else { } else {
kubectlDescribeNeeded = true kubectlDescribeNeeded = true;
} }
break break;
case 'Pending': case "Pending":
if (!isPodReady(podStatus)) { if (!isPodReady(podStatus)) {
core.warning(`pod/${podName} rollout status check timed out`) core.warning(`pod/${podName} rollout status check timed out`);
kubectlDescribeNeeded = true kubectlDescribeNeeded = true;
} }
break break;
case 'Failed': case "Failed":
core.error(`pod/${podName} rollout failed`) core.error(`pod/${podName} rollout failed`);
kubectlDescribeNeeded = true kubectlDescribeNeeded = true;
break break;
default: default:
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`) core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
} }
if (kubectlDescribeNeeded) { if (kubectlDescribeNeeded) {
await kubectl.describe('pod', podName) await kubectl.describe("pod", podName);
} }
} }
async function getPodStatus(kubectl: Kubectl, podName: string) { async function getPodStatus(kubectl: Kubectl, podName: string) {
const podResult = await kubectl.getResource('pod', podName) const podResult = await kubectl.getResource("pod", podName);
checkForErrors([podResult]) checkForErrors([podResult]);
return JSON.parse(podResult.stdout).status return JSON.parse(podResult.stdout).status;
} }
function isPodReady(podStatus: any): boolean { function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true let allContainersAreReady = true;
podStatus.containerStatuses.forEach((container) => { podStatus.containerStatuses.forEach((container) => {
if (container.ready === false) { if (container.ready === false) {
core.info( core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}` `'${container.name}' status: ${JSON.stringify(container.state)}`
) );
allContainersAreReady = false allContainersAreReady = false;
} }
}) });
if (!allContainersAreReady) { 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) { async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource( const serviceResult = await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE, KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
serviceName serviceName
) );
checkForErrors([serviceResult]) checkForErrors([serviceResult]);
return JSON.parse(serviceResult.stdout) return JSON.parse(serviceResult.stdout);
} }
async function waitForServiceExternalIPAssignment( async function waitForServiceExternalIPAssignment(
kubectl: Kubectl, kubectl: Kubectl,
serviceName: string serviceName: string
): Promise<void> { ): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout
for (let i = 0; i < iterations; i++) { for (let i = 0; i < iterations; i++) {
core.info(`Wait for service ip assignment : ${serviceName}`) core.info(`Wait for service ip assignment : ${serviceName}`);
await sleep(sleepTimeout) await sleep(sleepTimeout);
const status = (await getService(kubectl, serviceName)).status const status = (await getService(kubectl, serviceName)).status;
if (isLoadBalancerIPAssigned(status)) { if (isLoadBalancerIPAssigned(status)) {
core.info( core.info(
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}` `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) { 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 core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as path from 'path' import * as path from "path";
import * as fileHelper from './fileUtils' import * as fileHelper from "./fileUtils";
import {getTempDirectory} from './fileUtils' import { getTempDirectory } from "./fileUtils";
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError, InputObjectMetadataNotDefinedError,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
import { import {
getSpecSelectorLabels, getSpecSelectorLabels,
setSpecSelectorLabels setSpecSelectorLabels,
} from './manifestSpecLabelUtils' } from "./manifestSpecLabelUtils";
import { import {
getImagePullSecrets, getImagePullSecrets,
setImagePullSecrets setImagePullSecrets,
} from './manifestPullSecretUtils' } from "./manifestPullSecretUtils";
import {Resource} from '../types/kubectl' import { Resource } from "../types/kubectl";
export function updateManifestFiles(manifestFilePaths: string[]) { export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) { if (manifestFilePaths?.length === 0) {
throw new Error('Manifest files not provided') throw new Error("Manifest files not provided");
} }
// update container images // update container images
const containers: string[] = core.getInput('images').split('\n') const containers: string[] = core.getInput("images").split("\n");
const manifestFiles = updateContainerImagesInManifestFiles( const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths, manifestFilePaths,
containers containers
) );
// update pull secrets // update pull secrets
const imagePullSecrets: string[] = core const imagePullSecrets: string[] = core
.getInput('imagepullsecrets') .getInput("imagepullsecrets")
.split('\n') .split("\n")
.filter((secret) => secret.trim().length > 0) .filter((secret) => secret.trim().length > 0);
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets) return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets);
} }
export function UnsetClusterSpecificDetails(resource: any) { export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) { if (!resource) {
return return;
} }
// Unset cluster specific details in the object // Unset cluster specific details in the object
if (!!resource) { if (!!resource) {
const {metadata, status} = resource const { metadata, status } = resource;
if (!!metadata) { if (!!metadata) {
resource.metadata = { resource.metadata = {
annotations: metadata.annotations, annotations: metadata.annotations,
labels: metadata.labels, labels: metadata.labels,
name: metadata.name name: metadata.name,
} };
} }
if (!!status) { if (!!status) {
resource.status = {} resource.status = {};
} }
} }
} }
@@ -68,18 +68,18 @@ function updateContainerImagesInManifestFiles(
filePaths: string[], filePaths: string[],
containers: string[] containers: string[]
): string[] { ): string[] {
if (filePaths?.length <= 0) return filePaths if (filePaths?.length <= 0) return filePaths;
const newFilePaths = [] const newFilePaths = [];
// update container images // update container images
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString() let contents = fs.readFileSync(filePath).toString();
containers.forEach((container: string) => { containers.forEach((container: string) => {
let [imageName] = container.split(':') let [imageName] = container.split(":");
if (imageName.indexOf('@') > 0) { if (imageName.indexOf("@") > 0) {
imageName = imageName.split('@')[0] imageName = imageName.split("@")[0];
} }
if (contents.indexOf(imageName) > 0) if (contents.indexOf(imageName) > 0)
@@ -87,17 +87,17 @@ function updateContainerImagesInManifestFiles(
contents, contents,
imageName, imageName,
container container
) );
}) });
// write updated files // write updated files
const tempDirectory = getTempDirectory() const tempDirectory = getTempDirectory();
const fileName = path.join(tempDirectory, path.basename(filePath)) const fileName = path.join(tempDirectory, path.basename(filePath));
fs.writeFileSync(path.join(fileName), contents) fs.writeFileSync(path.join(fileName), contents);
newFilePaths.push(fileName) newFilePaths.push(fileName);
}) });
return newFilePaths return newFilePaths;
} }
/* /*
@@ -116,45 +116,45 @@ export function substituteImageNameInSpecFile(
imageName: string, imageName: string,
imageNameWithNewTag: string imageNameWithNewTag: string
) { ) {
if (spec.indexOf(imageName) < 0) return spec if (spec.indexOf(imageName) < 0) return spec;
return spec.split('\n').reduce((acc, line) => { return spec.split("\n").reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/) const imageKeyword = line.match(/^ *-? *image:/);
if (imageKeyword) { if (imageKeyword) {
let [currentImageName] = line let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards .substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim() .trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing .replace(/[',"]/g, "") // replace allowed quotes with nothing
.split(':') .split(":");
if (currentImageName?.indexOf(' ') > 0) { if (currentImageName?.indexOf(" ") > 0) {
currentImageName = currentImageName.split(' ')[0] // remove comments currentImageName = currentImageName.split(" ")[0]; // remove comments
} }
if (currentImageName === imageName) { 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 { export function getReplicaCount(inputObject: any): any {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) { if (!inputObject.kind) {
throw InputObjectKindNotDefinedError throw InputObjectKindNotDefinedError;
} }
const {kind} = inputObject const { kind } = inputObject;
if ( if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
) )
return inputObject.spec.replicas return inputObject.spec.replicas;
return 0 return 0;
} }
export function updateObjectLabels( export function updateObjectLabels(
@@ -162,23 +162,23 @@ export function updateObjectLabels(
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean = false 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) { if (override) {
inputObject.metadata.labels = newLabels inputObject.metadata.labels = newLabels;
} else { } else {
let existingLabels = let existingLabels =
inputObject.metadata.labels || new Map<string, string>() inputObject.metadata.labels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
inputObject.metadata.labels = existingLabels inputObject.metadata.labels = existingLabels;
} }
} }
@@ -187,23 +187,23 @@ export function updateObjectAnnotations(
newAnnotations: Map<string, string>, newAnnotations: Map<string, string>,
override: boolean = false 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) { if (override) {
inputObject.metadata.annotations = newAnnotations inputObject.metadata.annotations = newAnnotations;
} else { } else {
const existingAnnotations = const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>() inputObject.metadata.annotations || new Map<string, string>();
Object.keys(newAnnotations).forEach( Object.keys(newAnnotations).forEach(
(key) => (existingAnnotations[key] = newAnnotations[key]) (key) => (existingAnnotations[key] = newAnnotations[key])
) );
inputObject.metadata.annotations = existingAnnotations inputObject.metadata.annotations = existingAnnotations;
} }
} }
@@ -212,27 +212,24 @@ export function updateImagePullSecrets(
newImagePullSecrets: string[], newImagePullSecrets: string[],
override: boolean = false override: boolean = false
) { ) {
if (!inputObject?.spec || !newImagePullSecrets) return if (!inputObject?.spec || !newImagePullSecrets) return;
const newImagePullSecretsObjects = Array.from( const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => {
newImagePullSecrets, return { name };
(name) => { });
return {name} let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
}
)
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
if (override) { if (override) {
existingImagePullSecretObjects = newImagePullSecretsObjects existingImagePullSecretObjects = newImagePullSecretsObjects;
} else { } else {
existingImagePullSecretObjects = existingImagePullSecretObjects || [] existingImagePullSecretObjects = existingImagePullSecretObjects || [];
existingImagePullSecretObjects = existingImagePullSecretObjects.concat( existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
newImagePullSecretsObjects newImagePullSecretsObjects
) );
} }
setImagePullSecrets(inputObject, existingImagePullSecretObjects) setImagePullSecrets(inputObject, existingImagePullSecretObjects);
} }
export function updateSelectorLabels( export function updateSelectorLabels(
@@ -240,39 +237,39 @@ export function updateSelectorLabels(
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) throw InputObjectKindNotDefinedError if (!inputObject.kind) throw InputObjectKindNotDefinedError;
if (!newLabels) return if (!newLabels) return;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return return;
let existingLabels = getSpecSelectorLabels(inputObject) let existingLabels = getSpecSelectorLabels(inputObject);
if (override) { if (override) {
existingLabels = newLabels existingLabels = newLabels;
} else { } else {
existingLabels = existingLabels || new Map<string, string>() existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
} }
setSpecSelectorLabels(inputObject, existingLabels) setSpecSelectorLabels(inputObject, existingLabels);
} }
export function getResources( export function getResources(
filePaths: string[], filePaths: string[],
filterResourceTypes: string[] filterResourceTypes: string[]
): Resource[] { ): Resource[] {
if (!filePaths) return [] if (!filePaths) return [];
const resources: Resource[] = [] const resources: Resource[] = [];
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString() const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
const inputObjectKind = inputObject?.kind || '' const inputObjectKind = inputObject?.kind || "";
if ( if (
filterResourceTypes.filter( filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase() (type) => inputObjectKind.toLowerCase() === type.toLowerCase()
@@ -280,34 +277,34 @@ export function getResources(
) { ) {
resources.push({ resources.push({
type: inputObject.kind, type: inputObject.kind,
name: inputObject.metadata.name name: inputObject.metadata.name,
}) });
} }
}) });
}) });
return resources return resources;
} }
function updateImagePullSecretsInManifestFiles( function updateImagePullSecretsInManifestFiles(
filePaths: string[], filePaths: string[],
imagePullSecrets: string[] imagePullSecrets: string[]
): string[] { ): string[] {
if (imagePullSecrets?.length <= 0) return filePaths if (imagePullSecrets?.length <= 0) return filePaths;
const newObjectsList = [] const newObjectsList = [];
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString() const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject: any) => { yaml.safeLoadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) { if (inputObject?.kind) {
const {kind} = inputObject const { kind } = inputObject;
if (isWorkloadEntity(kind)) { 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) { export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout)) return new Promise((resolve) => setTimeout(resolve, timeout));
} }
export function getCurrentTime(): number { export function getCurrentTime(): number {
return new Date().getTime() return new Date().getTime();
} }
+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( export async function getTrafficSplitAPIVersion(
kubectl: Kubectl kubectl: Kubectl
): Promise<string> { ): Promise<string> {
const result = await kubectl.executeCommand('api-versions') const result = await kubectl.executeCommand("api-versions");
const trafficSplitAPIVersion = result.stdout const trafficSplitAPIVersion = result.stdout
.split('\n') .split("\n")
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix)) .find((version) => version.startsWith(trafficSplitAPIVersionPrefix));
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
throw new Error('Unable to find traffic split api version') throw new Error("Unable to find traffic split api version");
} }
return trafficSplitAPIVersion return trafficSplitAPIVersion;
} }
+17 -19
View File
@@ -1,20 +1,18 @@
import {cleanLabel} from '../utilities/workflowAnnotationUtils' import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils";
describe('WorkflowAnnotationUtils', () => { describe("WorkflowAnnotationUtils", () => {
describe('cleanLabel', () => { describe("prefixObjectKeys", () => {
it('should clean label', () => { it("should prefix an object with a given prefix", () => {
const alreadyClean = 'alreadyClean' const obj = {
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean) foo: "bar",
expect(cleanLabel('.startInvalid')).toEqual('startInvalid') baz: "qux",
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual( };
'withS0MEinvalidchars' const prefix = "prefix.";
) const expected = {
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji') "prefix.foo": "bar",
}) "prefix.baz": "qux",
it('should remove slashes from label', () => { };
expect( expect(prefixObjectKeys(obj, prefix)).toEqual(expected);
cleanLabel('Workflow Name / With Slashes / And Spaces') });
).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces') });
}) });
})
})
+22 -23
View File
@@ -1,6 +1,13 @@
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;
}, {});
}
export function getWorkflowAnnotations( export function getWorkflowAnnotations(
lastSuccessRunSha: string, lastSuccessRunSha: string,
@@ -11,7 +18,7 @@ export function getWorkflowAnnotations(
run: process.env.GITHUB_RUN_ID, run: process.env.GITHUB_RUN_ID,
repository: process.env.GITHUB_REPOSITORY, repository: process.env.GITHUB_REPOSITORY,
workflow: process.env.GITHUB_WORKFLOW, workflow: process.env.GITHUB_WORKFLOW,
workflowFileName: workflowFilePath.replace('.github/workflows/', ''), workflowFileName: workflowFilePath.replace(".github/workflows/", ""),
jobName: process.env.GITHUB_JOB, jobName: process.env.GITHUB_JOB,
createdBy: process.env.GITHUB_ACTOR, createdBy: process.env.GITHUB_ACTOR,
runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`, runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`,
@@ -22,26 +29,18 @@ export function getWorkflowAnnotations(
dockerfilePaths: deploymentConfig.dockerfilePaths, dockerfilePaths: deploymentConfig.dockerfilePaths,
manifestsPaths: deploymentConfig.manifestFilePaths, manifestsPaths: deploymentConfig.manifestFilePaths,
helmChartPaths: deploymentConfig.helmChartFilePaths, helmChartPaths: deploymentConfig.helmChartFilePaths,
provider: 'GitHub' provider: "GitHub",
} };
return JSON.stringify(annotationObject) const prefixedAnnotationObject = prefixObjectKeys(annotationObject, ANNOTATION_PREFIX);
return JSON.stringify(prefixedAnnotationObject);
} }
export function getWorkflowAnnotationKeyLabel(): string { export function getWorkflowAnnotationKeyLabel(
return `${ANNOTATION_PREFIX}/k8s-deploy` workflowFilePath: string
} ): string {
const hashKey = require("crypto")
/** .createHash("MD5")
* Cleans label to match valid kubernetes label specification by removing invalid characters .update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`)
* @param label .digest("hex");
* @returns cleaned label return `githubWorkflow_${hashKey}`;
*/
export function cleanLabel(label: string): string {
let removedInvalidChars = label
.replace(/\s/gi, '_')
.replace(/[\/\\\|]/gi, '-')
.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] || ''
} }
+6 -10
View File
@@ -9,8 +9,8 @@ image:
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
imagePullSecrets: [] imagePullSecrets: []
nameOverride: '' nameOverride: ""
fullnameOverride: '' fullnameOverride: ""
serviceAccount: serviceAccount:
# Specifies whether a service account should be created # 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 # If not set and create is true, a name is generated using the fullname template
name: name:
podSecurityContext: podSecurityContext: {}
{}
# fsGroup: 2000 # fsGroup: 2000
securityContext: securityContext: {}
{}
# capabilities: # capabilities:
# drop: # drop:
# - ALL # - ALL
@@ -38,8 +36,7 @@ service:
ingress: ingress:
enabled: false enabled: false
annotations: annotations: {}
{}
# kubernetes.io/ingress.class: nginx # kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true" # kubernetes.io/tls-acme: "true"
hosts: hosts:
@@ -50,8 +47,7 @@ ingress:
# hosts: # hosts:
# - chart-example.local # - chart-example.local
resources: resources: {}
{}
# We usually recommend not to specify default resources and to leave this as a conscious # 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 # 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 # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -1,23 +0,0 @@
---
apiVersion: v1
kind: Service
metadata:
name: unrouted-service
spec:
selector:
app: fake-application
ports:
- protocol: TCP
port: 80
targetPort: 80
---
kind: TrafficSplit
metadata:
name: foobar-rollout
spec:
service: foobar
backends:
- service: foobar-v1
weight: 1000
- service: foobar-v2
weight: 500
-50
View File
@@ -1,50 +0,0 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: nginx-ingress
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- http:
paths:
- path: /testpath
backend:
service:
name: nginx-service
port:
number: 80