【CI/CD】UI5プロジェクトのパイプラインを構築するまで ～改善編～

はじめに

この記事は、UI5のCI/CDパイプラインを構築してみるシリーズの3回目です。

＜過去の記事＞
【CI/CD】UI5プロジェクトのパイプラインを構築するまで　～環境構築編～
【CI/CD】UI5プロジェクトのパイプラインを構築するまで　～パイプライン編～

今回は、前回作成したパイプラインに以下の改善を加えます。
1. ABAPサーバにデプロイする際のユーザ、パスワード情報をリポジトリに持たせない
2. パイプラインが特定のブランチで実行された場合のみデプロイする

1. ABAPサーバにデプロイする際のユーザ、パスワード情報をリポジトリに持たせない

前回の記事では、デプロイする際に必要な情報を.nwabaprcファイルに設定してGitリポジトリに置いていました。これはセキュリティ上好ましくないので、JenkinsのCredential設定を使うように修正します。

元の設定

.nwabaprc

{
    "base": "./dist", 
    "conn_server": "http://<host>:<port>", 
    "conn_user": "<user>",                 
    "conn_password": "<password>",             
    "abap_package": "<package>",                
    "abap_bsp": "<BSPアプリのID>",            
    "abap_bsp_text": "<BSPアプリのテキスト>",
    "abap_transport": "<移送依頼>"
}

JenkinsのCredentials設定

以下の手順でJenkinsに認証情報を登録します。

認証情報を追加

Username, Passwordを設定。IDはわかりやすいものをつける（このIDをパイプラインで使用する）

環境変数の設定

ちょっと横道ですが、接続先サーバの情報もJenkinsの環境変数に持たせることにします。

Configure Systemをクリック

Global propertiesのところで以下のように環境変数を追加します。

Jenkinsfileの設定

Deployステージを以下のように変更します。ABAP_DEVELOPMENT_CREDS = credentials('abap_login')で、Credentialsに設定したユーザID、パスワードを取得しています。パイプラインの中でのCredentialの取得方法については、ドキュメントに詳しく書かれています。

nwabap-ui5uploaderは実行時に引数を指定でき、ここでデプロイ先のサーバ、認証情報を指定します。

Jenkinsfile

        stage('deploy') {           
            environment {
                ABAP_DEVELOPMENT_CREDS = credentials('abap_login')
            }
            steps {
                echo "user: ${ABAP_DEVELOPMENT_CREDS_USR}"
                echo "pass: ${ABAP_DEVELOPMENT_CREDS_PSW}"
                sh "npx nwabap upload --conn_server ${env.ABAP_DEVELOPMENT_SERVER_HOST} --conn_user ${ABAP_DEVELOPMENT_CREDS_USR} --conn_password ${ABAP_DEVELOPMENT_CREDS_PSW}"
            }
        }   

.nwabaprcからはサーバ、認証情報は削除します。

.nwabaprc

    "base": "./dist",            
    "abap_package": "<package>",                
    "abap_bsp": "<BSPアプリのID>",            
    "abap_bsp_text": "<BSPアプリのテキスト>",
    "abap_transport": "<移送依頼>"

実行すると、うまくデプロイされました。ユーザ、パスワードの内容はマスクされています。

2. パイプラインが特定のブランチで実行された場合のみデプロイする

masterブランチでパイプラインが実行された場合のみDeployステージを実行するようにします。調べてみると意外と簡単で、stageの下にwhen { branch 'ブランチ名' }を指定するだけでした。

Jenkinsfileの設定

Jenkinsfile

        stage('deploy') {
            when {
                branch 'master'
            }            

結果、masterブランチでない場合はDeployステップがスキップされました。