shinseitaro/July 18, 2023.md

## finpy-pytest-handson-memo.md

      
    Raw
  

              finpy-pytest-handson-memo.md
            
          
    【ハンズオン】pytestを自動化してみよう


【ハンズオン】pytestを自動化してみよう - connpass

ハンズオン内容


第１部：tox でテストの自動化、Github Actionsを使ってプッシュと同時にGithub上でテストを実行
第２部：Issue の課題を解決し、Pull Requestとつなげてマージと同時にテストを行う
次回以降：フォーク元の Issue を解決し Pull Request を建ててマージしてもらう

前回までの資料


pytestでテストを書こう
GitHub Actionsでカバレッジを表示するハンズオン

参考資料


fork元の変更を取り込む
リモートリポジトリを管理する > リモート リポジトリの追加 - GitHub Docs

第１部：tox でテストの自動化、Github Actionsを使ってプッシュと同時にGithub上でテストを実行

環境構築

memo：４月の勉強会で fork したものをそのまま使いたい方は、📌 マークが付いているところだけを更新すればよいと思います。

fork

https://github.com/fin-py/connpass-client/fork でフォークする
forkしたリポジトリで Settings -> Actions -> General のページで Workflow permissions へ移動
Read and write permissions と  Allow Github Actions to create and approve pull requests を選択して Save
📌 フォークしたレポジトリは、Issue機能がデフォルトでOFFになっています。Settings > General > Features で、 Issues に✔を入れてONにしてください


詳細は前回資料の 環境構築を見てください。


ローカル開発環境構築
# フォークした自分のレポジトリを git clone
git clone git@github.com:YOUR-GITHUB-ACCOUNT/connpass-client.git
cd connpass-client

python -m venv .venv
source .venv/bin/activate

pip install -U pip
pip install . pytest tox coverage pytest-cov "genbadge[coverage]" # 📌

source .venv/bin/activate : Windowsの方は仮想環境: Python環境構築ガイド 仮想環境への切り替え - python.jpを参照してください。


tox


tox.ini 新規作成
touch tox.ini


Pythonのバージョンを確認
python -V


tox 記述
tox.ini
[tox]
envlist = py38 
isolated_build = True 

[testenv]
deps = 
    pytest
    faker        
commands = pytest

tox: python のための仮想環境管理およびテストツール。バージョン管理、依存関係の解決、テスト実行、スタイルチェック、静的解析、カバレッジ測定などのタスクを実行する。異なる環境でもOK。CIプラットフォームの一部としてよく用いられる。
envlist = py38 ： 先に確認したPythonのバージョンを指定
isolated_build = True ： ビルド用の仮想環境を作成してその中でビルドする。ビルドの再現性を確保。
deps =  : テストを実行するために必要な依存パッケージを指定。これらのパッケージがテスト環境でインストールされる
commands = pytest： テストを実行するコマンド


tox 実行

tox でテストが実行できることを確認

tox

py39: install_deps> python -I -m pip install faker pytest
.pkg: install_requires> python -I -m pip install poetry-core

... 
                                                                                                                                                     
tests/test_sample.py .              [100%]


Github Actionsをつかってtoxを実行する


.github/workflows 新規作成
mkdir -p .github/workflows


workflow yaml file 新規作成
touch .github/workflows/tox-demo.yml


ワークフローを記述
name: tox demo

on:
    push:
        branches: [ main ]
    pull_request:
        branches: [ main ]

jobs:
    test:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout repository
              uses: actions/checkout@v2

            - name: Set up Python
              uses: actions/setup-python@v2
              with:
                python-version: 3.8 # tox で指定したpythonに合わせる

            - name: Install tox
              run: pip install tox

            - name: Run tox
              run: tox


add / commit / push する


Github のレポジトリにいって、Actions を確認


第２部：Issue の課題を解決し、Pull Requestとつなげてマージと同時にテストを行う

第１部の内容を利用して、例えば以下のような開発環境を整えることができます。

バグや機能強化などのIssueを建てる
その Issue の Branch を作成
Branch を fetch してローカルで課題を解決して、テストを行う
Branch を Push
Pull Requestを作成するタイミングでGithub Actionsを使ってテストを行う
BranchをMainにマージ

Issue を立てる


練習用Issueを作成

練習Issue
タイトル：test for get method

内容：ConnpassClient().get(event_id="266898") で得ることができる辞書のキーは、
    ['results_start', 'results_returned', 'results_available', 'events'] 
    であることを確認するテストを書く


作成した Issue で、Development >  Create a branch
Branch name と Repository destination を確認して、 Checkout locally  のまま Create Brance
Checkout in your local repository に従ってローカルにブランチをフェッチする

テスト作成


先程作ったブランチで作業
tests/test_sample.py
def test_data_keys():
    data = ConnpassClient().get(event_id="266898")
    res = set(data.keys())

    assert res == set(
        ["results_start", "results_returned", "results_available", "events"]
    )

ローカルで tox を実行してテストを確認
add / commit / push

【確認】main ブランチにプッシュしたわけではないので、GAでテストは走らない


Pull Request 作成


レポジトリの Pull requests に行く
Compare & pull request で、Pull Request を作成。

デフォルトではマージ先が fin-py/connpass-client になっているので、自分のレポジトリに変更
適当なメッセージを書いて、Create pull request


Merge pull request


無事プルリクエストが終わるとIssueもCloseしていることを確認

演習


現在の tox-demo.ymlでは mainブランチにPushする、もしくはプルリクエストするタイミングだけでテストが走る設定になっています。これを、Pushしたときは常にテストが走る設定に変更してください。

ヒント： ブランチを指定しなければ全てのPushでワークフローが実行されます


第２部の内容を以下のテストでおさらいしましょう。
内容： ConnpassClient().get(event_id="266898") で得ることができる辞書の 
       `results_returned` キーの値は、`events` の配列データ数と一致することを確認するテストを書く
def test_results_returned():
   an_event_data = ConnpassClient().get(event_id="266898")
   assert an_event_data["results_returned"] == len(an_event_data["events"])


フォーク元の Issue を解決し Pull Request を建ててマージしてもらう

(次回以降の予定なのでまだ未完成です)
upsteam として fork 元のリポジトリ( https://github.com/fin-py/connpass-client/fork )を登録


現在のブランチを確認
git branch -a 
    * main
    remotes/origin/HEAD -> origin/main
    remotes/origin/coverage
    remotes/origin/main    


現在の remote レポジトリの確認
git remote -v
origin  git@github.com:YOUR-NAME/connpass-client.git (fetch)
origin  git@github.com:YOUR-NAME/connpass-client.git (push)

upstream という名前で fork 元（fin-py / connpass-client）を登録
git remote add upstream git@github.com:fin-py/connpass-client.git
【確認】 ssh じゃない人は https://github.com/shinsei-taro-test/connpass-client.git ??
remote レポジトリの確認
git remote -v

    origin	git@github.com:YOUR-NAME/connpass-client.git (fetch)
    origin	git@github.com:YOUR-NAME/connpass-client.git (push)
    upstream	git@github.com:fin-py/connpass-client.git (fetch)
    upstream	git@github.com:fin-py/connpass-client.git (push)

fetch upstream
git fetch upstream

    remote: Enumerating objects: 4, done.
    remote: Counting objects: 100% (2/2), done.
    remote: Total 4 (delta 2), reused 2 (delta 2), pack-reused 2
    Unpacking objects: 100% (4/4), 844 bytes | 844.00 KiB/s, done.
    From github.com:fin-py/connpass-client
    * [new branch]      coverage   -> upstream/coverage
    * [new branch]      dev_test   -> upstream/dev_test
    * [new branch]      main       -> upstream/main

ブランチを確認
git branch -a
    * main
    remotes/origin/HEAD -> origin/main
    remotes/origin/main
    remotes/upstream/coverage
    remotes/upstream/dev_test
    remotes/upstream/main

main ブランチに、upstream/main をマージ 📌
git checkout main  
git merge upstream/main


## July 18, 2023.md

      
    Raw
  

              July 18, 2023.md
            
          
    ‎‎