#######
Go Jobs
#######

Macros
======

lf-go-test
----------

Calls go-test.sh script against a Go project.

:Required Parameters:

    :go-root: Path to the Go project root directory.

lf-infra-nexus-iq-go-cli
------------------------

Calls nexus-iq-go-cli.sh to CLM scan a Go project through CLI.

:Required Parameters:

    :NEXUS_IQ_PROJECT_NAME: Nexus IQ project name that will receive the CLM scan results.

lf-infra-nexus-iq-go-api
------------------------

Calls nexus-iq-go-api.sh to CLM scan a Go project through REST API.

:Required Parameters:

    :NEXUS_IQ_PROJECT_NAME: Nexus IQ project name that will receive the CLM scan results.

install-golang
--------------

Installs the specified Golang version throuhg a plug-in.

:Required Parameters:

    :version: Golang version number to install.

lf-go-common
------------

Common Jenkins configuration for Go jobs.

Job Templates
=============

Go SNYK CLI
-----------

Builds the code, downloads and runs a Snyk CLI scan of the code into the Snyk dashboard.

:Template Names:

    - {project-name}-go-snyk-cli-{stream}
    - gerrit-go-snyk-cli
    - github-go-snyk-cli

:Comment Trigger: run-snyk

:Required parameters:

    :build-node:    The node to run build on.
    :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
    :snyk-token-credential-id: Snyk API token to communicate with Jenkins.
    :snyk-org-credential-id: Snyk organization ID.

:Optional parameters:

    :branch: The branch to build against. (default: master)
    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
    :build-timeout: Timeout in minutes before aborting build. (default: 60)
    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
    :java-version: Version of Java to use for the build. (default: openjdk11)
    :snyk-cli-options: Snyk CLI options. (default: '')
    :stream: Keyword that represents a release code-name.
        Often the same as the branch. (default: master)
    :submodule-recursive: Whether to checkout submodules recursively.
        (default: true)
    :submodule-timeout: Timeout (in minutes) for checkout operation.
        (default: 10)
    :submodule-disable: Disable submodule checkout operation.
        (default: false)

    :gerrit_snyk_triggers: Override Gerrit Triggers.

Go Verify
---------

Job which runs go test ./... to verify a Go project.
'go test ./...' runs unit tests on current folder and all subfolders.

:Template Names:

    - {project-name}-go-verify-{stream}"
    - gerrit-go-verify
    - github-go-verify

:Comment Trigger: recheck|reverify

:Required parameters:

    :build-node: The node to run build on.
    :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)

:Optional parameters:

    :branch: Git branch to fetch for the build. (default: master)
    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
    :build-timeout: Timeout in minutes before aborting build. (default: 60)
    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
    :stream: Keyword that represents a release code-name.
        Often the same as the branch. (default: master)
    :submodule-recursive: Whether to checkout submodules recursively.
        (default: true)
    :submodule-timeout: Timeout (in minutes) for checkout operation.
        (default: 10)
    :submodule-disable: Disable submodule checkout operation.
        (default: false)
    :gerrit_verify_triggers: Override Gerrit Triggers.
    :gerrit_trigger_file_paths: Override file paths to filter which file
        modifications will trigger a build.

Go CLM
------

Job which runs a CLM scan over a Golang project.

:Template Names:

    - {project-name}-nexus-iq-go-clm-{stream}
    - gerrit-nexus-iq-go-clm

:Comment Trigger: run-clm

:Required parameters:

    :build-node: The node to run build on.
    :golang-version: Golang version you want to use for the CLM scan. (default: 1.23)

:Optional parameters:

    :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
    :branch: Git branch to fetch for the build. (default: master)
    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
    :build-timeout: Timeout in minutes before aborting build. (default: 15)
    :cron: cronjob frequency to run the job. (default: @weekly)
    :disable-job: boolean flag to enable/disable the job (default: false)
    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
    :java-version: Java version to run the Nexus scanner (default: openjdk17)
    :nexus-iq-cli-version: version of the Nexus CLI scanner (default: 1.185.0-01)
    :nexus-iq-namespace: prefix to append to the Nexus project name.
        Recommend using a trailing dash when set. Example: "onap-". (default: "")
    :nexus-target-build: file to use for the Nexus CLM scan (default: go.sum)
    :pre-build-script: optional pre-build script.
    :stream: Keyword that represents a release code-name.
        Often the same as the branch. (default: master)
    :submodule-recursive: Whether to checkout submodules recursively.
        (default: true)
    :submodule-timeout: Timeout (in minutes) for checkout operation.
        (default: 10)
    :submodule-disable: Disable submodule checkout operation.
        (default: false)