From 9f7e9a8e398c9dd7b9524cd28025d2ac2efca47d 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/5] =?UTF-8?q?style:=20=E3=83=95=E3=82=A1=E3=82=A4?= =?UTF-8?q?=E3=83=AB=E5=90=8D=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../tests/salesforce/{test_salesfoce.py => test_salesforce.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename ecs/crm-datafetch/tests/salesforce/{test_salesfoce.py => test_salesforce.py} (100%) diff --git a/ecs/crm-datafetch/tests/salesforce/test_salesfoce.py b/ecs/crm-datafetch/tests/salesforce/test_salesforce.py similarity index 100% rename from ecs/crm-datafetch/tests/salesforce/test_salesfoce.py rename to ecs/crm-datafetch/tests/salesforce/test_salesforce.py From d60d1a65364903d8dd53078f4a9a3fd76d2baf61 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 2/5] =?UTF-8?q?feat:=20CRM=E9=9B=BB=E6=96=87=E3=83=87?= =?UTF-8?q?=E3=83=BC=E3=82=BF=E3=83=90=E3=83=83=E3=82=AF=E3=82=A2=E3=83=83?= =?UTF-8?q?=E3=83=97=E5=87=A6=E7=90=86=E3=81=AE=E3=83=86=E3=82=B9=E3=83=88?= =?UTF-8?q?=E3=82=92=E8=BF=BD=E5=8A=A0=E3=80=82=E3=83=90=E3=83=83=E3=82=AF?= =?UTF-8?q?=E3=82=A2=E3=83=83=E3=83=97=E3=83=95=E3=82=A1=E3=82=A4=E3=83=AB?= =?UTF-8?q?=E5=90=8D=E3=82=92=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/backup_crm_data_process.py | 10 +- ecs/crm-datafetch/src/controller.py | 2 +- .../tests/test_backup_crm_data_process.py | 99 +++++++++++++++++++ 3 files changed, 106 insertions(+), 5 deletions(-) create mode 100644 ecs/crm-datafetch/tests/test_backup_crm_data_process.py diff --git a/ecs/crm-datafetch/src/backup_crm_data_process.py b/ecs/crm-datafetch/src/backup_crm_data_process.py index 0375d927..a5739e07 100644 --- a/ecs/crm-datafetch/src/backup_crm_data_process.py +++ b/ecs/crm-datafetch/src/backup_crm_data_process.py @@ -1,15 +1,16 @@ from src.aws.s3 import BackupBucket +from src.config.objects import TargetObject from src.error.exceptions import FileUploadException from src.system_var.constants import RESBK_JP_NAME from src.util.execute_datetime import ExecuteDateTime from src.util.logger import logger_instance as logger -def backup_crm_data_process(object_name: str, sf_object_dict: dict, execute_datetime: ExecuteDateTime): +def backup_crm_data_process(target_object: TargetObject, sf_object_dict: dict, execute_datetime: ExecuteDateTime): """CRM電文データバックアップ処理 Args: - object_name (str): 取得対象オブジェクト名 + target_object (TargetObject): 取得対象オブジェクト名 sf_object_dict (dict): Salesforceオブジェクトデータ execute_datetime (ExecuteDateTime): 実行日次取得インスタンス @@ -17,12 +18,13 @@ def backup_crm_data_process(object_name: str, sf_object_dict: dict, execute_date FileUploadException: S3のファイルアップロード失敗 """ + object_name = target_object.object_name # ① CRM電文データバックアップ処理の開始ログを出力する logger.info(f'I-RESBK-01 [{object_name}] のCRM電文データバックアップ処理を開始します') try: # ② CRMバックアップ保管用バケットに、CRMから取得したJSONの電文データのバックアップを保管する - file_name = f'{execute_datetime.to_path()}/{object_name}.json' + file_name = f'{execute_datetime.to_path()}/{target_object.upload_file_name}.json' backup_bucket = BackupBucket() backup_bucket.put_response_json(file_name, sf_object_dict) @@ -31,7 +33,7 @@ def backup_crm_data_process(object_name: str, sf_object_dict: dict, execute_date except Exception as e: raise FileUploadException( - 'E-RESBK-01', RESBK_JP_NAME, f'[{object_name}] 電文データのバックアップに失敗しました ファイル名：[{object_name}.json] エラー内容:[{e}]') + 'E-RESBK-01', RESBK_JP_NAME, f'[{object_name}] 電文データのバックアップに失敗しました ファイル名：[{target_object.upload_file_name}.json] エラー内容:[{e}]') # ③ CRM電文データバックアップ処理の終了ログを出力する logger.info(f'I-RESBK-03 [{object_name}] のCRM電文データバックアップ処理を終了します') diff --git a/ecs/crm-datafetch/src/controller.py b/ecs/crm-datafetch/src/controller.py index f9c87960..97c1f10e 100644 --- a/ecs/crm-datafetch/src/controller.py +++ b/ecs/crm-datafetch/src/controller.py @@ -152,7 +152,7 @@ def _fetch_crm_data_per_object(object_info: dict, execute_datetime: ExecuteDateT # 8. CRM電文データバックアップ処理を呼び出す logger.info( f'I-CTRL-11 [{target_object_name}] CRM電文データバックアップ処理呼び出し') - backup_crm_data_process(target_object_name, crm_data_response, execute_datetime) + backup_crm_data_process(target_object, crm_data_response, execute_datetime) # 9. CSV変換処理を呼び出す logger.info( diff --git a/ecs/crm-datafetch/tests/test_backup_crm_data_process.py b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py new file mode 100644 index 00000000..e476dce3 --- /dev/null +++ b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py @@ -0,0 +1,99 @@ +import json +from collections import OrderedDict +from unittest.mock import MagicMock, patch + +import pytest +from src.backup_crm_data_process import backup_crm_data_process +from src.config.objects import TargetObject +from src.error.exceptions import FileNotFoundException, InvalidConfigException +from src.system_var.constants import RESBK_JP_NAME +from src.util.execute_datetime import ExecuteDateTime + +from .test_utils.log_message import generate_log_message_tuple + + +class TestBackupCrmDataProcess: + + @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: + CRM電文データバックアップ処理が正常終了し、期待通りの結果となること + Arranges: + - prepare_bucketフィクスチャで、CRM電文データをバックアップするためのモックバケットを作る + - 作成したモックバケットを指すように環境変数を設定する + Expects: + - CRM電文データバックアップファイルがバケットに配置される + - CRM電文データバックアップ処理の仕様に沿った正常系ログが出力されること(デバッグログは除く) + """ + # Arrange + response_json = [ + OrderedDict([ + ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST001')])), + ('Id', 'TEST001'), + ('AccountNumber', 'test001'), + ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), + ('LastModifiedById', 1.234567E+6), + ('SystemModstamp', '2022-06-01T00:00:00.000+0000'), + ('IsDeleted', False) + ]), + OrderedDict([ + ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), + ('Id', 'TEST002'), + ('AccountNumber', 'test002'), + ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), + ('LastModifiedById', 1.234567E+6), + ('SystemModstamp', '2022-06-01T00:00:00.000+0000'), + ('IsDeleted', False) + ]), + OrderedDict([ + ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), + ('Id', 'TEST002'), + ('AccountNumber', 'test002'), + ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), + ('LastModifiedById', 1.234567E+6), + ('SystemModstamp', '2022-06-01T00:00:00.000+0000'), + ('IsDeleted', False) + ]), + ] + + 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.RESPONSE_JSON_BACKUP_FOLDER', 'response_json') + + # Act + backup_crm_data_process(target_object, response_json, execute_datetime) + + # Assert + + # ファイル確認 + actual = s3_client.get_object( + Bucket=bucket_name, Key=f'response_json/{execute_datetime.to_path()}/CRM_Account_{execute_datetime.format_date()}.json') + assert actual['Body'].read().decode('utf-8') == json.dumps(response_json) + + # ログの確認 + assert generate_log_message_tuple(log_message='I-RESBK-01 [Account] のCRM電文データバックアップ処理を開始します') in caplog.record_tuples + assert generate_log_message_tuple(log_message='I-RESBK-03 [Account] のCRM電文データバックアップ処理を終了します') in caplog.record_tuples From ef14595e25abfcaf6a0e5f4409c7ca56fc65d9a6 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 3/5] =?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 2ae615671a4c5f98c7e3f3ff6db05773f22c5c75 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 4/5] =?UTF-8?q?feat:=20=E3=83=86=E3=82=B9=E3=83=88?= =?UTF-8?q?=E8=BF=BD=E5=8A=A0=E9=80=94=E4=B8=AD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../tests/test_backup_crm_data_process.py | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/ecs/crm-datafetch/tests/test_backup_crm_data_process.py b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py index e476dce3..8028ebf0 100644 --- a/ecs/crm-datafetch/tests/test_backup_crm_data_process.py +++ b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py @@ -97,3 +97,127 @@ class TestBackupCrmDataProcess: # ログの確認 assert generate_log_message_tuple(log_message='I-RESBK-01 [Account] のCRM電文データバックアップ処理を開始します') in caplog.record_tuples assert generate_log_message_tuple(log_message='I-RESBK-03 [Account] のCRM電文データバックアップ処理を終了します') in caplog.record_tuples + + def test_call_depended_modules(self): + """ + Cases: + CRM電文データバックアップ処理内で依存しているモジュールが正しく呼ばれていること + Arranges: + - CRM電文データバックアップ処理の依存モジュールをモック化する + Expects: + - 依存しているモジュールが正しく呼ばれている + """ + + # Arrange + with patch('src.backup_crm_data_process.BackupBucket') as mock_backup_bucket, \ + patch('src.backup_crm_data_process.ExecuteDateTime') as mock_execute_datetime, \ + patch('src.backup_crm_data_process.TargetObject') as mock_target_object: + mock_backup_bucket_inst = mock_backup_bucket.return_value + mock_backup_bucket_inst.put_response_json.return_value = '' + mock_execute_inst = mock_execute_datetime.return_value + mock_execute_inst.to_path.return_value = '' + mock_target_inst = mock_target_object.return_value + mock_target_inst.upload_file_name.return_value = '' + # Act + backup_crm_data_process(mock_target_object, {}, mock_execute_datetime, ) + + # Assert + + assert mock_backup_bucket_inst.put_response_json.called is True + assert mock_execute_inst.to_path.called is True + assert mock_target_object.upload_file_name.called is True + + def test_raise_get_object_info(self, bucket_name, monkeypatch, caplog): + """ + Cases: + CRM_取得オブジェクト情報ファイルを取得できない場合、エラーが発生すること + Arranges: + - オブジェクト情報ファイル取得処理で例外が発生するようにする + Expects: + - 例外が発生する + - ファイルが読み込めないエラーが返却される + """ + + # Arrange + monkeypatch.setattr('src.backup_crm_data_process.OBJECT_INFO_FILENAME', 'crm_object_list_diff.json') + mock_config_bucket = MagicMock(side_effect=Exception('ファイル取得エラー')) + mock_json_parser = MagicMock(return_value={}) + mock_fetch_target_objects = MagicMock(return_value=None) + # Act + with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ + patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ + patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): + with pytest.raises(FileNotFoundException) as e: + backup_crm_data_process() + + # Assert + + assert mock_config_bucket.called is True + assert mock_json_parser.called is False + assert mock_fetch_target_objects.called is False + assert e.value.error_id == 'E-RESBK-01' + assert e.value.func_name == RESBK_JP_NAME + assert e.value.args[0] == f'CRM_取得オブジェクト情報ファイルが存在しません ファイル名：[crm_object_list_diff.json] エラー内容：[ファイル取得エラー]' + + def test_raise_parse_json_str(self, bucket_name, monkeypatch, caplog): + """ + Cases: + CRM_取得オブジェクト情報ファイルをパースできない場合、エラーが発生すること + Arranges: + - オブジェクト情報ファイルパース処理で例外が発生するようにする + Expects: + - 例外が発生する + - パースが失敗した旨、エラーメッセージが表示される + """ + + # Arrange + mock_config_bucket = MagicMock(return_value='') + mock_json_parser = MagicMock(side_effect=Exception('JSONパースエラー')) + mock_fetch_target_objects = MagicMock(return_value=None) + # Act + with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ + patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ + patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): + with pytest.raises(InvalidConfigException) as e: + backup_crm_data_process() + + # Assert + + assert mock_config_bucket.called is True + assert mock_json_parser.called is True + assert mock_fetch_target_objects.called is False + assert e.value.error_id == 'E-RESBK-02' + assert e.value.func_name == RESBK_JP_NAME + assert e.value.args[0] == f'CRM_取得オブジェクト情報ファイルのパースに失敗しました エラー内容：[JSONパースエラー]' + + def test_raise_check_objects_format(self, bucket_name, monkeypatch, caplog): + """ + Cases: + CRM_取得オブジェクト情報のキーobjectsの形式チェックが不正の場合、エラーが発生すること + Arranges: + - CRM_取得オブジェクト情報のキーobjectsの形式チェックで例外が発生するようにする + Expects: + - 例外が発生する + - 形式チェックが失敗した旨、エラーメッセージが表示される + """ + + # Arrange + monkeypatch.setattr('src.backup_crm_data_process.OBJECT_INFO_FILENAME', 'crm_object_list_diff.json') + mock_config_bucket = MagicMock(return_value='') + mock_json_parser = MagicMock(return_value={}) + mock_fetch_target_objects = MagicMock(side_effect=Exception('形式チェックエラー')) + # Act + with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ + patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ + patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): + with pytest.raises(InvalidConfigException) as e: + backup_crm_data_process() + + # Assert + + assert mock_config_bucket.called is True + assert mock_json_parser.called is True + assert mock_fetch_target_objects.called is True + assert e.value.error_id == 'E-RESBK-03' + assert e.value.func_name == RESBK_JP_NAME + assert e.value.args[0] == 'CRM_取得オブジェクト情報ファイルの形式チェックに失敗しました ファイル名：[crm_object_list_diff.json] エラー内容：[形式チェックエラー]' From b9e77ed045eb1c235ccb530315d89ddb16281cb7 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 5/5] =?UTF-8?q?feat:=E6=AE=8B=E3=82=8A=E3=81=AE=E3=83=86?= =?UTF-8?q?=E3=82=B9=E3=83=88=E3=82=82=E8=BF=BD=E5=8A=A0=E3=80=82=E8=A3=BD?= =?UTF-8?q?=E5=93=81=E3=82=B3=E3=83=BC=E3=83=89=E3=81=AE=E3=83=95=E3=82=A9?= =?UTF-8?q?=E3=83=BC=E3=83=9E=E3=83=83=E3=83=88=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/backup_crm_data_process.py | 5 +- .../tests/test_backup_crm_data_process.py | 156 +++++++----------- 2 files changed, 62 insertions(+), 99 deletions(-) diff --git a/ecs/crm-datafetch/src/backup_crm_data_process.py b/ecs/crm-datafetch/src/backup_crm_data_process.py index a5739e07..b37a8a50 100644 --- a/ecs/crm-datafetch/src/backup_crm_data_process.py +++ b/ecs/crm-datafetch/src/backup_crm_data_process.py @@ -33,7 +33,10 @@ def backup_crm_data_process(target_object: TargetObject, sf_object_dict: dict, e except Exception as e: raise FileUploadException( - 'E-RESBK-01', RESBK_JP_NAME, f'[{object_name}] 電文データのバックアップに失敗しました ファイル名：[{target_object.upload_file_name}.json] エラー内容:[{e}]') + 'E-RESBK-01', + RESBK_JP_NAME, + f'[{object_name}] 電文データのバックアップに失敗しました ファイル名：[{target_object.upload_file_name}.json] エラー内容:[{e}]' + ) # ③ CRM電文データバックアップ処理の終了ログを出力する logger.info(f'I-RESBK-03 [{object_name}] のCRM電文データバックアップ処理を終了します') diff --git a/ecs/crm-datafetch/tests/test_backup_crm_data_process.py b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py index 8028ebf0..9ad35d52 100644 --- a/ecs/crm-datafetch/tests/test_backup_crm_data_process.py +++ b/ecs/crm-datafetch/tests/test_backup_crm_data_process.py @@ -1,11 +1,11 @@ import json from collections import OrderedDict -from unittest.mock import MagicMock, patch +from unittest.mock import patch import pytest from src.backup_crm_data_process import backup_crm_data_process from src.config.objects import TargetObject -from src.error.exceptions import FileNotFoundException, InvalidConfigException +from src.error.exceptions import FileUploadException from src.system_var.constants import RESBK_JP_NAME from src.util.execute_datetime import ExecuteDateTime @@ -37,7 +37,8 @@ class TestBackupCrmDataProcess: # Arrange response_json = [ OrderedDict([ - ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST001')])), + ('attributes', OrderedDict([('type', 'Account'), + ('url', '/services/data/v1.0/sobjects/Account/TEST001')])), ('Id', 'TEST001'), ('AccountNumber', 'test001'), ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), @@ -46,7 +47,8 @@ class TestBackupCrmDataProcess: ('IsDeleted', False) ]), OrderedDict([ - ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), + ('attributes', OrderedDict([('type', 'Account'), + ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), ('Id', 'TEST002'), ('AccountNumber', 'test002'), ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), @@ -55,7 +57,8 @@ class TestBackupCrmDataProcess: ('IsDeleted', False) ]), OrderedDict([ - ('attributes', OrderedDict([('type', 'Account'), ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), + ('attributes', OrderedDict([('type', 'Account'), + ('url', '/services/data/v1.0/sobjects/Account/TEST002')])), ('Id', 'TEST002'), ('AccountNumber', 'test002'), ('LastModifiedDate', '2022-06-01T00:00:00.000+0000'), @@ -91,12 +94,15 @@ class TestBackupCrmDataProcess: # ファイル確認 actual = s3_client.get_object( - Bucket=bucket_name, Key=f'response_json/{execute_datetime.to_path()}/CRM_Account_{execute_datetime.format_date()}.json') + Bucket=bucket_name, + Key=f'response_json/{execute_datetime.to_path()}/CRM_Account_{execute_datetime.format_date()}.json') assert actual['Body'].read().decode('utf-8') == json.dumps(response_json) # ログの確認 - assert generate_log_message_tuple(log_message='I-RESBK-01 [Account] のCRM電文データバックアップ処理を開始します') in caplog.record_tuples - assert generate_log_message_tuple(log_message='I-RESBK-03 [Account] のCRM電文データバックアップ処理を終了します') in caplog.record_tuples + assert generate_log_message_tuple( + log_message='I-RESBK-01 [Account] のCRM電文データバックアップ処理を開始します') in caplog.record_tuples + assert generate_log_message_tuple( + log_message='I-RESBK-03 [Account] のCRM電文データバックアップ処理を終了します') in caplog.record_tuples def test_call_depended_modules(self): """ @@ -109,115 +115,69 @@ class TestBackupCrmDataProcess: """ # Arrange - with patch('src.backup_crm_data_process.BackupBucket') as mock_backup_bucket, \ - patch('src.backup_crm_data_process.ExecuteDateTime') as mock_execute_datetime, \ - patch('src.backup_crm_data_process.TargetObject') as mock_target_object: + 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_data_process.BackupBucket') as mock_backup_bucket: mock_backup_bucket_inst = mock_backup_bucket.return_value mock_backup_bucket_inst.put_response_json.return_value = '' - mock_execute_inst = mock_execute_datetime.return_value - mock_execute_inst.to_path.return_value = '' - mock_target_inst = mock_target_object.return_value - mock_target_inst.upload_file_name.return_value = '' # Act - backup_crm_data_process(mock_target_object, {}, mock_execute_datetime, ) + backup_crm_data_process(target_object, {}, execute_datetime) # Assert assert mock_backup_bucket_inst.put_response_json.called is True - assert mock_execute_inst.to_path.called is True - assert mock_target_object.upload_file_name.called is True - def test_raise_get_object_info(self, bucket_name, monkeypatch, caplog): + def test_raise_put_response_json(self, bucket_name, monkeypatch, caplog): """ Cases: - CRM_取得オブジェクト情報ファイルを取得できない場合、エラーが発生すること + CRM電文データをS3に配置できない場合、エラーが発生すること Arranges: - オブジェクト情報ファイル取得処理で例外が発生するようにする Expects: - 例外が発生する - - ファイルが読み込めないエラーが返却される + - ファイル登録できないエラーが返却される """ # Arrange - monkeypatch.setattr('src.backup_crm_data_process.OBJECT_INFO_FILENAME', 'crm_object_list_diff.json') - mock_config_bucket = MagicMock(side_effect=Exception('ファイル取得エラー')) - mock_json_parser = MagicMock(return_value={}) - mock_fetch_target_objects = MagicMock(return_value=None) - # Act - with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ - patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ - patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): - with pytest.raises(FileNotFoundException) as e: - backup_crm_data_process() + 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_data_process.BackupBucket') as mock_backup_bucket: + mock_backup_bucket_inst = mock_backup_bucket.return_value + mock_backup_bucket_inst.put_response_json.side_effect = Exception('登録エラー') + # Act + with pytest.raises(FileUploadException) as e: + backup_crm_data_process(target_object, {}, execute_datetime) # Assert - assert mock_config_bucket.called is True - assert mock_json_parser.called is False - assert mock_fetch_target_objects.called is False + assert mock_backup_bucket_inst.put_response_json.called is True assert e.value.error_id == 'E-RESBK-01' assert e.value.func_name == RESBK_JP_NAME - assert e.value.args[0] == f'CRM_取得オブジェクト情報ファイルが存在しません ファイル名：[crm_object_list_diff.json] エラー内容：[ファイル取得エラー]' - - def test_raise_parse_json_str(self, bucket_name, monkeypatch, caplog): - """ - Cases: - CRM_取得オブジェクト情報ファイルをパースできない場合、エラーが発生すること - Arranges: - - オブジェクト情報ファイルパース処理で例外が発生するようにする - Expects: - - 例外が発生する - - パースが失敗した旨、エラーメッセージが表示される - """ - - # Arrange - mock_config_bucket = MagicMock(return_value='') - mock_json_parser = MagicMock(side_effect=Exception('JSONパースエラー')) - mock_fetch_target_objects = MagicMock(return_value=None) - # Act - with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ - patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ - patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): - with pytest.raises(InvalidConfigException) as e: - backup_crm_data_process() - - # Assert - - assert mock_config_bucket.called is True - assert mock_json_parser.called is True - assert mock_fetch_target_objects.called is False - assert e.value.error_id == 'E-RESBK-02' - assert e.value.func_name == RESBK_JP_NAME - assert e.value.args[0] == f'CRM_取得オブジェクト情報ファイルのパースに失敗しました エラー内容：[JSONパースエラー]' - - def test_raise_check_objects_format(self, bucket_name, monkeypatch, caplog): - """ - Cases: - CRM_取得オブジェクト情報のキーobjectsの形式チェックが不正の場合、エラーが発生すること - Arranges: - - CRM_取得オブジェクト情報のキーobjectsの形式チェックで例外が発生するようにする - Expects: - - 例外が発生する - - 形式チェックが失敗した旨、エラーメッセージが表示される - """ - - # Arrange - monkeypatch.setattr('src.backup_crm_data_process.OBJECT_INFO_FILENAME', 'crm_object_list_diff.json') - mock_config_bucket = MagicMock(return_value='') - mock_json_parser = MagicMock(return_value={}) - mock_fetch_target_objects = MagicMock(side_effect=Exception('形式チェックエラー')) - # Act - with patch('src.aws.s3.ConfigBucket.get_object_info_file', mock_config_bucket), \ - patch('src.parser.json_parser.JsonParser.parse', mock_json_parser), \ - patch('src.config.objects.FetchTargetObjects.__init__', mock_fetch_target_objects): - with pytest.raises(InvalidConfigException) as e: - backup_crm_data_process() - - # Assert - - assert mock_config_bucket.called is True - assert mock_json_parser.called is True - assert mock_fetch_target_objects.called is True - assert e.value.error_id == 'E-RESBK-03' - assert e.value.func_name == RESBK_JP_NAME - assert e.value.args[0] == 'CRM_取得オブジェクト情報ファイルの形式チェックに失敗しました ファイル名：[crm_object_list_diff.json] エラー内容：[形式チェックエラー]' + assert e.value.args[0] == \ + f'[Account] 電文データのバックアップに失敗しました ファイル名：[CRM_Account_{execute_datetime.format_date()}.json] エラー内容:[登録エラー]'