English

Добавление в Jenkins¶

Консольный агент поддерживает добавление в Jenkins двумя способами: через Jenkinsfile и специализированный плагин.

Добавление агента в Jenkinsfile¶

Использование Docker-образа¶

Пример добавления агента в pipeline с использованием docker-образа:

pipeline {
    agent any

  environment {
    CODESCORING_REGISTRY_URL='REGISTRY_URL'
    CODESCORING_AGENT_IMAGE='REGISTRY_URL/johnny-depp:<version>'
    CODESCORING_REGISTRY_CREDENTIALS=credentials('cs-registry-creds')
    CODESCORING_API_URL='https://localhost:8080'
  }

  stages {

    stage("Login to Codescoring docker registry") {
      steps {
        sh """
        docker login -u "$CODESCORING_REGISTRY_CREDENTIALS_USR" "$CODESCORING_REGISTRY_URL" -p "$CODESCORING_REGISTRY_CREDENTIALS_PSW"
          """
      }
    }

    stage('Run CodeScoring Agent') {
      steps {
        sh """
        docker run -v \$(pwd):/code --rm ${CODESCORING_AGENT_IMAGE} --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
        """
      }
    }
  }
}

Использование бинарного файла¶

Для использования бинарного файла консольного агента, необходимо предварительно выполнить следующие действия на машине с Jenkins:

Скачать файл командой
```
wget -O /usr/local/bin/johnny https://REGISTRY_USERNAME:REGISTRY_PASSWORD@REGISTRY_URL/repository/files/codescoring/johnny-depp/JOHNNY_VERSION/johnny-linux-amd64-JOHNNY_VERSION
```
или
```
curl -o /usr/local/bin/johnny https://REGISTRY_USERNAME:REGISTRY_PASSWORD@REGISTRY_URL/repository/files/codescoring/johnny-depp/JOHNNY_VERSION/johnny-linux-amd64-JOHNNY_VERSION
```
Переменную JOHNNY_VERSION необходимо заменить на версию агента. Список актуальных версий доступен в разделе Changelog.

Переменные REGISTRY_URL, REGISTRY_USERNAME и REGISTRY_PASSWORD необходимо заменить на адрес, логин и пароль, полученные от вендора.
Разрешить исполнение файла

  chmod +x /usr/local/bin/johnny

Пример вызова бинарного файла агента в pipeline:

pipeline {
    agent any

  environment {
    CODESCORING_API_URL='http://localhost:8001'
    CODESCORING_API_TOKEN='API_TOKEN'
  }

  stages {

    stage('Run CodeScoring Agent') {
      steps {
        sh """
        johnny scan dir --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
        """
      }
    }
  }
}