|
| 1 | + |
| 2 | +import unittest.mock |
| 3 | + |
| 4 | +import pytest |
| 5 | + |
| 6 | +from terrareg.analytics import AnalyticsEngine |
| 7 | +import terrareg.errors |
| 8 | +from test.unit.terrareg import ( |
| 9 | + mock_models, |
| 10 | + setup_test_data, TerraregUnitTest |
| 11 | +) |
| 12 | +import terrareg.models |
| 13 | +import terrareg.config |
| 14 | +from test import client, mock_create_audit_event |
| 15 | +from . import mock_record_module_version_download |
| 16 | + |
| 17 | + |
| 18 | +class TestApiModuleVersionSourceDownload(TerraregUnitTest): |
| 19 | + """Test ApiModuleVersionDownload resource.""" |
| 20 | + |
| 21 | + # '/v1/terrareg/modules/<string:namespace>/<string:name>/<string:provider>/<string:version>/source.zip', |
| 22 | + # '/v1/terrareg/modules/<string:namespace>/<string:name>/<string:provider>/<string:version>/<string:presign>/source.zip' |
| 23 | + |
| 24 | + @setup_test_data() |
| 25 | + def test_disable_module_hosting(self, client, mock_models, mock_record_module_version_download): |
| 26 | + """Test module version download with invalid analytics token""" |
| 27 | + with unittest.mock.patch('terrareg.config.Config.ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode.DISALLOW): |
| 28 | + res = client.get(f"/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip") |
| 29 | + assert res.status_code == 500 |
| 30 | + assert res.json == {'message': 'Module hosting is disbaled'} |
| 31 | + |
| 32 | + @setup_test_data() |
| 33 | + @pytest.mark.parametrize('namespace, module, provider, version, error', [ |
| 34 | + # Non-existent version |
| 35 | + ('testnamespace', 'testmodulename', 'testprovider', '2.4.2', 'Module version does not exist'), |
| 36 | + ('testnamespace', 'testmodulename', 'nonexistent', '2.4.2', 'Module provider does not exist'), |
| 37 | + ('testnamespace', 'nonexistent', 'nonexistent', '2.4.2', 'Module provider does not exist'), |
| 38 | + ('nonexistent', 'nonexistent', 'nonexistent', '2.4.2', 'Namespace does not exist'), |
| 39 | + ]) |
| 40 | + def test_non_existent(self, namespace, module, provider, version, error, client, mock_models): |
| 41 | + """Test module version download with invalid analytics token""" |
| 42 | + with unittest.mock.patch('terrareg.config.Config.ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode.ENFORCE): |
| 43 | + res = client.get(f"/v1/terrareg/modules/{namespace}/{module}/{provider}/{version}/source.zip") |
| 44 | + assert res.status_code == 400 |
| 45 | + assert res.json == {'message': error} |
| 46 | + |
| 47 | + @setup_test_data() |
| 48 | + @pytest.mark.parametrize('url, expected_presign_key', [ |
| 49 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip', None), |
| 50 | +
|
| 51 | + # Pre-sign key in URL |
| 52 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/unittest-presign-key/source.zip', 'unittest-presign-key'), |
| 53 | +
|
| 54 | + # Presign key in params |
| 55 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip?presign=unittest-presign-key', 'unittest-presign-key'), |
| 56 | + ]) |
| 57 | + def test_invalid_presign_key(self, url, expected_presign_key, client, mock_models): |
| 58 | + """Ensure invalid pre-sign key throws an error""" |
| 59 | + def raise_exception(*args, **kwargs): |
| 60 | + raise terrareg.errors.InvalidPresignedUrlKeyError('Invalid pre-sign key') |
| 61 | + |
| 62 | + mock_validate_presigned_key = unittest.mock.MagicMock(side_effect=raise_exception) |
| 63 | + with unittest.mock.patch('terrareg.config.Config.ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode.ALLOW), \ |
| 64 | + unittest.mock.patch('terrareg.config.Config.ALLOW_UNAUTHENTICATED_ACCESS', False), \ |
| 65 | + unittest.mock.patch('terrareg.presigned_url.TerraformSourcePresignedUrl.validate_presigned_key', mock_validate_presigned_key): |
| 66 | + res = client.get(url) |
| 67 | + assert res.status_code == 403 |
| 68 | + assert res.json == {'message': 'Invalid pre-sign key'} |
| 69 | + |
| 70 | + mock_validate_presigned_key.assert_called_once_with(url='/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1', payload=expected_presign_key) |
| 71 | + |
| 72 | + @setup_test_data() |
| 73 | + @pytest.mark.parametrize('url, expected_presign_key', [ |
| 74 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip', None), |
| 75 | +
|
| 76 | + # Pre-sign key in URL |
| 77 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/unittest-presign-key/source.zip', 'unittest-presign-key'), |
| 78 | +
|
| 79 | + # Presign key in params |
| 80 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip?presign=unittest-presign-key', 'unittest-presign-key'), |
| 81 | + ]) |
| 82 | + def test_presign_validation_disabled(self, url, expected_presign_key, client, mock_models): |
| 83 | + """Ensure pre-sign validation is not performed when unauthenticated access is allowed""" |
| 84 | + def raise_exception(*args, **kwargs): |
| 85 | + raise terrareg.errors.InvalidPresignedUrlKeyError('Invalid pre-sign key') |
| 86 | + |
| 87 | + mock_get_file_storage = unittest.mock.MagicMock() |
| 88 | + mock_send_file = unittest.mock.MagicMock(return_value="UNIT TEST BINARY OUTPUT") |
| 89 | + |
| 90 | + mock_validate_presigned_key = unittest.mock.MagicMock(side_effect=raise_exception) |
| 91 | + with unittest.mock.patch('terrareg.config.Config.ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode.ALLOW), \ |
| 92 | + unittest.mock.patch('terrareg.config.Config.ALLOW_UNAUTHENTICATED_ACCESS', True), \ |
| 93 | + unittest.mock.patch('terrareg.presigned_url.TerraformSourcePresignedUrl.validate_presigned_key', mock_validate_presigned_key), \ |
| 94 | + unittest.mock.patch('flask.send_file', mock_send_file), \ |
| 95 | + unittest.mock.patch('terrareg.file_storage.FileStorageFactory.get_file_storage', mock_get_file_storage): |
| 96 | + res = client.get(url) |
| 97 | + |
| 98 | + assert res.status_code == 200 |
| 99 | + assert res.json == "UNIT TEST BINARY OUTPUT" |
| 100 | + |
| 101 | + mock_validate_presigned_key.assert_not_called() |
| 102 | + |
| 103 | + @setup_test_data() |
| 104 | + @pytest.mark.parametrize('url, allow_unauthenticated_access', [ |
| 105 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip', True), |
| 106 | +
|
| 107 | + # Pre-sign key in URL |
| 108 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/unittest-presign-key/source.zip', False), |
| 109 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/unittest-presign-key/source.zip', True), |
| 110 | +
|
| 111 | + # Presign key in params |
| 112 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip?presign=unittest-presign-key', False), |
| 113 | + ('/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip?presign=unittest-presign-key', True), |
| 114 | + ]) |
| 115 | + def test_send_file(self, url, allow_unauthenticated_access, client, mock_models): |
| 116 | + """Ensure send file and file storage is handled correctly""" |
| 117 | + mock_file_storage = unittest.mock.MagicMock() |
| 118 | + mock_get_file_storage = unittest.mock.MagicMock(return_value=mock_file_storage) |
| 119 | + mock_read_file_response = unittest.mock.MagicMock() |
| 120 | + mock_read_file = unittest.mock.MagicMock(return_value=mock_read_file_response) |
| 121 | + mock_file_storage.read_file = mock_read_file |
| 122 | + |
| 123 | + mock_validate_presigned_key = unittest.mock.MagicMock() |
| 124 | + |
| 125 | + mock_send_file = unittest.mock.MagicMock(return_value="UNIT TEST BINARY OUTPUT") |
| 126 | + |
| 127 | + with unittest.mock.patch('terrareg.config.Config.ALLOW_MODULE_HOSTING', terrareg.config.ModuleHostingMode.ALLOW), \ |
| 128 | + unittest.mock.patch('terrareg.config.Config.ALLOW_UNAUTHENTICATED_ACCESS', allow_unauthenticated_access), \ |
| 129 | + unittest.mock.patch('flask.send_file', mock_send_file), \ |
| 130 | + unittest.mock.patch('terrareg.presigned_url.TerraformSourcePresignedUrl.validate_presigned_key', mock_validate_presigned_key), \ |
| 131 | + unittest.mock.patch('terrareg.file_storage.FileStorageFactory.get_file_storage', mock_get_file_storage): |
| 132 | + res = client.get(url) |
| 133 | + |
| 134 | + assert res.status_code == 200 |
| 135 | + assert res.json == "UNIT TEST BINARY OUTPUT" |
| 136 | + |
| 137 | + mock_get_file_storage.assert_called_once() |
| 138 | + mock_read_file.assert_called_once_with('/modules/testnamespace/testmodulename/testprovider/2.4.1/source.zip', bytes_mode=True) |
| 139 | + mock_send_file.assert_called_once_with(mock_read_file_response, download_name='source.zip', mimetype='application/zip') |
| 140 | + |
| 141 | + if not allow_unauthenticated_access: |
| 142 | + mock_validate_presigned_key.assert_called_once_with(url='/v1/terrareg/modules/testnamespace/testmodulename/testprovider/2.4.1', payload='unittest-presign-key') |
| 143 | + else: |
| 144 | + mock_validate_presigned_key.assert_not_called() |
0 commit comments