add clean function (#211)

Author: OliverMKing

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,
@@ -214,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/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] || ''
+}