add clean function

Co-authored-by: Vidya Reddy <vidyareddy@microsoft.com>

README.md

@@ -43,7 +43,15 @@ Following are the key capabilities of this action:
   <tr>
     <td>manifests </br></br>(Required)</td>
     <td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
-  </tr>  
+  </tr>
+    <tr>
+    <td>strategy </br></br>(Required)</td>
+    <td>Acceptable values: basic/canary/blue-green. <br>
+    Default value: basic
+    <br>Deployment strategy to be used while applying manifest files on the cluster.
+    <br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
+    <br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
+  </tr>
   <tr>
     <td>namespace </br></br>(Optional)
     <td>Namespace within the cluster to deploy to.</td>
@@ -62,11 +70,6 @@ Following are the key capabilities of this action:
     <td>pull-images</br></br>(Optional)</td>
     <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
   </tr>
-  <tr>
-    <td>strategy </br></br>(Optional)</td>
-    <td>Acceptable values: none/canary/blue-green. <br>
-    Deployment strategy to be used while applying manifest files on the cluster.<br>none - No deployment strategy is used when deploying.<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
-  </tr>
   <tr>
     <td>traffic-split-method </br></br>(Optional)</td>
     <td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>

action.yml

@@ -20,9 +20,9 @@ inputs:
       required: false
       default: true
    strategy:
-      description: 'Deployment strategy to be used. Allowed values are none, canary and blue-green'
-      required: false
-      default: 'none'
+      description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
+      required: true
+      default: 'basic'
    route-method:
       description: 'Route based on service, ingress or SMI for blue-green strategy'
       required: false

package-lock.json

@@ -22,6 +22,7 @@
             "@types/jest": "^26.0.0",
             "@types/js-yaml": "^3.12.7",
             "@types/node": "^12.20.41",
+            "@vercel/ncc": "^0.34.0",
             "jest": "^26.0.0",
             "prettier": "2.7.1",
             "ts-jest": "^26.0.0",
@@ -1155,6 +1156,15 @@
          "integrity": "sha512-37RSHht+gzzgYeobbG+KWryeAW8J33Nhr69cjTqSYymXVZEN9NbRYWoYlRtDhHKPVT1FyNKwaTPC1NynKZpzRA==",
          "dev": true
       },
+      "node_modules/@vercel/ncc": {
+         "version": "0.34.0",
+         "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.34.0.tgz",
+         "integrity": "sha512-G9h5ZLBJ/V57Ou9vz5hI8pda/YQX5HQszCs3AmIus3XzsmRn/0Ptic5otD3xVST8QLKk7AMk7AqpsyQGN7MZ9A==",
+         "dev": true,
+         "bin": {
+            "ncc": "dist/ncc/cli.js"
+         }
+      },
       "node_modules/abab": {
          "version": "2.0.5",
          "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz",
@@ -7086,6 +7096,12 @@
          "integrity": "sha512-37RSHht+gzzgYeobbG+KWryeAW8J33Nhr69cjTqSYymXVZEN9NbRYWoYlRtDhHKPVT1FyNKwaTPC1NynKZpzRA==",
          "dev": true
       },
+      "@vercel/ncc": {
+         "version": "0.34.0",
+         "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.34.0.tgz",
+         "integrity": "sha512-G9h5ZLBJ/V57Ou9vz5hI8pda/YQX5HQszCs3AmIus3XzsmRn/0Ptic5otD3xVST8QLKk7AMk7AqpsyQGN7MZ9A==",
+         "dev": true
+      },
       "abab": {
          "version": "2.0.5",
          "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz",

package.json

@@ -4,7 +4,7 @@
    "author": "Deepak Sattiraju",
    "license": "MIT",
    "scripts": {
-      "build": "tsc --outDir ./lib --rootDir ./src",
+      "build": "ncc build src/run.ts -o lib",
       "test": "jest",
       "format": "prettier --write .",
       "format-check": "prettier --check ."
@@ -23,6 +23,7 @@
       "@types/jest": "^26.0.0",
       "@types/js-yaml": "^3.12.7",
       "@types/node": "^12.20.41",
+      "@vercel/ncc": "^0.34.0",
       "jest": "^26.0.0",
       "prettier": "2.7.1",
       "ts-jest": "^26.0.0",

src/actions/deploy.ts

@@ -26,7 +26,7 @@ export async function deploy(
    core.debug('Input manifest files: ' + inputManifestFiles)
 
    // deploy manifests
-   core.info('Deploying manifests')
+   core.startGroup('Deploying manifests')
    const trafficSplitMethod = parseTrafficSplitMethod(
       core.getInput('traffic-split-method', {required: true})
    )
@@ -36,10 +36,11 @@ export async function deploy(
       kubectl,
       trafficSplitMethod
    )
+   core.endGroup()
    core.debug('Deployed manifest files: ' + deployedManifestFiles)
 
    // check manifest stability
-   core.info('Checking manifest stability')
+   core.startGroup('Checking manifest stability')
    const resourceTypes: Resource[] = getResources(
       deployedManifestFiles,
       models.DEPLOYMENT_TYPES.concat([
@@ -47,17 +48,19 @@ export async function deploy(
       ])
    )
    await checkManifestStability(kubectl, resourceTypes)
+   core.endGroup()
 
    if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
-      core.info('Routing blue green')
+      core.startGroup('Routing blue green')
       const routeStrategy = parseRouteStrategy(
          core.getInput('route-method', {required: true})
       )
       await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy)
+      core.endGroup()
    }
 
    // print ingresses
-   core.info('Printing ingresses')
+   core.startGroup('Printing ingresses')
    const ingressResources: Resource[] = getResources(deployedManifestFiles, [
       KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
    ])
@@ -67,9 +70,10 @@ export async function deploy(
          ingressResource.name
       )
    }
+   core.endGroup()
 
    // annotate resources
-   core.info('Annotating resources')
+   core.startGroup('Annotating resources')
    let allPods
    try {
       allPods = JSON.parse((await kubectl.getAllPods()).stdout)
@@ -82,4 +86,5 @@ export async function deploy(
       resourceTypes,
       allPods
    )
+   core.endGroup()
 }

src/actions/promote.ts

@@ -65,26 +65,30 @@ async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
 
       // In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
       // canary deployment, then update stable deployment and then redirect traffic to stable deployment
-      core.info('Redirecting traffic to canary deployment')
+      core.startGroup('Redirecting traffic to canary deployment')
       await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
          kubectl,
          manifests
       )
+      core.endGroup()
 
-      core.info('Deploying input manifests with SMI canary strategy')
+      core.startGroup('Deploying input manifests with SMI canary strategy')
       await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
+      core.endGroup()
 
-      core.info('Redirecting traffic to stable deployment')
+      core.startGroup('Redirecting traffic to stable deployment')
       await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
          kubectl,
          manifests
       )
+      core.endGroup()
    } else {
-      core.info('Deploying input manifests')
+      core.startGroup('Deploying input manifests')
       await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
+      core.endGroup()
    }
 
-   core.info('Deleting canary and baseline workloads')
+   core.startGroup('Deleting canary and baseline workloads')
    try {
       await canaryDeploymentHelper.deleteCanaryDeployment(
          kubectl,
@@ -97,6 +101,7 @@ async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
             ex
       )
    }
+   core.endGroup()
 }
 
 async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
@@ -109,7 +114,7 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
       core.getInput('route-method', {required: true})
    )
 
-   core.info('Deleting old deployment and making new one')
+   core.startGroup('Deleting old deployment and making new one')
    let result
    if (routeStrategy == RouteStrategy.INGRESS) {
       result = await promoteBlueGreenIngress(kubectl, manifestObjects)
@@ -118,9 +123,10 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
    } else {
       result = await promoteBlueGreenService(kubectl, manifestObjects)
    }
+   core.endGroup()
 
    // checking stability of newly created deployments
-   core.info('Checking manifest stability')
+   core.startGroup('Checking manifest stability')
    const deployedManifestFiles = result.newFilePaths
    const resources: Resource[] = getResources(
       deployedManifestFiles,
@@ -129,8 +135,9 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
       ])
    )
    await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
+   core.endGroup()
 
-   core.info(
+   core.startGroup(
       'Routing to new deployments and deleting old workloads and services'
    )
    if (routeStrategy == RouteStrategy.INGRESS) {
@@ -170,4 +177,5 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
          manifestObjects.deploymentEntityList
       )
    }
+   core.endGroup()
 }

src/actions/reject.ts

@@ -36,24 +36,26 @@ async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
       core.getInput('traffic-split-method', {required: true})
    )
    if (trafficSplitMethod == TrafficSplitMethod.SMI) {
-      core.info('Rejecting deployment with SMI canary strategy')
+      core.startGroup('Rejecting deployment with SMI canary strategy')
       includeServices = true
       await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
          kubectl,
          manifests
       )
+      core.endGroup()
    }
 
-   core.info('Deleting baseline and canary workloads')
+   core.startGroup('Deleting baseline and canary workloads')
    await canaryDeploymentHelper.deleteCanaryDeployment(
       kubectl,
       manifests,
       includeServices
    )
+   core.endGroup()
 }
 
 async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
-   core.info('Rejecting deployment with blue green strategy')
+   core.startGroup('Rejecting deployment with blue green strategy')
 
    const routeStrategy = parseRouteStrategy(
       core.getInput('route-method', {required: true})
@@ -65,4 +67,5 @@ async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
    } else {
       await rejectBlueGreenService(kubectl, manifests)
    }
+   core.endGroup()
 }

src/strategyHelpers/deploymentHelper.ts

@@ -23,7 +23,8 @@ import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
 import {ExecOutput} from '@actions/exec'
 import {
    getWorkflowAnnotationKeyLabel,
-   getWorkflowAnnotations
+   getWorkflowAnnotations,
+   cleanLabel
 } from '../utilities/workflowAnnotationUtils'
 import {
    annotateChildPods,
@@ -70,10 +71,7 @@ export async function deployManifests(
          return newFilePaths
       }
 
-      case undefined: {
-         core.warning('Deployment strategy is not recognized.')
-      }
-      default: {
+      case DeploymentStrategy.BASIC: {
          const trafficSplitMethod = parseTrafficSplitMethod(
             core.getInput('traffic-split-method', {required: true})
          )
@@ -94,6 +92,10 @@ export async function deployManifests(
 
          return files
       }
+
+      default: {
+         throw new Error('Deployment strategy is not recognized.')
+      }
    }
 }
 
@@ -213,10 +215,10 @@ async function labelResources(
    label: string
 ) {
    const labels = [
-      `workflowFriendlyName=${normalizeWorkflowStrLabel(
-         process.env.GITHUB_WORKFLOW
+      `workflowFriendlyName=${cleanLabel(
+         normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
       )}`,
-      `workflow=${label}`
+      `workflow=${cleanLabel(label)}`
    ]
 
    checkForErrors([await kubectl.labelFiles(files, labels)], true)

src/types/deploymentStrategy.test.ts

@@ -5,6 +5,7 @@ describe('Deployment strategy type', () => {
       const vals = <any>Object.values(DeploymentStrategy)
       expect(vals.includes('canary')).toBe(true)
       expect(vals.includes('blue-green')).toBe(true)
+      expect(vals.includes('basic')).toBe(true)
    })
 
    test('it can parse valid values from a string', () => {

src/types/deploymentStrategy.ts

@@ -1,4 +1,5 @@
 export enum DeploymentStrategy {
+   BASIC = 'basic',
    CANARY = 'canary',
    BLUE_GREEN = 'blue-green'
 }

src/utilities/workflowAnnotationUtils.test.ts

@@ -1,4 +1,7 @@
-import {prefixObjectKeys} from '../utilities/workflowAnnotationUtils'
+import {
+   cleanLabel,
+   prefixObjectKeys
+} from '../utilities/workflowAnnotationUtils'
 
 describe('WorkflowAnnotationUtils', () => {
    describe('prefixObjectKeys', () => {
@@ -15,4 +18,16 @@ describe('WorkflowAnnotationUtils', () => {
          expect(prefixObjectKeys(obj, prefix)).toEqual(expected)
       })
    })
+
+   describe('cleanLabel', () => {
+      it('should clean label', () => {
+         const alreadyClean = 'alreadyClean'
+         expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
+         expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
+         expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
+            'withS0MEinvalidchars'
+         )
+         expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
+      })
+   })
 })

src/utilities/workflowAnnotationUtils.ts

@@ -47,3 +47,14 @@ export function getWorkflowAnnotationKeyLabel(
       .digest('hex')
    return `githubWorkflow_${hashKey}`
 }
+
+/**
+ * Cleans label to match valid kubernetes label specification by removing invalid characters
+ * @param label
+ * @returns cleaned label
+ */
+export function cleanLabel(label: string): string {
+   const removedInvalidChars = label.replace(/[^-A-Za-z0-9_.]/gi, '')
+   const regex = /([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]/
+   return regex.exec(removedInvalidChars)[0] || ''
+}