Refactor Mock and Test Setup #651
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated abi_crosswalk.json to include node 18 (current). - Added test coverage for cases of unsupported/unknown targets.
- Modified function signature. Instead of augmenting an object (side effect) the function now gets an options object and returns a configuration object. - Cleaned up of code auto used to extract bucket and region from s3 url. - Added comments. - Increased test coverage. - All tests pass.
- Modified versioning to add bucket name to hosted_path when s3ForcePathStyle is true. - Modified s3_setup to remove bucket name from prefix when s3ForcePathStyle is true. - Added test coverage for s3ForcePathStyle cases.
- mocking setup can be more easily used by automated tests and/or manually by developer. - mock modules moved to lib/mock. - mock modules are self contained and have a signature similar to that of other modules in the package. - simplified http mock to remove no longer needed interface. - modified http mock to support path style bucket access. - set http mock to work with default npg-mock-bucket bucket.
- separated s3 tests from build tests. - refactored fetch test and proxy-bcrypt test to work with refactored mock setup.
- set hosts of test apps to point to mock bucket. - added app1.1 - identical to app1 but using production and staging binary host option. - added app1.2 - identical to app1 but using explicit host, region, bucket options.
…is versa. Removed previous one.
This was referenced May 12, 2022
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| (uri) => { | ||
| const bucket = 'npg-mock-bucket'; | ||
| const mockDir = uri.indexOf(bucket) === -1 ? `${basePath}/${bucket}` : basePath; | ||
| const filepath = path.join(mockDir, uri.replace('%2B', '+')); |
Check failure
Code scanning / CodeQL
Incomplete string escaping or encoding High
| function http_mock() { | ||
| log.warn('mocking http requests to s3'); | ||
|
|
||
| const baseHostname = 's3.us-east-1.amazonaws.com'; |
Check failure
Code scanning / CodeQL
Incomplete regular expression for hostnames High
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This pull request refactors the S3 mocking setup (see: #540) simplifying implementation, separates the S3 tests from the build tests, introduces test apps using alternative bucket specification (see: #576) and production/staging hosts (see: #533) and enables easy switch between mock bucket and real bucket (given status of: #613).
This pull request comes "on top" of (i.e. includes changes from) #648, #649, #650.
Change
Code
lib/mock.npg-mock-bucketbucket.Testing
node_pre_gyp_mock_s3to true will run them against the mock (see: repo CI).node_pre_gyp_mock_s3.AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY.npm run bucket {name-of-your-us-east-1-bucket}node_pre_gyp_mock_s3to true.npm run bucketus-east-1also works but switch is more work.npm run coveragediffer depending on what bucket is used (real s3 or mock).Tests