Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .changeset/fiery-sheep-wear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
"@slack/cli-test": major
---

refactor(cli-test)!: rename env add/remove to env set/unset

The Slack CLI v4.0.0 release changes the `env` commands to prefer `set` and `unset` aliases and the test tracers of this package were changed to match:

```diff
- SLACK_TRACE_ENV_ADD_SUCCESS
- SLACK_TRACE_ENV_REMOVE_SUCCESS
+ SLACK_TRACE_ENV_SET_SUCCESS
+ SLACK_TRACE_ENV_UNSET_SUCCESS
```
16 changes: 8 additions & 8 deletions packages/cli-test/src/cli/commands/env.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ describe('env commands', () => {
sandbox.restore();
});

describe('add method', () => {
it('should invoke `env add <key> <value>`', async () => {
await env.add({ appPath: '/some/path', secretKey: 'key', secretValue: 'value' });
describe('set method', () => {
it('should invoke `env set <key> <value>`', async () => {
await env.set({ appPath: '/some/path', secretKey: 'key', secretValue: 'value' });
sandbox.assert.calledWith(
spawnSpy,
sinon.match.string,
sinon.match.array.contains(['env', 'add', 'key', 'value']),
sinon.match.array.contains(['env', 'set', 'key', 'value']),
);
});
});
Expand All @@ -40,10 +40,10 @@ describe('env commands', () => {
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'list']));
});
});
describe('remove method', () => {
it('should invoke `env remove <key>`', async () => {
await env.remove({ appPath: '/some/path', secretKey: 'key' });
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'remove', 'key']));
describe('unset method', () => {
it('should invoke `env unset <key>`', async () => {
await env.unset({ appPath: '/some/path', secretKey: 'key' });
sandbox.assert.calledWith(spawnSpy, sinon.match.string, sinon.match.array.contains(['env', 'unset', 'key']));
});
});
});
16 changes: 8 additions & 8 deletions packages/cli-test/src/cli/commands/env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ export interface EnvCommandArguments {
}

/**
* `slack env add`
* `slack env set`
* @returns command output
*/
export const add = async function envAdd(args: ProjectCommandArguments & EnvCommandArguments): Promise<string> {
const cmd = new SlackCLIProcess(['env', 'add', args.secretKey, args.secretValue], args);
export const set = async function envSet(args: ProjectCommandArguments & EnvCommandArguments): Promise<string> {
const cmd = new SlackCLIProcess(['env', 'set', args.secretKey, args.secretValue], args);
const proc = await cmd.execAsync({
cwd: args.appPath,
});
Expand All @@ -33,21 +33,21 @@ export const list = async function envList(args: ProjectCommandArguments): Promi
};

/**
* `slack env remove`
* `slack env unset`
* @returns command output
*/
export const remove = async function envRemove(
export const unset = async function envUnset(
args: ProjectCommandArguments & Pick<EnvCommandArguments, 'secretKey'>,
): Promise<string> {
const cmd = new SlackCLIProcess(['env', 'remove', args.secretKey], args);
const cmd = new SlackCLIProcess(['env', 'unset', args.secretKey], args);
const proc = await cmd.execAsync({
cwd: args.appPath,
});
return proc.output;
};

export default {
add,
set,
list,
remove,
unset,
};
4 changes: 2 additions & 2 deletions packages/cli-test/src/utils/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ export const SlackTracerId = {
SLACK_TRACE_DATASTORE_COUNT_DATASTORE: 'SLACK_TRACE_DATASTORE_COUNT_DATASTORE',
SLACK_TRACE_DATASTORE_COUNT_SUCCESS: 'SLACK_TRACE_DATASTORE_COUNT_SUCCESS',
SLACK_TRACE_DATASTORE_COUNT_TOTAL: 'SLACK_TRACE_DATASTORE_COUNT_TOTAL',
SLACK_TRACE_ENV_ADD_SUCCESS: 'SLACK_TRACE_ENV_ADD_SUCCESS',
SLACK_TRACE_ENV_SET_SUCCESS: 'SLACK_TRACE_ENV_SET_SUCCESS',
SLACK_TRACE_ENV_LIST_COUNT: 'SLACK_TRACE_ENV_LIST_COUNT',
SLACK_TRACE_ENV_LIST_VARIABLES: 'SLACK_TRACE_ENV_LIST_VARIABLES',
SLACK_TRACE_ENV_REMOVE_SUCCESS: 'SLACK_TRACE_ENV_REMOVE_SUCCESS',
SLACK_TRACE_ENV_UNSET_SUCCESS: 'SLACK_TRACE_ENV_UNSET_SUCCESS',
SLACK_TRACE_FEEDBACK_MESSAGE: 'SLACK_TRACE_FEEDBACK_MESSAGE',
SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS: 'SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS',
SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS: 'SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS',
Expand Down
Loading