This repository has been archived by the owner on Oct 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 232
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[configuration-validation] convert to typescript (release 1.0.0) (#879)
- Loading branch information
1 parent
91963e5
commit a5880c6
Showing
13 changed files
with
3,829 additions
and
2,948 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 @@ | ||
| dist |
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 |
|---|---|---|
| @@ -1,11 +1,37 @@ | ||
| // https://eslint.org/docs/user-guide/configuring | ||
|
|
||
| module.exports = { | ||
| extends: [ 'eslint:recommended' ], | ||
| parser: "babel-eslint", | ||
| extends: [ | ||
| 'eslint:recommended', | ||
| 'plugin:@typescript-eslint/eslint-recommended', | ||
| 'plugin:@typescript-eslint/recommended', | ||
| 'plugin:jest/recommended', | ||
| ], | ||
| plugins: [ | ||
| '@typescript-eslint', | ||
| 'jest' | ||
| ], | ||
| parser: '@typescript-eslint/parser', | ||
| env: { | ||
| node: true, | ||
| es6: true, | ||
| jest: true | ||
| } | ||
| 'jest/globals': true | ||
| }, | ||
| overrides: [ | ||
| { | ||
| files: ['test/**/*.ts'], | ||
| rules: { | ||
| 'jest/no-disabled-tests': 'warn', | ||
| 'jest/no-focused-tests': 'error', | ||
| 'jest/no-identical-title': 'error', | ||
| 'jest/prefer-to-have-length': 'warn', | ||
| 'jest/valid-expect': 'error', | ||
| '@typescript-eslint/no-var-requires': 0, | ||
| '@typescript-eslint/explicit-function-return-type': 0, | ||
| '@typescript-eslint/camelcase': 0, | ||
| '@typescript-eslint/no-empty-function': 0, | ||
| '@typescript-eslint/no-explicit-any': 0 | ||
| } | ||
| } | ||
| ] | ||
| }; |
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,10 @@ | ||
| const presets = ['@babel/preset-env']; | ||
| const plugins = []; | ||
|
|
||
| // Process typescript when running in jest | ||
| if (process.env.NODE_ENV === 'test') { | ||
| presets.unshift('@babel/preset-typescript'); | ||
| plugins.unshift('@babel/plugin-transform-typescript'); | ||
| } | ||
|
|
||
| module.exports = { presets, plugins }; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| import { | ||
| assertIssuer, | ||
| assertClientId, | ||
| assertClientSecret, | ||
| assertRedirectUri, | ||
| assertAppBaseUrl, | ||
| } from '@okta/configuration-validation'; | ||
|
|
||
| const findDomainMessage = 'You can copy your domain from the Okta Developer ' + | ||
| 'Console. Follow these instructions to find it: https://bit.ly/finding-okta-domain'; | ||
|
|
||
| const findCredentialsMessage = 'You can copy it from the Okta Developer Console ' + | ||
| 'in the details for the Application you created. Follow these instructions to ' + | ||
| 'find it: https://bit.ly/finding-okta-app-credentials'; | ||
|
|
||
| describe('assertIssuer', () => { | ||
| it('should throw if no issuer is provided', () => { | ||
| const errorMsg = `Your Okta URL is missing. ${findDomainMessage}`; | ||
| expect(() => assertIssuer()).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an issuer that does not contain https is provided', () => { | ||
| const errorMsg = `Your Okta URL must start with https. Current value: http://foo.com. ${findDomainMessage}`; | ||
| expect(() => assertIssuer('http://foo.com')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should not throw if https issuer validation is skipped', () => { | ||
| jest.spyOn(console, 'warn').mockImplementation(() => {}); // silence for testing | ||
| const errorMsg = `Your Okta URL must start with https. Current value: http://foo.com. ${findDomainMessage}`; | ||
| expect(() => { | ||
| assertIssuer('http://foo.com', { | ||
| disableHttpsCheck: true | ||
| }) | ||
| }).not.toThrow(errorMsg); | ||
| /* eslint-disable-next-line no-console */ | ||
| expect(console.warn).toBeCalledWith('Warning: HTTPS check is disabled. This allows for insecure configurations and is NOT recommended for production use.'); | ||
| }); | ||
|
|
||
| it('should throw if an issuer matching {yourOktaDomain} is provided', () => { | ||
| const errorMsg = `Replace {yourOktaDomain} with your Okta domain. ${findDomainMessage}`; | ||
| expect(() => assertIssuer('https://{yourOktaDomain}')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an issuer matching -admin.okta.com is provided', () => { | ||
| const errorMsg = 'Your Okta domain should not contain -admin. Current value: ' + | ||
| `https://foo-admin.okta.com. ${findDomainMessage}`; | ||
| expect(() => assertIssuer('https://foo-admin.okta.com')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an issuer matching -admin.oktapreview.com is provided', () => { | ||
| const errorMsg = 'Your Okta domain should not contain -admin. Current value: ' + | ||
| `https://foo-admin.oktapreview.com. ${findDomainMessage}`; | ||
| expect(() => assertIssuer('https://foo-admin.oktapreview.com')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an issuer matching -admin.okta-emea.com is provided', () => { | ||
| const errorMsg = 'Your Okta domain should not contain -admin. Current value: ' + | ||
| `https://foo-admin.okta-emea.com. ${findDomainMessage}`; | ||
| expect(() => assertIssuer('https://foo-admin.okta-emea.com')).toThrow(errorMsg); | ||
| }); | ||
| }); | ||
|
|
||
| describe('assertClientId', () => { | ||
| it('should throw if the client_id is not provided', () => { | ||
| const errorMsg = `Your client ID is missing. ${findCredentialsMessage}`; | ||
| expect(() => assertClientId()).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if a client_id matching {clientId} is provided', () => { | ||
| const errorMsg = `Replace {clientId} with the client ID of your Application. ${findCredentialsMessage}`; | ||
| expect(() => assertClientId('{clientId}')).toThrow(errorMsg); | ||
| }); | ||
| }); | ||
|
|
||
| describe('assertClientSecret', () => { | ||
| it('should throw if the client_secret is not provided', () => { | ||
| const errorMsg = `Your client secret is missing. ${findCredentialsMessage}`; | ||
| expect(() => assertClientSecret()).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if a client_secret matching {clientSecret} is provided', () => { | ||
| const errorMsg = `Replace {clientSecret} with the client secret of your Application. ${findCredentialsMessage}`; | ||
| expect(() => assertClientSecret('{clientSecret}')).toThrow(errorMsg); | ||
| }); | ||
| }); | ||
|
|
||
| describe('assertRedirectUri', () => { | ||
| it('should throw if the redirect_uri is not provided', () => { | ||
| const errorMsg = 'Your redirect URI is missing.'; | ||
| expect(() => assertRedirectUri()).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if a redirect_uri matching {redirectUri} is provided', () => { | ||
| const errorMsg = 'Replace {redirectUri} with the redirect URI of your Application.' | ||
| expect(() => assertRedirectUri('{redirectUri}')).toThrow(errorMsg); | ||
| }); | ||
| }); | ||
|
|
||
| describe('assertAppBaseUrl', () => { | ||
| it('should throw if the appBaseUrl is not provided', () => { | ||
| const errorMsg = 'Your appBaseUrl is missing.'; | ||
| expect(() => assertAppBaseUrl()).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if a appBaseUrl matching {appBaseUrl} is provided', () => { | ||
| const errorMsg = 'Replace {appBaseUrl} with the base URL of your Application.' | ||
| expect(() => assertAppBaseUrl('{appBaseUrl}')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an appBaseUrl without a protocol is provided', () => { | ||
| const errorMsg = 'Your appBaseUrl must contain a protocol (e.g. https://). Current value: foo.example.com.'; | ||
| expect(() => assertAppBaseUrl('foo.example.com')).toThrow(errorMsg); | ||
| }); | ||
|
|
||
| it('should throw if an appBaseUrl that ends in a slash is provided', () => { | ||
| const errorMsg = `Your appBaseUrl must not end in a '/'. Current value: https://foo.example.com/.`; | ||
| expect(() => assertAppBaseUrl('https://foo.example.com/')).toThrow(errorMsg); | ||
| }); | ||
| }); |
Oops, something went wrong.