GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — nativescript-cli/test/options.ts at main · NativeScript/nativescript-cli Expand file tree/ Copy pathoptions.tsMore file actions 567 lines (510 loc) · 18.7 KB / Copy pathoptions.tsFile metadata and controls567 lines (510 loc) · 18.7 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 import { Errors } from "../lib/common/errors"; import { Yok } from "../lib/common/yok"; import { assert } from "chai"; import { Options } from "../lib/options"; import { IOptions } from "../lib/declarations"; import { IInjector } from "../lib/common/definitions/yok"; import { IConfigurationSettings, ISettingsService, } from "../lib/common/declarations"; import { OptionType } from "../lib/common/enums"; import * as _ from "lodash"; let isExecutionStopped = false; let warnings: string[] = []; function createTestInjector(): IInjector { const testInjector = new Yok(); testInjector.register("staticConfig", { CLIENT_NAME: "", }); testInjector.register("hostInfo", {}); testInjector.register("settingsService", { setSettings: (settings: IConfigurationSettings): any => undefined, getProfileDir: () => "profileDir", }); testInjector.register("logger", { warn: (message: string): void => { warnings.push(message); }, }); return testInjector; } function createOptions(testInjector: IInjector): IOptions { const options = testInjector.resolve(Options); // Validation is triggered in options's constructor return options; } describe("options", () => { let testInjector: IInjector; beforeEach(() => { testInjector = createTestInjector(); const errors = new Errors(testInjector); errors.failWithHelp = <any>((message: string, ...args: any[]): void => { isExecutionStopped = true; }); errors.fail = <any>((message: string, ...args: any[]): void => { isExecutionStopped = true; }); testInjector.register("errors", errors); isExecutionStopped = false; warnings = []; // The assertions below describe the hard-fail behavior, which is opt-in // while validation is staged. The staging itself is covered separately. process.env.NS_STRICT_OPTIONS = "error"; }); afterEach(() => { delete process.env.NS_STRICT_OPTIONS; }); describe("validateOptions", () => { it("breaks execution when option is not valid", () => { process.argv.push("--pathr"); process.argv.push("incorrect argument"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("breaks execution when valid option does not have value", () => { process.argv.push("--path"); // If you do not pass value to an option, it's automatically set as true. const options = createOptions(testInjector); process.argv.pop(); options.validateOptions(); assert.isTrue(isExecutionStopped); }); it("breaks execution when valid dashed option passed without dashes does not have value", () => { process.argv.push("--keyStorePath"); // If you do not pass value to a string option, it's automatically set to "". const options = createOptions(testInjector); process.argv.pop(); options.validateOptions(); assert.isTrue(isExecutionStopped); }); it("breaks execution when valid dashed option does not have value", () => { process.argv.push("--key-store-path"); // If you do not pass value to an option, it's automatically set as true. const options = createOptions(testInjector); process.argv.pop(); options.validateOptions(); assert.isTrue(isExecutionStopped); }); it("does not break execution when valid option has correct value", () => { process.argv.push("--path"); process.argv.push("SomeDir"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("breaks execution when valid option has empty string value", () => { process.argv.push("--path"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("does not break execution when valid option has correct value", () => { process.argv.push("--config"); process.argv.push("SomeFilename"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("breaks execution when valid option has empty string value", () => { process.argv.push("--config"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("breaks execution when the timeout option has no value", () => { process.argv.push("--timeout"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("does not break execution when the timeout option has a value", () => { process.argv.push("--timeout"); process.argv.push("500"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("breaks execution when valid option has value with spaces only", () => { process.argv.push("--path"); process.argv.push(" "); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("breaks execution when shorthand option is not valid", () => { process.argv.push("-j"); process.argv.push("incorrect shorthand"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("does not break execution when valid shorthand option has correct value", () => { process.argv.push("-v"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.isTrue(options.version); }); // all numbers are changed to strings before calling validateOptions it("does not break execution when valid option has number value", () => { process.argv.push("--path"); process.argv.push("1"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("throws error when valid option has array value", () => { process.argv.push("--path"); process.argv.push("value 1"); process.argv.push("--path"); process.argv.push("value 2"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); process.argv.pop(); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("converts string value to array when option type is array", () => { const options: any = createOptions(testInjector); process.argv.push("--test1"); process.argv.push("value"); options.validateOptions({ test1: { type: OptionType.Array } }); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.deepStrictEqual(["value"], <any>options.argv.test1); }); it("does not break execution when valid commandSpecificOptions are passed", () => { process.argv.push("--test1"); process.argv.push("value"); const options = createOptions(testInjector); options.validateOptions({ test1: { type: OptionType.String, hasSensitiveValue: false }, }); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("does not break execution when valid commandSpecificOptions are passed and user specifies globally valid option", () => { const options = createOptions(testInjector); process.argv.push("--version"); options.validateOptions({ test1: { type: OptionType.String, hasSensitiveValue: false }, }); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("breaks execution when valid array option has value with length 0", () => { process.argv.push("--test1"); const options = createOptions(testInjector); options.validateOptions({ test1: { type: OptionType.Array, hasSensitiveValue: false }, }); process.argv.pop(); assert.isTrue(isExecutionStopped); }); describe("when commandSpecificOptions are passed", () => { it("breaks execution when commandSpecificOptions are passed and user tries to use invalid option", () => { process.argv.push("--invalidOption"); const options = testInjector.resolve(Options); options.validateOptions({ test1: { type: OptionType.String } }); process.argv.pop(); assert.isTrue(isExecutionStopped); }); it("does not break execution when commandSpecificOptions are passed and user tries to use option valid for CLI, but not for this command", () => { process.argv.push("--watch"); const options = testInjector.resolve(Options); options.validateOptions({ test1: { type: OptionType.String } }); process.argv.pop(); assert.isFalse(isExecutionStopped); }); it("uses profile-dir from yargs when it exists and commandSpecificOptions are passed", () => { const expectedProfileDir = "TestDir"; process.argv.push("--profile-dir"); process.argv.push(expectedProfileDir); const settingsService = testInjector.resolve<ISettingsService>("settingsService"); let valuePassedToSetSettings: string; settingsService.setSettings = ( settings: IConfigurationSettings, ): any => { valuePassedToSetSettings = settings.profileDir; }; settingsService.getProfileDir = () => valuePassedToSetSettings; const options = testInjector.resolve(Options); options.validateOptions({ test1: { type: OptionType.String } }); assert.equal(options.profileDir, expectedProfileDir); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); }); }); // when you pass --option with dash, yargs adds it to yargs.argv in two ways: // for ex. '$ appbuilder login --profile-dir "some dir"' will add profile dir to yargs.argv as: profileDir and profile-dir describe("validates dashed options correctly", () => { it("does not break execution when dashed option with single dash is passed", () => { process.argv.push("profile-dir"); process.argv.push("some dir"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse( isExecutionStopped, "Dashed options should be validated in specific way. Make sure validation allows yargs specific behavior:" + "Dashed options (profile-dir) are added to yargs.argv in two ways: profile-dir and profileDir", ); }); it("does not break execution when dashed option with two dashes is passed", () => { process.argv.push("key-store-path"); process.argv.push("some dir"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse( isExecutionStopped, "Dashed options should be validated in specific way. Make sure validation allows yargs specific behavior:" + "Dashed options (some-dashed-value) are added to yargs.argv in two ways: some-dashed-value and someDashedValue", ); }); it("does not break execution when dashed option with two dashes is passed", () => { process.argv.push("--special-dashed-v"); const options = createOptions(testInjector); options.validateOptions({ specialDashedV: { type: OptionType.Boolean, hasSensitiveValue: false, }, }); process.argv.pop(); assert.isFalse( isExecutionStopped, "Dashed options should be validated in specific way. Make sure validation allows yargs specific behavior:" + "Dashed options (special-dashed-v) are added to yargs.argv in two ways: special-dashed-v and specialDashedV", ); }); // vision-ng and friends are declared with a literal dashed key, so the // camelCase spelling yargs derives has no declaration of its own. _.each(["--vision-ng", "--visionNg"], (arg) => { it(`does not break execution when ${arg} is passed`, () => { process.argv.push(arg); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.isEmpty(warnings); }); }); }); describe("does not report valid options", () => { it("accepts a negated declared boolean", () => { process.argv.push("--no-hmr"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.isEmpty(warnings); assert.isFalse(<boolean>options.argv.hmr); }); it("accepts dot-notation values of an object option", () => { process.argv.push("--env.production"); process.argv.push("--env.sourceMap"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.isEmpty(warnings); assert.deepStrictEqual(options.argv.env, { production: true, sourceMap: true, }); }); }); describe("staged reporting", () => { it("warns instead of failing when an option is not supported", () => { delete process.env.NS_STRICT_OPTIONS; process.argv.push("--unknownOption"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.lengthOf(warnings, 1); assert.include(warnings[0], "'unknownOption' is not supported"); assert.include(warnings[0], "NS_STRICT_OPTIONS=error"); }); it("fails when an option is not supported and NS_STRICT_OPTIONS=error", () => { process.env.NS_STRICT_OPTIONS = "error"; process.argv.push("--unknownOption"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isTrue(isExecutionStopped); assert.isEmpty(warnings); }); it("warns instead of failing when a string option has no value", () => { delete process.env.NS_STRICT_OPTIONS; process.argv.push("--path"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.isFalse(isExecutionStopped); assert.lengthOf(warnings, 1); assert.include(warnings[0], "'path' requires non-empty value"); }); it("reports an undeclared negated flag under the spelling that was used", () => { delete process.env.NS_STRICT_OPTIONS; process.argv.push("--no-something"); const options = createOptions(testInjector); options.validateOptions(); process.argv.pop(); assert.lengthOf(warnings, 1); assert.include(warnings[0], "'no-something' is not supported"); }); }); }); describe("setupOptions", () => { const testCasesExpectingToThrow = [ { name: "--release --hmr", args: ["--release", "--hmr"], expectedError: "The options --release and --hmr cannot be used simultaneously.", }, ]; _.each(testCasesExpectingToThrow, (testCase) => { it(`should fail when ${testCase.name}`, () => { let actualError = null; const errors = testInjector.resolve("errors"); errors.fail = (error: string) => (actualError = error); errors.failWithHelp = (error: string) => (actualError = error); (testCase.args || []).forEach((arg) => process.argv.push(arg)); const options: any = createOptions(testInjector); options.setupOptions(null); (testCase.args || []).forEach((arg) => process.argv.pop()); assert.deepStrictEqual(actualError, testCase.expectedError); }); }); describe("hmr option", () => { const testCases = [ { name: "should set hmr to true by default", expectedHmrValue: true, }, { name: "should set hmr to false when --no-hmr is provided", args: ["--no-hmr"], expectedHmrValue: false, }, { name: "should set hmr to false when provided through dashed options from command", commandSpecificDashedOptions: { hmr: { type: OptionType.Boolean, default: false, hasSensitiveValue: false, }, }, expectedHmrValue: false, }, { name: "should set hmr to false by default when --release option is provided", args: ["--release"], expectedHmrValue: false, }, { name: "should set hmr to false by default when --debug-brk option is provided", args: ["--debugBrk"], expectedHmrValue: false, }, ]; _.each(testCases, (testCase) => { it(testCase.name, () => { (testCase.args || []).forEach((arg) => process.argv.push(arg)); const options: any = createOptions(testInjector); options.setupOptions(testCase.commandSpecificDashedOptions); assert.equal(testCase.expectedHmrValue, options.argv.hmr); assert.isFalse(isExecutionStopped); (testCase.args || []).forEach((arg) => process.argv.pop()); }); }); }); }); }); function createOptionsWithProfileDir(defaultProfileDir?: string): IOptions { const testInjector = new Yok(); testInjector.register("errors", {}); testInjector.register("staticConfig", {}); testInjector.register("logger", { warn: (): void => undefined }); let valuePassedToSetSettings: string; testInjector.register("settingsService", { setSettings: (settings: IConfigurationSettings): any => { valuePassedToSetSettings = settings.profileDir; }, getProfileDir: () => valuePassedToSetSettings || defaultProfileDir, }); const options = testInjector.resolve(Options); return options; } describe("common options profile-dir tests", () => { describe("setProfileDir", () => { it("uses profile-dir from yargs when it exists", () => { const expectedProfileDir = "TestDir"; process.argv.push("--profile-dir"); process.argv.push(expectedProfileDir); const options = createOptionsWithProfileDir(); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.equal(options.profileDir, expectedProfileDir); }); it("sets default profile-dir when it is not passed on command line", () => { const profileDir = "TestDir"; const options = createOptionsWithProfileDir(profileDir); options.validateOptions(); assert.equal(options.profileDir, profileDir); }); it("uses profile-dir from yargs when it exists even if default one has non-empty value", () => { const expectedProfileDir = "TestDir"; process.argv.push("--profile-dir"); process.argv.push(expectedProfileDir); const options = createOptionsWithProfileDir(); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.equal(options.profileDir, expectedProfileDir); }); it("uses profileDir from yargs when it exists", () => { const expectedProfileDir = "TestDir"; process.argv.push("--profileDir"); process.argv.push(expectedProfileDir); const options = createOptionsWithProfileDir(); options.validateOptions(); process.argv.pop(); process.argv.pop(); assert.equal(options.profileDir, expectedProfileDir); }); }); }); |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |