refactor: ドキュメントコメントを修正、関数名もちょっと修正

This commit is contained in:
shimoda.m@nds-tyo.co.jp 2022-08-02 17:21:46 +09:00
parent 4d444e025e
commit a1613087df

View File

@ -18,12 +18,12 @@ class TestS3Resource:
def test_get_object(self, s3_test, s3_client, bucket_name):
"""
Cases:
S3からオブジェクトが取得できるか
- S3からオブジェクトが取得できるか
Arranges:
- S3をモック化する
- 期待値となるファイルを配置する
Expects:
オブジェクトが取得でき期待値と正しいこと
- オブジェクトが取得でき期待値と正しいこと
"""
# Arrange
s3_client.put_object(Bucket=bucket_name, Key='hogehoge/test.txt', Body=b'aaaaaaaaaaaaaaa')
@ -38,11 +38,12 @@ class TestS3Resource:
def test_put_object(self, s3_test, s3_client, bucket_name):
"""
Cases:
S3にオブジェクトをPUTできるか
- S3にオブジェクトをPUTできるか
Arranges:
- S3をモック化する
Expects:
オブジェクトがPUTできること
- PUTされたファイルが存在する
- PUTされたファイルの内容が期待値と一致する
"""
sut = S3Resource(bucket_name)
@ -54,9 +55,10 @@ class TestS3Resource:
def test_copy(self, s3_test, s3_client, bucket_name):
"""
Cases:
S3内のオブジェクトを別バケットにコピーできるか
- S3内のオブジェクトを別バケットにコピーできるか
Arranges:
- S3をモック化する
- コピー先バケットを作成する
- 期待値となるファイルをコピー元バケットに配置する
Expects:
- コピーされたファイルが存在する
@ -75,11 +77,11 @@ class TestS3Resource:
def test_init_raise_no_provide_bucket_name(self):
"""
Cases:
バケット名を指定しない場合例外となること
- バケット名を指定しない場合例外となること
Arranges:
Expects:
例外が発生すること
- インスタンス生成時に例外が発生すること
"""
with pytest.raises(Exception) as e:
S3Resource()
@ -91,11 +93,11 @@ class TestConfigBucket:
def test_get_object_info_file(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
オブジェクト情報ファイルが取得できること
- オブジェクト情報ファイルが取得できること
Arranges:
オブジェクト情報ファイルを配置する
- オブジェクト情報ファイルを配置する
Expects:
オブジェクト情報ファイルが文字列として取得でき期待値と一致する
- オブジェクト情報ファイルが文字列として取得でき期待値と一致する
"""
monkeypatch.setattr('src.aws.s3.CRM_CONFIG_BUCKET', bucket_name)
monkeypatch.setattr('src.aws.s3.OBJECT_INFO_FOLDER', 'crm')
@ -110,11 +112,12 @@ class TestConfigBucket:
def test_get_last_fetch_datetime_file(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
オブジェクト最終更新日時ファイルが取得できること
- オブジェクト最終更新日時ファイルが取得できること
Arranges:
オブジェクト最終更新日時ファイルを配置する
- S3をモック化する
- オブジェクト最終更新日時ファイルを配置する
Expects:
オブジェクト最終更新日時ファイルが文字列として取得でき期待値と一致する
- オブジェクト最終更新日時ファイルが文字列として取得でき期待値と一致する
"""
monkeypatch.setattr('src.aws.s3.CRM_CONFIG_BUCKET', bucket_name)
monkeypatch.setattr('src.aws.s3.LAST_FETCH_DATE_FOLDER', 'crm')
@ -128,11 +131,12 @@ class TestConfigBucket:
def test_put_last_fetch_datetime_file(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
オブジェクト最終更新日時ファイルをPUTできること
- オブジェクト最終更新日時ファイルをPUTできること
Arranges:
- S3をモック化する
- 環境変数をテスト用の値に置き換える
Expects:
オブジェクト最終更新日時ファイルが存在する
- オブジェクト最終更新日時ファイルが存在する
"""
monkeypatch.setattr('src.aws.s3.CRM_CONFIG_BUCKET', bucket_name)
monkeypatch.setattr('src.aws.s3.LAST_FETCH_DATE_FOLDER', 'crm')
@ -143,14 +147,14 @@ class TestConfigBucket:
actual = s3_client.get_object(Bucket=bucket_name, Key=f'crm/Object.json')
assert actual['Body'].read().decode('utf-8') == 'aaaaaaaaaaaaaaa'
def test_sut_str(self, s3_test, s3_client, bucket_name, monkeypatch):
def test_config_bucket_str(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
設定ファイル配置バケットを文字列化したときバケット名が取得できること
- 設定ファイル配置バケットを文字列化したときバケット名が取得できること
Arranges:
- 環境変数をテスト用の値に置き換える
Expects:
環境変数の設定ファイル配置バケット名と一致する
- 環境変数の設定ファイル配置バケット名と一致する
"""
monkeypatch.setattr('src.aws.s3.CRM_CONFIG_BUCKET', bucket_name)
@ -164,11 +168,12 @@ class TestDataBucket:
def test_put_csv(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
任意のファイルをPUTできること
- 任意のファイルをPUTできること
Arranges:
- S3をモック化する
- 環境変数をテスト用の値に置き換える
Expects:
PUTしたファイルが存在する
- PUTしたファイルが存在する
"""
monkeypatch.setattr('src.aws.s3.IMPORT_DATA_BUCKET', bucket_name)
monkeypatch.setattr('src.aws.s3.CRM_IMPORT_DATA_FOLDER', 'crm/target')
@ -182,11 +187,14 @@ class TestDataBucket:
def test_put_csv_from(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
他のバケットから任意のファイルをコピーできること
- 他のバケットから任意のファイルをコピーできること
Arranges:
- S3をモック化する
- コピー先バケットを作成する
- 期待値となるファイルコピー元バケットに配置する
- 環境変数をテスト用の値に置き換える
Expects:
コピーしたファイルが存在する
- コピーしたファイルが存在する
"""
for_copy_bucket = 'for-copy-bucket'
s3_client.create_bucket(Bucket=for_copy_bucket)
@ -204,11 +212,11 @@ class TestDataBucket:
def test_data_bucket_str(self, s3_test, s3_client, bucket_name, monkeypatch):
"""
Cases:
設定ファイル配置バケットを文字列化したときバケット名が取得できること
- 設定ファイル配置バケットを文字列化したときバケット名が取得できること
Arranges:
- 環境変数をテスト用の値に置き換える
Expects:
環境変数の設定ファイル配置バケット名と一致する
- 環境変数の設定ファイル配置バケット名と一致する
"""
monkeypatch.setattr('src.aws.s3.IMPORT_DATA_BUCKET', bucket_name)