Secret env command

[CMCDragonkai]

Description

This PR aims to refactor the existing pk secret env command according to the specifications outlined in the Development Environment Usecase. Essentially the command should be able inject environment variable or allow sourcing variables into an existing subshell.

Issues Fixed

• Fixes The pk secrets env command for meeting Development Environment Usecase Polykey-CLI#31

Tasks

1. Ensure that pk secrets env can be used to inject environment variables and run a subprocess
2. Ensure that pk secrets env can be used to source environment variables and output something that can be used as a file to be sourced by a shell
3. Handle export flag
4. Handle globbing options specified in the usecase
5. Handle command options with spaces (may extend to other secret and vault CLI commands)
6. Extending globbing to match documentation here (https://git-scm.com/docs/gitignore)
7. Testing for secret env command executing a subshell
8. Add platform dependent subshell testing
9. Deal with the fact that nodejs doesn't have an exec that can replace the current node process

Final checklist

• Domain specific test (npm test -- tests/bin/secret.test.ts)
• Full tests with npm test
• Updated inline-comment documentation
• Lint fixed
• Squash and rebased
• Sanity check the final build

[CMCDragonkai]

Recreated this from: #210.

[scottmmorris]

At the moment I am testing the basic exporting of secrets into the current shell by echoing the variable name:

nexpect.spawn('echo', ['$TEST_VAR_3']).expect('test-3');

However, exporting secrets into a subshell I've had to do a bit differently:

nexpect.spawn('npm', ['run', 'polykey', '--', 'secrets', 'env', '-np', dataDir, '-e', 'Vault000:**/*', 'bash'])
  .sendline('echo $TEST_VAR_2')
  .sendline('exit')
  .run(function (_, stdout) {
    expect(stdout).toContain('test-2');
    done();
  });

[CMCDragonkai]

So nexpect does work on Windows. However bash won't be on Windows. So either we use a common shell, which there is none. Or you have to do a feature test see if bash exists, then use bash, and if not, try with powershell and then do the test.

[CMCDragonkai]

The kexec is just an NPM library, you should be able to bring it in and just use it on Linux. On Windows we would continue to use child process as normal.

[scottmmorris]

For kexec I forgot that you mentioned here that it has been abandoned and the latest release doesn't work on Node 12 and 14. But an unmerged branch has the required fixes. See here: https://github.com/MatrixAI/js-polykey/issues/205#issuecomment-876942149

So we were going to pull the source code into the polykey library in order to fix this instead of just npm installing it

[joshuakarp]

When revisiting this, it will be worthwhile to take another look at the discussion had with Scott: https://vimeo.com/manage/videos/654376139

[CMCDragonkai]

When addressing secrets related commands, we should review this too @tegefaulkes.

[CMCDragonkai]

Superseded by #505.