A shared library to pull AWS CostUsage data #109
Conversation
|
This PR will trigger no release when merged. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| nock.cleanAll(); | ||
| }); | ||
| it('does not create a new instance if previously initialized', async () => { | ||
| const awsCostApiClient = AWSCostApiClient.createFrom({ log: console, region: 'us-east-1' }); |
Check failure
Code scanning / CodeQL
Property access on null or undefined Error test
| expect(awsCostApiClient).to.be.an.instanceof(AWSCostApiClient); | ||
| }); | ||
| it('verify input', async () => { | ||
| const awsCostApiClient = AWSCostApiClient.createFrom({ log: console, region: 'us-east-1' }); |
Check failure
Code scanning / CodeQL
Property access on null or undefined Error test
| 'AmortizedCost', | ||
| ], | ||
| }; | ||
| response = awsCostApiClient.getUsageCost(input); |
Check failure
Code scanning / CodeQL
Assignment to constant Error test
| 'AmortizedCost', | ||
| ], | ||
| }; | ||
| response = awsCostApiClient.getUsageCost(input); |
Check warning
Code scanning / CodeQL
Variable not declared before use Warning test
| 'AmortizedCost', | ||
| ], | ||
| }; | ||
| response = awsCostApiClient.getUsageCost(input); |
Check warning
Code scanning / CodeQL
Useless assignment to local variable Warning test
| const response = { | ||
| ResultsByTime: [ | ||
| { | ||
| TimePeriod: { | ||
| Start: '2021-01-01', | ||
| End: '2021-02-01', | ||
| }, | ||
| Total: { | ||
| AmortizedCost: { | ||
| Amount: '0.0000000000', | ||
| Unit: 'USD', | ||
| }, | ||
| }, | ||
| }, | ||
| ], | ||
| GroupDefinitions: [], | ||
| }; |
Check warning
Code scanning / CodeQL
Useless assignment to local variable Warning test
| * @returns {GetCostAndUsageResponse} | ||
| */ | ||
|
|
||
| async getCostUsageData(startDate, endDate, granularity, metrics, groupBy, filter) { |
There was a problem hiding this comment.
I think the required params here are only service, startDate and endDate. Rest of the params should be constant and handled internally.
An example API call could be like this:
const service = 'S3'; // service code would be better if possible
const startDate = '2024-01-01';
const endDate = '2024-01-31';
const usageCost = await getCostUsageData(service, startDate, endDate);
// example
console.log(`${service} used $${usageCost} in january 2023`);
// logs: "S3 used $12 in january 2023"| return client; | ||
| } | ||
|
|
||
| constructor(context) { |
There was a problem hiding this comment.
we have AWSCostApiClient.createFrom(context) which takes the helix universalcontext as param and knows about implementation of helix universalcontext.
constructor should not know about helix universalcontext. In this case it should be like:
AWSCostApiClient(region, credentials, log);| chai.use(chaiAsPromised); | ||
| const { expect } = chai; | ||
|
|
||
| describe('run aws api client', () => { |
There was a problem hiding this comment.
this test does not verify the actual result. We can mock the amazon api behind the service using nock. Example for that: https://github.com/adobe/spacecat-api-service/blob/main/test/support/sqs.test.js#L82
|
@sudo-buddy as a rule of thumb, we put shared code which is used by at least two different components into spacecat-shared. Since this logic will only be used by audit worker, we can completely skip creating a new package here and add the code in the cogs handler in audit worker directly |
|
closing in favor of adobe/spacecat-audit-worker#115 |
Please ensure your pull request adheres to the following guidelines:
Related Issues
Thanks for contributing!