Fixing Regex Issue + Adding Check for Failures Connecting to Github Repos (#271)

* changed ubuntu runner

* changed minikube action

* Version formatting

* nonedriveR

* update kube version

* installing conntrack'

* updated other actions

* update bg ingress api version

* prettify

* updated ingress backend for new api version

* Added path type

* prettify

* added logging

* added try catch logic to prevent future failures if annotations fail since failing annotations shouldn't affect users

* added nullcheck

* Added fallback filename if workflow fails to get github filepath due to runner issues

* cleanup

* added oliver's feedback + unit test demonstrating regex glitch and fix

* no longer using blank string for failed regex

Author: jaiveerk

src/strategyHelpers/deploymentHelper.ts

@@ -150,8 +150,15 @@ export async function annotateAndLabelResources(
    resourceTypes: Resource[],
    allPods: any
 ) {
+   const defaultWorkflowFileName = 'k8s-deploy-failed-workflow-annotation'
    const githubToken = core.getInput('token')
-   const workflowFilePath = await getWorkflowFilePath(githubToken)
+   let workflowFilePath
+   try {
+      workflowFilePath = await getWorkflowFilePath(githubToken)
+   } catch (ex) {
+      core.warning(`Failed to extract workflow file name: ${ex}`)
+      workflowFilePath = defaultWorkflowFileName
+   }
 
    const deploymentConfig = await getDeploymentConfig()
    const annotationKeyLabel = getWorkflowAnnotationKeyLabel()
@@ -164,8 +171,11 @@ export async function annotateAndLabelResources(
       annotationKeyLabel,
       workflowFilePath,
       deploymentConfig
+   ).catch((err) => core.warning(`Failed to annotate resources: ${err} `))
+
+   await labelResources(files, kubectl, annotationKeyLabel).catch((err) =>
+      core.warning(`Failed to label resources: ${err}`)
    )
-   await labelResources(files, kubectl, annotationKeyLabel)
 }
 
 async function annotateResources(

src/types/kubectl.ts

@@ -70,13 +70,21 @@ export class Kubectl {
       let newReplicaSet = ''
       if (result?.stdout) {
          const stdout = result.stdout.split('\n')
+         core.debug('stdout from getNewReplicaSet is ' + JSON.stringify(stdout))
          stdout.forEach((line: string) => {
             const newreplicaset = 'newreplicaset'
-            if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
+            if (line && line.toLowerCase().indexOf(newreplicaset) > -1) {
+               core.debug(
+                  `found string of interest for replicaset, line is ${line}`
+               )
+               core.debug(
+                  `substring is ${line.substring(newreplicaset.length).trim()}`
+               )
                newReplicaSet = line
                   .substring(newreplicaset.length)
                   .trim()
                   .split(' ')[0]
+            }
          })
       }
 

src/utilities/workflowAnnotationUtils.test.ts

@@ -16,5 +16,18 @@ describe('WorkflowAnnotationUtils', () => {
             cleanLabel('Workflow Name / With Slashes / And Spaces')
          ).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces')
       })
+      it('should return a blank string when regex fails (https://github.com/Azure/k8s-deploy/issues/266)', () => {
+         const label = '持续部署'
+         expect(cleanLabel(label)).toEqual('github-workflow-file')
+
+         let removedInvalidChars = 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]/
+         const regexResult = regex.exec(removedInvalidChars)
+         expect(regexResult).toBe(null)
+      })
    })
 })

src/utilities/workflowAnnotationUtils.ts

@@ -43,5 +43,8 @@ export function cleanLabel(label: string): string {
       .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] || ''
+   const regexResult = regex.exec(removedInvalidChars) || [
+      'github-workflow-file'
+   ]
+   return regexResult[0]
 }