v4.0.0
=====================================================================
Big day! V4 is finally live. This INCLUDES some BREAKING CHANGES to ZSH
TYPE scwrypts! Please refer to the readme for upgrade details
(more specifically docs/upgrade/v3-to-v4.md)
Upgrade is SUPER EASY, so please take the time to do so.
--- New Features ----------------------------------------------------
- zsh type scwrypts have an upgraded runstring to improve context setup
and simplicity to the scwrypt-writer
- scwrypts now publishes the package (scwrypts) to PyPi; this provides a
simple way to invoke scwrypts from python-based environments as well
as the entire scwrypts python library suite
pip install scwrypts
- scwrypts now publishes the package (scwrypts) to npm; this provides a
simple way to invoke scwrypts from nodesjs environments
npm install scwrypts
--- Bug Fixes -------------------------------------------------------
- scwrypts runner prompts which use the zshbuiltin "read" now
appropriately read input from tty, pipe, files, and user input
- virtualenv refresh now loads and prepares the scwrypts virtual
environments correctly
--- Changes ---------------------------------------------------------
- created the (-v, --log-level) scwrypts arguments as improvements of
and replacements to the --verbose and --no-log flags
- (-n) is now an alias for (--log-level 0)
- (--no-log) is the same as (-n) for compatibility, but will be removed in 4.2
- zsh/lib/utils/io print functions now *interact with log-level* various
log levels will now only display the appropriate console prints for
the specified log level
- zsh/lib/utils/io:INFO has been renamed to DEBUG to align with
log-level output; please use DEBUG for debug messages and REMINDER for
important user messages
- created zsh/lib/utils/io:FZF_USER_INPUT as a *drop-in replacement* for
the confusing FZF_HEAD and FZF_TAIL commands. Update by literally
changing any instances of FZF_HEAD or FZF_TAIL with FZF_USER_INPUT
- FZF_HEAD and FZF_TAIL will be removed in 4.2
- zsh/lib/utils/io:READ (and other zshbuiltin/read-based prompts) now
accept a --force-user-input flag in case important checks should
require an admin's approval. This flag will ensure that piped input
and the `scwrypts -y` flag are ignored for the single prompt.
- zsh/lib/utils/color has been updated to use color names which match
the ANSI color names
- zsh/hello-world has been reduced to a minimal example; this is to
emphasize ease-of-use with v4
- zsh/sanity-check is a scwrypts/run testing helper and detailed
starting reference (helpful since hello-world is now minimal)
- various refactor, updates, and improvements to the scwrypts runner
- migrated all zsh scwrypts and plugins to use v4 runner syntax
- zsh
- plugins/kubectl
- plugins/ci
- refactored py/lib into py/lib/scwrypts (PyPi)
This commit is contained in:
155
zx/lib/src/scwrypts/scwrypts.test.ts
Normal file
155
zx/lib/src/scwrypts/scwrypts.test.ts
Normal file
@ -0,0 +1,155 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { describe, expect, test, beforeEach, jest } from '@jest/globals';
|
||||
import { v4 as uuid } from 'uuid';
|
||||
|
||||
import { execa } from 'execa';
|
||||
import * as Module_getScwryptsLookup from './get-scwrypts-lookup.js';
|
||||
import * as Module_parseCLIArgs from './parse-cli-args.js';
|
||||
import { ScwryptsLogLevel } from './types.js';
|
||||
|
||||
import { scwrypts } from './scwrypts.js';
|
||||
|
||||
jest.mock('execa', () => ({
|
||||
execa: jest.fn(() => Promise.resolve()),
|
||||
}));
|
||||
|
||||
const env = process.env;
|
||||
beforeEach(() => {});
|
||||
|
||||
let sample: any;
|
||||
beforeEach(() => {
|
||||
sample = {
|
||||
options: {
|
||||
name: uuid(),
|
||||
group: uuid(),
|
||||
type: uuid(),
|
||||
patterns: [uuid(), uuid(), uuid()],
|
||||
log_level: Math.floor(Math.random() * Object.keys(ScwryptsLogLevel).length),
|
||||
args: uuid(),
|
||||
},
|
||||
lookup: {
|
||||
exact: {
|
||||
method: 'exact',
|
||||
name: uuid(),
|
||||
group: uuid(),
|
||||
type: uuid(),
|
||||
},
|
||||
patterns: {
|
||||
method: 'patterns',
|
||||
patterns: [uuid(), uuid(), uuid()],
|
||||
},
|
||||
},
|
||||
env: {
|
||||
SCWRYPTS_EXECUTABLE: uuid(),
|
||||
},
|
||||
parsedCLIArgs: [uuid(), uuid(), uuid()],
|
||||
spy: {},
|
||||
};
|
||||
|
||||
sample.spy.getScwryptsLookup = jest.spyOn(Module_getScwryptsLookup, 'getScwryptsLookup');
|
||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
|
||||
|
||||
sample.spy.parseCLIArgs = jest.spyOn(Module_parseCLIArgs, 'parseCLIArgs');
|
||||
sample.spy.parseCLIArgs.mockReturnValue(sample.parsedCLIArgs);
|
||||
|
||||
jest.resetModules();
|
||||
process.env = {
|
||||
...env,
|
||||
...sample.env,
|
||||
};
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
process.env = { ...env };
|
||||
});
|
||||
|
||||
describe('exact lookup', () => {
|
||||
beforeEach(async () => {
|
||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
|
||||
await scwrypts(sample.options);
|
||||
});
|
||||
|
||||
test('gets the correct lookup', () => {
|
||||
expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
|
||||
});
|
||||
|
||||
test('parses arguments correctly', () => {
|
||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
|
||||
});
|
||||
|
||||
test('calls the correct scwrypt', () => {
|
||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
||||
'--name',
|
||||
sample.lookup.exact.name,
|
||||
'--group',
|
||||
sample.lookup.exact.group,
|
||||
'--type',
|
||||
sample.lookup.exact.type,
|
||||
'--log-level',
|
||||
sample.options.log_level.toString(),
|
||||
'--',
|
||||
...sample.parsedCLIArgs,
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('patterns lookup', () => {
|
||||
beforeEach(async () => {
|
||||
sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.patterns);
|
||||
await scwrypts(sample.options);
|
||||
});
|
||||
|
||||
test('gets the correct lookup', () => {
|
||||
expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
|
||||
});
|
||||
|
||||
test('parses arguments correctly', () => {
|
||||
expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
|
||||
});
|
||||
|
||||
test('calls the correct scwrypt', () => {
|
||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
||||
...sample.lookup.patterns.patterns,
|
||||
'--log-level',
|
||||
sample.options.log_level.toString(),
|
||||
'--',
|
||||
...sample.parsedCLIArgs,
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
test('omits --log-level arguments if not provided', async () => {
|
||||
delete sample.options.log_level;
|
||||
|
||||
await scwrypts(sample.options);
|
||||
|
||||
expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
|
||||
'--name',
|
||||
sample.lookup.exact.name,
|
||||
'--group',
|
||||
sample.lookup.exact.group,
|
||||
'--type',
|
||||
sample.lookup.exact.type,
|
||||
'--',
|
||||
...sample.parsedCLIArgs,
|
||||
]);
|
||||
});
|
||||
|
||||
test('uses default scwrypts executable SCWRYPTS_EXECUTABLE is not provided', async () => {
|
||||
delete process.env.SCWRYPTS_EXECUTABLE;
|
||||
|
||||
await scwrypts(sample.options);
|
||||
|
||||
expect(execa).toHaveBeenCalledWith('scwrypts', [
|
||||
'--name',
|
||||
sample.lookup.exact.name,
|
||||
'--group',
|
||||
sample.lookup.exact.group,
|
||||
'--type',
|
||||
sample.lookup.exact.type,
|
||||
'--log-level',
|
||||
sample.options.log_level.toString(),
|
||||
'--',
|
||||
...sample.parsedCLIArgs,
|
||||
]);
|
||||
});
|
||||
Reference in New Issue
Block a user