-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create parseCliPullOtArguments helper
- Loading branch information
1 parent
71c3f02
commit 8ab4d29
Showing
3 changed files
with
118 additions
and
113 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import { logger } from '../logger'; | ||
| import colors from 'colors'; | ||
| import yargs from 'yargs-parser'; | ||
| import { OneTrustFileFormat, OneTrustPullResource } from '../enums'; | ||
|
|
||
| const VALID_RESOURCES = Object.values(OneTrustPullResource); | ||
| const VALID_FILE_FORMATS = Object.values(OneTrustFileFormat); | ||
|
|
||
| interface OneTrustCliArguments { | ||
| /** The name of the file to write the resources to without extensions */ | ||
| file: string; | ||
| /** The OneTrust hostname to send the requests to */ | ||
| hostname: string; | ||
| /** The OAuth Bearer token used to authenticate the requests */ | ||
| auth: string; | ||
| /** The resource to pull from OneTrust */ | ||
| resource: OneTrustPullResource; | ||
| /** Whether to enable debugging while reporting errors */ | ||
| debug: boolean; | ||
| /** The export format of the file where to save the resources */ | ||
| fileFormat: OneTrustFileFormat; | ||
| } | ||
|
|
||
| /** | ||
| * Parse the command line arguments | ||
| * | ||
| * @returns the parsed arguments | ||
| */ | ||
| export const parseCliPullOtArguments = (): OneTrustCliArguments => { | ||
| const { file, hostname, auth, resource, debug, fileFormat } = yargs( | ||
| process.argv.slice(2), | ||
| { | ||
| string: ['file', 'hostname', 'auth', 'resource', 'fileFormat'], | ||
| boolean: ['debug'], | ||
| default: { | ||
| resource: OneTrustPullResource.Assessments, | ||
| fileFormat: OneTrustFileFormat.Json, | ||
| }, | ||
| }, | ||
| ); | ||
|
|
||
| if (!file) { | ||
| logger.error( | ||
| colors.red( | ||
| 'Missing required parameter "file". e.g. --file=./oneTrustAssessments.json', | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
| const splitFile = file.split('.'); | ||
| if (splitFile.length < 2) { | ||
| logger.error( | ||
| colors.red( | ||
| 'The "file" parameter has an invalid format. Expected a path with extensions. e.g. --file=./pathToFile.json.', | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
| if (splitFile.at(-1) !== fileFormat) { | ||
| logger.error( | ||
| colors.red( | ||
| `The "file" and "fileFormat" parameters must specify the same format! Got file=${file} and fileFormat=${fileFormat}`, | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
|
|
||
| if (!hostname) { | ||
| logger.error( | ||
| colors.red( | ||
| 'Missing required parameter "hostname". e.g. --hostname=customer.my.onetrust.com', | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
|
|
||
| if (!auth) { | ||
| logger.error( | ||
| colors.red( | ||
| 'Missing required parameter "auth". e.g. --auth=$ONE_TRUST_AUTH_TOKEN', | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
| if (!VALID_RESOURCES.includes(resource)) { | ||
| logger.error( | ||
| colors.red( | ||
| `Received invalid resource value: "${resource}". Allowed: ${VALID_RESOURCES.join( | ||
| ',', | ||
| )}`, | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
| if (!VALID_FILE_FORMATS.includes(fileFormat)) { | ||
| logger.error( | ||
| colors.red( | ||
| `Received invalid fileFormat value: "${fileFormat}". Allowed: ${VALID_FILE_FORMATS.join( | ||
| ',', | ||
| )}`, | ||
| ), | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
|
|
||
| return { | ||
| file, | ||
| hostname, | ||
| auth, | ||
| resource, | ||
| debug: debug === undefined ? false : debug, | ||
| fileFormat, | ||
| }; | ||
| }; |