From e02d7a0c59bf32843b6ea30d1641e36803e83740 Mon Sep 17 00:00:00 2001 From: "shimoda.m@nds-tyo.co.jp" Date: Wed, 17 Aug 2022 20:32:54 +0900 Subject: [PATCH 1/3] =?UTF-8?q?refactor:=20=E3=81=BB=E3=81=8B=E3=83=A2?= =?UTF-8?q?=E3=82=B8=E3=83=A5=E3=83=BC=E3=83=AB=E3=81=AE=E6=A9=9F=E8=83=BD?= =?UTF-8?q?=E8=BF=BD=E5=8A=A0=E3=81=AB=E3=82=88=E3=82=8A=E3=80=81=E3=83=86?= =?UTF-8?q?=E3=82=B9=E3=83=88=E5=AE=9F=E6=96=BD=E4=B8=8D=E5=8F=AF=E3=81=A8?= =?UTF-8?q?=E3=81=AA=E3=81=A3=E3=81=9F=E3=83=86=E3=82=B9=E3=83=88=E3=82=92?= =?UTF-8?q?=E3=82=B9=E3=82=AD=E3=83=83=E3=83=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ecs/crm-datafetch/tests/salesforce/test_soql_builder.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ecs/crm-datafetch/tests/salesforce/test_soql_builder.py b/ecs/crm-datafetch/tests/salesforce/test_soql_builder.py index da42d486..56ff81ea 100644 --- a/ecs/crm-datafetch/tests/salesforce/test_soql_builder.py +++ b/ecs/crm-datafetch/tests/salesforce/test_soql_builder.py @@ -1,4 +1,5 @@ +import pytest from src.config.objects import ExecuteDateTime, LastFetchDatetime, TargetObject from src.salesforce.soql_builder import SOQLBuilder @@ -119,7 +120,8 @@ class TestSOQLBuilder: assert actual.replace('\n', '').replace(' ', '') == expect.replace('\n', '').replace(' ', '') - def test_create_fetch_soql_no_columns(self): + @pytest.mark.skip('データ取得用のSOQLがカラムがない状態は、TargetObjectクラス側で制御されるため、テストを実施しない') + def test_raise_create_fetch_soql_cause_no_columns(self): """ Cases: データ取得用のSOQLがカラムがない状態で生成されること From d157edf5a849d81e07f27a807da691a014e449ec Mon Sep 17 00:00:00 2001 From: "shimoda.m@nds-tyo.co.jp" Date: Thu, 18 Aug 2022 12:15:09 +0900 Subject: [PATCH 2/3] =?UTF-8?q?feat:=20CSV=E3=83=90=E3=83=83=E3=82=AF?= =?UTF-8?q?=E3=82=A2=E3=83=83=E3=83=97=E5=87=A6=E7=90=86=E3=81=AE=E3=83=86?= =?UTF-8?q?=E3=82=B9=E3=83=88=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../tests/test_backup_crm_csv_data_process.py | 157 ++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py diff --git a/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py b/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py new file mode 100644 index 00000000..dbb9230d --- /dev/null +++ b/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py @@ -0,0 +1,157 @@ +import textwrap +from unittest.mock import patch + +import pytest +from src.backup_crm_csv_data_process import backup_crm_csv_data_process +from src.config.objects import TargetObject +from src.error.exceptions import FileUploadException +from src.system_var.constants import CSVBK_JP_NAME +from src.util.execute_datetime import ExecuteDateTime + +from .test_utils.log_message import generate_log_message_tuple + + +class TestBackupCrmCsvDataProcess: + + @pytest.fixture + def bucket_name(self): + return 'test-backup-bucket' + + @pytest.fixture + def prepare_bucket(self, s3_client, bucket_name): + s3_client.create_bucket(Bucket=bucket_name) + yield + + def test_run_process_success(self, s3_client, prepare_bucket, bucket_name, monkeypatch, caplog): + """ + Cases: + CSVバックアップ処理が正常終了し、期待通りの結果となること + Arranges: + - prepare_bucketフィクスチャで、CRM電文データをバックアップするためのモックバケットを作る + - 作成したモックバケットを指すように環境変数を設定する + Expects: + - CSVバックアップファイルがバケットに配置される + - CSVバックアップ処理の仕様に沿った正常系ログが出力されること(デバッグログは除く) + """ + # Arrange + csv_string = textwrap.dedent("""\ + "Id","AccountNumber","LastModifiedDate","LastModifiedById","SystemModstamp","IsDeleted" + "TEST001","test001","2022-06-01 09:00:00","1234567","2022-06-01 09:00:00","1" + "TEST002","test002","2022-06-01 09:00:00","1234567","2022-06-01 09:00:00","0" + "TEST003","test003","2022-06-01 09:00:00","1234567","2022-06-01 09:00:00","0" + """) + target_object_dict = { + 'object_name': 'Account', + 'columns': [ + 'Id', + 'AccountNumber', + 'LastModifiedDate', + 'LastModifiedById', + 'SystemModstamp', + 'IsDeleted' + ] + } + + execute_datetime = ExecuteDateTime() + target_object = TargetObject(target_object_dict, execute_datetime) + + # 環境変数を編集 + monkeypatch.setattr('src.aws.s3.CRM_BACKUP_BUCKET', bucket_name) + monkeypatch.setattr('src.aws.s3.CRM_IMPORT_DATA_BACKUP_FOLDER', 'data_import') + + # Act + backup_crm_csv_data_process(target_object, execute_datetime, csv_string) + + # Assert + + # ファイル確認 + actual = s3_client.get_object( + Bucket=bucket_name, + Key=f'data_import/{execute_datetime.to_path()}/CRM_Account_{execute_datetime.format_date()}.csv') + + assert actual['Body'].read().decode('utf-8') == csv_string + + # ログの確認 + assert generate_log_message_tuple( + log_message=f'I-CSVBK-01 [Account] のCSVデータのバックアップ処理を開始します ファイル名：[CRM_Account_{execute_datetime.format_date()}.csv]' + ) in caplog.record_tuples + assert generate_log_message_tuple( + log_message='I-CSVBK-03 [Account] のCSVデータのバックアップ処理を終了します') in caplog.record_tuples + + def test_call_depended_modules(self): + """ + Cases: + CSVバックアップ処理内で依存しているモジュールが正しく呼ばれていること + Arranges: + - CSVバックアップ処理の依存モジュールをモック化する + Expects: + - 依存しているモジュールが正しく呼ばれている + """ + + # Arrange + target_object_dict = { + 'object_name': 'Account', + 'columns': [ + 'Id', + 'AccountNumber', + 'LastModifiedDate', + 'LastModifiedById', + 'SystemModstamp', + 'IsDeleted' + ] + } + + execute_datetime = ExecuteDateTime() + target_object = TargetObject(target_object_dict, execute_datetime) + + with patch('src.backup_crm_csv_data_process.BackupBucket') as mock_backup_bucket: + mock_backup_bucket_inst = mock_backup_bucket.return_value + mock_backup_bucket_inst.put_csv.return_value = '' + # Act + backup_crm_csv_data_process(target_object, execute_datetime, '') + + # Assert + + assert mock_backup_bucket_inst.put_csv.called is True + + def test_raise_put_csv(self, bucket_name, monkeypatch, caplog): + """ + Cases: + CRM電文データをS3に配置できない場合、エラーが発生すること + Arranges: + - オブジェクト情報ファイル取得処理で例外が発生するようにする + Expects: + - 例外が発生する + - ファイル登録できないエラーが返却される + """ + + # Arrange + target_object_dict = { + 'object_name': 'Account', + 'columns': [ + 'Id', + 'AccountNumber', + 'LastModifiedDate', + 'LastModifiedById', + 'SystemModstamp', + 'IsDeleted' + ] + } + + execute_datetime = ExecuteDateTime() + target_object = TargetObject(target_object_dict, execute_datetime) + + with patch('src.backup_crm_csv_data_process.BackupBucket') as mock_backup_bucket: + mock_backup_bucket_inst = mock_backup_bucket.return_value + mock_backup_bucket_inst.put_csv.side_effect = Exception('登録エラー') + # Act + with pytest.raises(FileUploadException) as e: + backup_crm_csv_data_process(target_object, execute_datetime, '') + + # Assert + + assert mock_backup_bucket_inst.put_csv.called is True + assert e.value.error_id == 'E-CSVBK-01' + assert e.value.func_name == CSVBK_JP_NAME + assert e.value.args[0] == \ + f'[Account] CSVデータのバックアップに失敗しました ファイル名：[CRM_Account_{execute_datetime.format_date()}.csv] エラー内容:[登録エラー]' From 25b1d36cc8321831c1848c22d8af14c713b9aad3 Mon Sep 17 00:00:00 2001 From: "shimoda.m@nds-tyo.co.jp" Date: Thu, 18 Aug 2022 16:49:10 +0900 Subject: [PATCH 3/3] =?UTF-8?q?style:=20=E3=83=AC=E3=83=93=E3=83=A5?= =?UTF-8?q?=E3=83=BC=E6=8C=87=E6=91=98=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py b/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py index dbb9230d..267e87da 100644 --- a/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py +++ b/ecs/crm-datafetch/tests/test_backup_crm_csv_data_process.py @@ -117,9 +117,9 @@ class TestBackupCrmCsvDataProcess: def test_raise_put_csv(self, bucket_name, monkeypatch, caplog): """ Cases: - CRM電文データをS3に配置できない場合、エラーが発生すること + CSVデータをバックアップできない場合、エラーが発生すること Arranges: - - オブジェクト情報ファイル取得処理で例外が発生するようにする + - CSVデータをバックアップ処理で例外が発生するようにする Expects: - 例外が発生する - ファイル登録できないエラーが返却される