-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1565 from contentstack/test/dx-1203-test-cases-ra…
…te-limit-command dx | 1203 test cases rate limit command
- Loading branch information
Showing
5 changed files
with
238 additions
and
4 deletions.
There are no files selected for viewing
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
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
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
178 changes: 178 additions & 0 deletions
178
packages/contentstack-config/test/unit/commands/rate-limit.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| import { expect } from 'chai'; | ||
| import { stub, restore } from 'sinon'; // Import restore for cleaning up | ||
| import { cliux, configHandler, isAuthenticated } from '@contentstack/cli-utilities'; | ||
| import SetRateLimitCommand from '../../../src/commands/config/set/rate-limit'; | ||
| import GetRateLimitCommand from '../../../src/commands/config/get/rate-limit'; | ||
| import RemoveRateLimitCommand from '../../../src/commands/config/remove/rate-limit'; | ||
| import { askOrgID } from '../../../src/utils/interactive'; | ||
| import { RateLimitHandler } from '../../../src/utils/rate-limit-handler'; | ||
| import { defaultRalteLimitConfig } from '../../../src/utils/common-utilities'; | ||
|
|
||
| describe('Rate Limit Commands', () => { | ||
| let originalCliuxError: typeof cliux.error; | ||
| let originalCliuxPrint: typeof cliux.print; | ||
| let originalIsAuthenticated: () => boolean; | ||
| let errorMessage: any; | ||
| let printMessage: any; | ||
| let authenticated = isAuthenticated; | ||
| let rateLimitHandler: RateLimitHandler; | ||
| let mockClient: any; | ||
|
|
||
| beforeEach(() => { | ||
| originalCliuxError = cliux.error; | ||
| originalCliuxPrint = cliux.print; | ||
| originalIsAuthenticated = isAuthenticated; | ||
|
|
||
| cliux.error = (message: string) => { | ||
| errorMessage = message; | ||
| }; | ||
| cliux.print = (message: string) => { | ||
| printMessage = message; | ||
| }; | ||
| rateLimitHandler = new RateLimitHandler(); | ||
| mockClient = { | ||
| organization: stub().returns({ | ||
| fetch: stub().resolves({ plan: { features: [{ uid: 'getLimit' }, { uid: 'bulkLimit' }] } }), | ||
| }), | ||
| }; | ||
| rateLimitHandler.setClient(mockClient); | ||
| restore(); | ||
|
|
||
| restore(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| cliux.error = originalCliuxError; | ||
| cliux.print = originalCliuxPrint; | ||
| authenticated = originalIsAuthenticated; | ||
| }); | ||
|
|
||
| describe('Set Rate Limit Command', () => { | ||
| it('Set Rate Limit: with all flags, should be successful', async () => { | ||
| const stub1 = stub(SetRateLimitCommand.prototype, 'run').resolves(); | ||
| const args = ['--org', 'test-org-id', '--utilize', '70,80', '--limit-name', 'getLimit,bulkLimit']; | ||
| await SetRateLimitCommand.run(args); | ||
| expect(stub1.calledOnce).to.be.true; | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should handle invalid utilization percentages', async () => { | ||
| const args = ['--org', 'test-org-id', '--utilize', '150', '--limit-name', 'getLimit']; | ||
| await SetRateLimitCommand.run(args); | ||
| expect(errorMessage).to.equal('Utilize percentages must be numbers between 0 and 100.'); | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should handle mismatch between utilize percentages and limit names', async () => { | ||
| const args = ['--org', 'test-org-id', '--utilize', '70', '--limit-name', 'getLimit,postLimit']; | ||
| await SetRateLimitCommand.run(args); | ||
| expect(errorMessage).to.equal( | ||
| 'The number of utilization percentages must match the number of limit names provided.', | ||
| ); | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should handle invalid number of limit names', async () => { | ||
| const args = ['--org', 'test-org-id', '--utilize', '70,80', '--limit-name', 'getLimit']; | ||
| await SetRateLimitCommand.run(args); | ||
| expect(errorMessage).to.equal( | ||
| 'The number of utilization percentages must match the number of limit names provided.', | ||
| ); | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should prompt for the organization UID', async () => { | ||
| const inquireStub = stub(cliux, 'inquire').resolves('test-org-id'); | ||
| const orgID = await askOrgID(); | ||
| expect(orgID).to.equal('test-org-id'); | ||
| inquireStub.restore(); | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should handle API client failure gracefully', async () => { | ||
| const handler = new RateLimitHandler(); | ||
| handler.setClient({ | ||
| organization: () => { | ||
| throw new Error('Client Error'); | ||
| }, | ||
| }); | ||
| const config = { org: 'test-org-id', utilize: ['70'], 'limit-name': ['getLimit'] }; | ||
| await handler.setRateLimit(config); | ||
| expect(errorMessage).to.include('Error: Unable to set the rate limit'); | ||
| }); | ||
|
|
||
| it('Set Rate Limit: should handle unauthenticated user', async () => { | ||
| const isAuthenticatedStub = stub().returns(false); | ||
| authenticated = isAuthenticatedStub; | ||
| const args = ['--org', 'test-org-id', '--utilize', '70,80', '--limit-name', 'getLimit,bulkLimit']; | ||
| try { | ||
| await SetRateLimitCommand.run(args); | ||
| } catch (error) { | ||
| expect(errorMessage).to.equal('You are not logged in. Please login with command $ csdx auth:login'); | ||
| expect(error?.code).to.equal(1); | ||
| } | ||
| }); | ||
| it('should set default rate limit for organization', async () => { | ||
| const config = { org: 'test-org-id', default: true }; | ||
| await rateLimitHandler.setRateLimit(config); | ||
| const rateLimit = configHandler.get('rateLimit'); | ||
| expect(rateLimit['test-org-id']).to.deep.equal(defaultRalteLimitConfig); | ||
| }); | ||
|
|
||
| it('should set rate limit when only utilization percentages are provided', async () => { | ||
| const config = { | ||
| org: 'test-org-id', | ||
| utilize: ['70'], | ||
| 'limit-name': ['getLimit'], | ||
| }; | ||
| await rateLimitHandler.setRateLimit(config); | ||
| const rateLimit = configHandler.get('rateLimit'); | ||
| expect(rateLimit['test-org-id']['getLimit'].utilize).to.equal(70); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Get Rate Limit Command', () => { | ||
| const rateLimit = { | ||
| 'test-org-id': { | ||
| getLimit: { value: 10, utilize: 70 }, | ||
| bulkLimit: { value: 1, utilize: 80 }, | ||
| }, | ||
| }; | ||
|
|
||
| it('Get Rate Limit: should print the rate limit for the given organization', async () => { | ||
| configHandler.set('rateLimit', rateLimit); | ||
| await GetRateLimitCommand.run(['--org', 'test-org-id']); | ||
| expect(printMessage).to.include(' test-org-id 10(70%) 0 1(80%) '); | ||
| }); | ||
|
|
||
| it('Get Rate Limit: should throw an error if the organization is not found', async () => { | ||
| configHandler.set('rateLimit', {}); | ||
| try { | ||
| await GetRateLimitCommand.run(['--org', 'non-existent-org']); | ||
| } catch (error) { | ||
| expect(errorMessage).to.equal('Error: Organization not found'); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| describe('Remove Rate Limit Command', () => { | ||
| const rateLimit = { | ||
| 'test-org-id': { | ||
| getLimit: { value: 10, utilize: 70 }, | ||
| bulkLimit: { value: 1, utilize: 80 }, | ||
| }, | ||
| }; | ||
|
|
||
| it('Remove Rate Limit: should remove the rate limit for the given organization', async () => { | ||
| configHandler.set('rateLimit', rateLimit); | ||
| await RemoveRateLimitCommand.run(['--org', 'test-org-id']); | ||
| const updatedRateLimit = configHandler.get('rateLimit'); | ||
| expect(updatedRateLimit['test-org-id']).to.be.undefined; | ||
| expect(printMessage).to.equal('Rate limit entry for organization UID test-org-id has been removed.'); | ||
| }); | ||
|
|
||
| it('Remove Rate Limit: should throw an error if the organization is not found', async () => { | ||
| configHandler.set('rateLimit', {}); | ||
| try { | ||
| await RemoveRateLimitCommand.run(['--org', 'non-existent-org']); | ||
| } catch (error) { | ||
| expect(errorMessage).to.equal('Error: Organization not found'); | ||
| } | ||
| }); | ||
| }); | ||
| }); |
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