Merge pull request #80 from codefresh-io/CR-13197

CR-13197

Author: eti-codefresh

README.md

@@ -26,119 +26,42 @@ Commit that resulted in the image being built
 
 ## Example - github-actions
   ```
-  - name: report image by action
-        with:
-          CF_HOST: "https://my-runtime-url"
-          CF_API_KEY: ${{ secrets.CF_TOKEN }}
-          
-          #Codefresh Integrations to USE
-          CF_CONTAINER_REGISTRY_INTEGRATION: "dockerhub"
-          CF_JIRA_INTEGRATION: "jira"
-	  
-          CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/my-image-name:tag
-          
-          CF_GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}
-	  
-          #Jira issues that match
-          CF_JIRA_MESSAGE: "CR-12293"
-          CF_JIRA_PROJECT_PREFIX: "CR"
-        uses: codefresh-io/codefresh-report-image@latest
+
+- name: report image
+  with:
+    # Name of runtime to implement the enrichment
+    CF_RUNTIME_NAME: 'codefresh-hosted'
+
+    # Codefresh API key !! Committing a plain text token is a security risk. We highly recommend using an encrypted secrets. !!
+    # Documentation - https://docs.github.com/en/actions/security-guides/encrypted-secrets
+    CF_API_KEY: ${{ secrets.CF_TOKEN }}
+
+    # Image path to enrich
+    CF_IMAGE: ${{ secrets.DOCKERHUB_USERNAME }}/my-image-name:tag
+
+    # Name of Container registry integration
+    CF_CONTAINER_REGISTRY_INTEGRATION: 'testghjmjhg'
+
+    # The git branch which is related for the commit
+    CF_GIT_BRANCH: '${{ github.ref_name }}'
+
+    # GitHub Access token !! Committing a plain text token is a security risk. We highly recommend using an encrypted secrets. !!
+    # Documentation - https://docs.github.com/en/actions/security-guides/encrypted-secrets
+    CF_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    # Name of Jira integration
+    CF_JIRA_INTEGRATION: 'eti-jira'
+
+    # Jira project filter
+    CF_JIRA_PROJECT_PREFIX: 'CR'
+
+    # String starting with the issue ID to associate with image
+    CF_JIRA_MESSAGE: 'CR-12293'
+
+
+  uses: codefresh-io/codefresh-report-image@latest
   ```
 
 
 # Complete List of Arguments
-### service
-- #### CF_HOST
-   - **description**: Name of runtime to implement the enrichment
-   - required
-   - ["example",["https://codefresh.yourdoamin.com:80"]]
-   - **default**: [runtime_host_url]
-- #### CF_API_KEY
-   - **description**: Codefresh API key
-   - required
-   - secret
-### general
-- #### CF_IMAGE
-   - **description**: Image path to enrich
-   - required
-   - ["examples",["mydockerhub/pushedimage:fix"]]
-   - **default**: [full image path here, including tag]
-- #### CF_CONTAINER_REGISTRY_INTEGRATION
-   - **description**: Name of Container registry integration
-- #### CF_WORKFLOW_URL
-   - **description**: The reported URL of the workflow that builds the image.
-   - ["examples",["https://github.com/saffi-codefresh/csdp-report-image-github-action/actions/runs/2389116616"]]
-   - **default**: [URL of the workflow that builds the image]
-- #### CF_WORKFLOW_NAME
-   - **description**: The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform.
-   - ["examples",["Staging build step"]]
-- #### CF_CI_TYPE
-   - **description**: Name of integration type, used for filtering results by the reporting tool type
-   - ["examples",["git-action","classic","jenkins",""]]
-### git
-- #### CF_GIT_BRANCH
-   - **description**: The git branch which is related for the commit
-- #### CF_GIT_REPO
-   - **description**: The the git repository used for building the image
-   - required
-### explicit-git-setup
-- #### CF_GIT_PROVIDER
-   - **description**: The git integration type use (i.e. github)
-   - required
-### github
-- #### CF_GITHUB_TOKEN
-   - **description**: GitHub Access token
-   - required
-   - ["examples",["ghp_vVvA6oh5iCO...."]]
-   - secret
-   - **default**: [github-personal-access-token]
-- #### CF_GITHUB_API_URL
-   - **description**: Specify github host api url
-   - ["examples",["https://api.github.com"]]
-### gitlab
-- #### CF_GITLAB_TOKEN
-   - **description**: When explicit authentication used: For gitlab use, authenticate with a gitlab-token
-   - required
-   - ["examples",["glpat-CzJ...."]]
-   - secret
-- #### CF_GITLAB_HOST_URL
-   - **description**: Specify gitlab host url
-   - ["examples",["https://gitlab.com"]]
-### bitbucket
-- #### CF_BITBUCKET_USERNAME
-   - **description**: Bitbucket username
-   - required
-- #### CF_BITBUCKET_PASSWORD
-   - **description**: Bitbucket password
-   - required
-   - secret
-### bitbucketServer
-- #### CF_BITBUCKET_USERNAME
-   - **description**: Bitbucket server username
-   - required
-- #### CF_BITBUCKET_PASSWORD
-   - **description**: Bitbucket server password
-   - required
-   - secret
-- #### CF_BITBUCKET_HOST_URL
-   - **description**: Bitbucket server host url
-   - required
-   - ["examples",["https://bitbucket-server:7990"]]
-### jira
-- #### CF_JIRA_INTEGRATION
-   - **description**: Name of Jira integration
-   - **default**: [jira-registry-integration-name]
-- #### CF_JIRA_PROJECT_PREFIX
-   - **description**: Jira project filter
-   - required
-   - ["examples",["CR"]]
-   - **default**: [jira-project-prefix]
-- #### CF_JIRA_MESSAGE
-   - **description**: String starting with the issue ID to associate with image
-   - required
-   - ["examples",["fix CR-11312 "]]
-   - **default**: [issue id]
-- #### CF_JIRA_FAIL_ON_NOT_FOUND
-   - **description**: When enabled, Fail the image report when the specified Jira issue is not found.
-   - ["examples",["true"]]
-
+  https://codefresh.io/csdp-docs/docs/integrations/github-actions/#codefresh-github-action-integration-arguments

action.yaml

@@ -10,6 +10,9 @@ inputs:
     required: true
   CF_HOST:
     description: "Codefresh runtime exposed in cluster address: https://your.clusters.ci-cd.com/app-proxy"
+    required: false
+  CF_RUNTIME_NAME:
+    description: "Codefresh runtime name"
     required: true
   CF_VERBOSE:
     description: "verbose output"
@@ -41,6 +44,9 @@ inputs:
   CF_WORKFLOW_URL:
     required: false
     description: "external url for the workflow"
+  CF_WORKFLOW_NAME:
+    required: false
+    description: "The name assigned to the workflow that builds the image. When defined, the name is displayed in the Codefresh platform."
   CF_LOGS_URL:
     required: false
     description: "external url for the logs"
@@ -107,6 +113,7 @@ runs:
       env:
         VERSION: "${{ inputs.VERSION }}"
         CF_HOST: "${{ inputs.CF_HOST }}"
+        CF_RUNTIME_NAME: "${{ inputs.CF_RUNTIME_NAME }}"
         CF_API_KEY: "${{ inputs.CF_API_KEY }}"
 
         CF_IMAGE: "${{ inputs.CF_IMAGE }}"
@@ -119,6 +126,7 @@ runs:
         CF_REGISTRY_DOMAIN: "${{ inputs.CF_REGISTRY_DOMAIN }}"
         CF_INSECURE: "${{ inputs.CF_INSECURE }}"
         CF_WORKFLOW_URL: "${{ inputs.CF_WORKFLOW_URL }}"
+        CF_WORKFLOW_NAME: "${{ inputs.CF_WORKFLOW_NAME }}"
         CF_LOGS_URL: "${{ inputs.CF_LOGS_URL }}"
 
         CF_ENRICHERS: "${{ inputs.CF_ENRICHERS }}"
@@ -149,16 +157,17 @@ runs:
         # github
         GITHUB_REF_NAME: "${{ github.ref_name }}"
         GITHUB_REPOSITORY: "${{ github.repository }}"
-        GITHUB_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-        GITHUB_PAYLOAD_MESSAGE: "${{ github.event.client_payload.message }}"        
+        GITHUB_WORKFLOW_NAME: "${{ github.repository }}/${{ github.run_id }}"
+        GITHUB_WORKFLOW_URL: "${{ github.server_url	}}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
 
 
       run: |
         # add defaults
         export CF_GIT_BRANCH="${CF_GIT_BRANCH:-$GITHUB_REF_NAME}"
         export CF_GIT_REPO="${CF_GIT_REPO:-$GITHUB_REPOSITORY}"
         # built vars
-        export CF_WORKFLOW_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
+        export CF_WORKFLOW_URL="${CF_WORKFLOW_URL:-$GITHUB_WORKFLOW_URL}"
+        export CF_WORKFLOW_NAME="${CF_WORKFLOW_NAME:-$GITHUB_WORKFLOW_NAME}"
         export CF_GIT_PROVIDER="${CF_GIT_PROVIDER:-github}"
         export CF_CI_TYPE=github-actions
         

package.json

@@ -26,6 +26,8 @@
   "dependencies": {
     "chalk": "4.1.2",
     "eventsource": "^2.0.1",
+    "graphql": "^16.5.0",
+    "graphql-request": "^4.3.0",
     "winston": "^3.7.2"
   },
   "devDependencies": {

service.yaml

@@ -1,2 +1,2 @@
 name: codefresh-report-image
-version: 0.0.153
+version: 0.0.154

src/__tests__/request-builder.spec.ts

@@ -1,10 +1,8 @@
-import { buildUrlHeaders } from '../utils'
-
+import { Utils } from '../utils'
 
 describe('request builder test', () => {
-    it('not clean CF_', async () => {
-        const
-            { url, headers } = buildUrlHeaders({
+    it('support CF_HOST', async () => {
+        const { url, headers } = await Utils.buildUrlHeaders({
                 'CF_API_KEY': 'the-token',
                 'CF_HOST': 'https://g.codefresh.io',
                 'CF_IMAGE': 'testImage'
@@ -13,4 +11,16 @@ describe('request builder test', () => {
         expect(headers).toEqual({ 'authorization': 'the-token' })
     })
 
+    it('support CF_RUNTIME_NAME', async () => {
+        const ingressHost = 'https://my.codefresh.ingress'
+        jest.spyOn(Utils, 'getRuntimeIngressHost').mockResolvedValue(ingressHost)
+        const { url, headers } = await Utils.buildUrlHeaders({
+                'CF_API_KEY': 'the-token',
+                'CF_RUNTIME_NAME': 'runtime',
+                'CF_IMAGE': 'testImage'
+            })
+        expect(url).toEqual(`${ingressHost}/app-proxy/api/image-report?CF_IMAGE=testImage`)
+        expect(headers).toEqual({ 'authorization': 'the-token' })
+    })
+
 })

src/__tests__/validate.spec.ts

@@ -6,14 +6,23 @@ describe('client report-image validation', () => {
         try {
             validate({ ENV1: '1', someVal: 'ignored' })
         } catch (error) {
-            expect(error.message).toBe(`Validation Error: ["CF_API_KEY must be provided as environment variable.",` +
-                `"CF_IMAGE must be provided as environment variable.",`+
-                `"CF_HOST must be provided as app-proxy http/s address"]`)
+            const expectedErrorMsg = '["CF_API_KEY must be provided as environment variable.","CF_IMAGE must be provided as environment variable.","CF_RUNTIME_NAME must be provided as environment variable."]'
+            expect(error.message).toBe(expectedErrorMsg)
             return
         }
         fail(`should have thrown Validation Error`)
     })
-    it('All OK', async () => {
+    it('not support both CF_HOST and CF_RUNTIME_NAME', async () => {
+        try {
+            validate({ CF_API_KEY: '1', alsoIgnored: 'ignored', IGNORED: 'ignored too', CF_IMAGE: 'testImage', CF_HOST: `host.io`, CF_RUNTIME_NAME: 'runtime' })
+        } catch (error) {
+            const expectedErrorMsg = '["You can only specify CF_RUNTIME_NAME or CF_HOST. please delete one of them."]'
+            expect(error.message).toBe(expectedErrorMsg)
+            return
+        }
+        fail(`should have thrown Validation Error`)
+    })
+    it('support CF_HOST', async () => {
         let res
         try {
             res = validate({ CF_API_KEY: '1', alsoIgnored: 'ignored', IGNORED: 'ignored too', CF_IMAGE: 'testImage', CF_HOST: `host.io` })
@@ -26,4 +35,17 @@ describe('client report-image validation', () => {
             'CF_IMAGE': 'testImage'
         })
     })
+    it('support CF_RUNTIME_NAME', async () => {
+        let res
+        try {
+            res = validate({ CF_API_KEY: '1', alsoIgnored: 'ignored', IGNORED: 'ignored too', CF_IMAGE: 'testImage', CF_RUNTIME_NAME: `runtime` })
+        } catch (error) {
+            fail(`should have not thrown an error ${JSON.stringify(error)}`)
+        }
+        expect(res).toEqual({
+            'CF_API_KEY': '1',
+            'CF_RUNTIME_NAME': 'runtime',
+            'CF_IMAGE': 'testImage'
+        })
+    })
 })

src/errors.ts

@@ -0,0 +1,14 @@
+export const errors = {
+    EventSourceError: class extends Error {
+        constructor(message?: string, name?: string) {
+            super(message)
+            this.name = name || 'EventSourceError'
+        }
+    },
+    ValidationError: class extends Error {
+        constructor(message?: string, name?: string) {
+            super(message)
+            this.name = name || 'ValidationError'
+        }
+    }
+}

src/main.ts

@@ -1,11 +1,13 @@
 import EventSource from 'eventsource'
 
 import { validate } from './validate'
-import { tryParseJson, errors, buildUrlHeaders } from './utils'
+import { Utils }  from './utils'
+import {  errors } from './errors'
 import { logger, workflowLogger } from './logger'
 
 const { EventSourceError } = errors
 
+
 /**
  * Take (CF_ prefixed) Env variables and perform http/s request (SSE) to app-proxy for image-report with CF_ENRICHERS
  */
@@ -15,7 +17,7 @@ async function main(argv, env): Promise<void> {
         logger.debug('running with verbose log')
     }
     const payload = validate(env)
-    const { url, headers } = buildUrlHeaders(payload)
+    const { url, headers } = await Utils.buildUrlHeaders(payload)
     if (verbose) {
         logger.debug(`payload: ${JSON.stringify(payload, null, 2)}`)
         logger.debug(`sending request: ${url}, headers: ${JSON.stringify(headers)}`)
@@ -37,7 +39,7 @@ async function main(argv, env): Promise<void> {
             logger.warn(event.data)
         })
         eventSource.addEventListener('workflow-log', function (event) {
-            const log = tryParseJson(event.data)
+            const log = Utils.tryParseJson(event.data)
             if (typeof log === 'object' && log.content && log.podName) {
                 workflowLogger.info({ pod: log.podName, message: log.content })
             } else {
@@ -47,7 +49,7 @@ async function main(argv, env): Promise<void> {
         eventSource.addEventListener('error', (errorEvent) => {
             eventSource.close()
 
-            const error = tryParseJson(errorEvent.data)
+            const error = Utils.tryParseJson(errorEvent.data)
             let name
             let message
             if (typeof error === 'string') {