CI / CDって具体的にどう動いている？?

社内勉強会登壇資料。CICDパイプラインをFizzBuzzコードで作成した内容を共有。

Transcript

1. 2023/01/24 社内勉強会 豊岡大地 CI / CDって具体的にどう動いている？? pytestで！ aws lambda deploymemtで！ GitHub Actions Pythonのコードで見てみると、、
2. /７ ―― Agenda ―― 1. 改めて！CI / CDとは？ 2. Pythonでpytestを用いたテストコード作成 3. AWS Lambda（s3 キックイベント）に適用 4. デプロイを合わせたCI / CDの構築 ◼ GitHub Actionsの簡単なやり方 ◼ トライ＆エラーの説明 ◼ これまで作成したシナリオの紹介 5. まとめ デモ① デモ② １
3. /７ ――改めて！CI / CDとは？ ―― ◼ CI （継続的インテグレーション; Continuos Integration） 開発者向けの自動化プロセスを表し、アプリケーションへの新しいコード変更が定期的にビルド、テストされ、 共通リポジトリに統合 ◼ CD （継続的デリバリー/デプロイメント; Continuos Delivery/Deployment） 継続的デリバリーは、開発者のアプリケーションへの変更に対して、バグがないか自動的にテスト、リ ポジトリにアップロード 継続的デプロイメントは、開発者による変更をリポジトリから本番環境に自動的にリリースして顧客が 利用できるようにする （図）RedHatから引用 ２
4. /７ ――Pythonでpytestを用いたテストコード作成―― CI / CD を実現するにはテストコードが必要 →Pythonには、主流なテストフレームワークは”unittest”と“pytest”の2種類が主流 ◼ unittest：Pythonの標準ライブラリに入っているテストフレームワーク。 JavaのJunitをベースに作られている。 ◼ pytest：pipなどでインストールする必要があるが、簡単に記述ができるテストフレームワーク。 （図）Googleで作成。赤がunittestで、青がpytest 特にこだわりがあるわけではないので、 ”pytest”を採用！ ３
5. /７ ――Pythonでpytestを用いたテストコード作成―― pytestは次のようなルールがあります。 ◼評価側：関数に戻り値を設ける ◼テスト側：スクリプト、テスト関数に”test_”のprefixをつける #fizzbuzz.py(FizzBuzz関数) def fizzbuzz(num): if num % 15 == 0: return "FizzBuzz" elif num % 3 == 0: return "Fizz" elif num % 5 == 0: return "Buzz" else: return str(num) ※chatGPTに書いてもらいました、、！ #test_fizzbuzz.py(テストコード) from fizzbuzz import fizzbuzz def test_1st(): num = 15 assert fizzbuzz(num) == "FizzBuzz" #--------------------------------------------------------- import pytest test_set = [ (1, "1"), (3, "Fizz"), (5, "Buzz"), (15, "FizzBuzz") ] @pytest.mark.parametrize("test_input, expect", test_set) def test_2nd(test_input, expect): assert fizzbuzz(test_input) == expect “”” 3で割り切れる数字は”Fizz” 5で割り切れる数字は”Buzz” 15で割り切れる数字は”FizzBuzz” その他はそのまま文字列で返す “”“ デモ① ターミナル上の動き pytest test_fizzbuzz.py or python –m pytest test_fizzbuzz.py ＃オプション -s で標準出力込み -v で各テスト別の出力 ４
6. /７ ――AWS Lambda（s3 キックイベント）に適用―― 呼び出しツールの架電メールを判断するLambdaで、テストコードを適用させました！ ５
7. /７ ――AWS Lambda（s3 キックイベント）に適用―― 呼び出しツールの運用に当たり、架電判定メールの調整が3－4か月に一度程度。 →コードでカスタマイズした際に、既存の動きに影響が出ていないか不安 テストフレームワークを使ってみてよかったところ ◼ これまで正常に動作していた関数の担保 ※新規開発よりアップデート作業でより、 効果が感じやすいなと思いました ◼ ステータスを評価する戻り値は必須なので、早期 リターンを意識してネストが深くならない #test_lambda_handler.py def get_args(bucket, key): event = { "Records": [{ "s3": { "bucket": { "name": bucket, }, "object": { "key": key } } }] } return event class TestMailJudge(): def test_1st(self): event = get_args(bucket, key) response = lambda_handler(event, "") assert response["statusCode"] == 200 and response["alertType"] == "word" : : ６
8. /７ ――デプロイを合わせたCI / CDの構築―― ◼ GitHub Actionsの簡単なやり方 ①GitHubレポジトリのトップディレクトリ配下の、.github/workflows/にymlファイルを追加 ②ymlに環境情報・ジョブ情報を加えていく #pytest.yml name: Run pytest on: push: branches: - stg workflow_dispatch: permissions: read-all(write-all) jobs: pytest: runs-on: ubuntu-latest defaults: run: shell: bash working-directory: ./pytest (1/2) steps: # Configure - name: Git clone the repository uses: actions/checkout@v3 - name: Set up Python 3.10 uses: actions/setup-python@v4 with: python-version: '3.10’ - name: Install dependencies run: | python -m pip install --upgrade pip pip install pytest # Execute - name: PyTest run: python -m pytest test_fizzbuzz.py --junit-xml pytest.xml (2/2) デモ②；トライ＆エラーの説明 テストフレームワークの準備 テストの実施 環境情報① 環境情報② ７