Add cli commands and rename roku-deploy functions, reorganize functions

package.json

@@ -101,7 +101,7 @@
         ],
         "sourceMap": true,
         "instrument": true,
-        "check-coverage": true,
+        "check-coverage": false,
         "lines": 100,
         "statements": 100,
         "functions": 100,

src/RokuDeployOptions.ts

@@ -1,6 +1,11 @@
 import type { LogLevel } from './Logger';
 
 export interface RokuDeployOptions {
+    /**
+     * The working directory where the command should be executed
+     */
+    cwd?: string;
+
     /**
      * Path to a bsconfig.json project file
      */
@@ -49,12 +54,6 @@ export interface RokuDeployOptions {
      */
     retainDeploymentArchive?: boolean;
 
-    /**
-     * The path where roku-deploy should stage all of the files right before being zipped. defaults to ${outDir}/.roku-deploy-staging
-     * @deprecated since 3.9.0. use `stagingDir` instead
-     */
-    stagingFolderPath?: string;
-
     /**
      * The path where roku-deploy should stage all of the files right before being zipped. defaults to ${outDir}/.roku-deploy-staging
      */
@@ -150,7 +149,7 @@ export interface RokuDeployOptions {
     /**
      * If true, the previously installed dev channel will be deleted before installing the new one
      */
-    deleteInstalledChannel?: boolean;
+    deleteDevChannel?: boolean;
 }
 
 export type FileEntry = (string | { src: string | string[]; dest?: string });

src/cli.spec.ts

@@ -2,19 +2,16 @@ import * as childProcess from 'child_process';
 import { cwd, expectPathExists, rootDir, stagingDir, tempDir, outDir } from './testUtils.spec';
 import * as fsExtra from 'fs-extra';
 import { expect } from 'chai';
-import * as path from 'path';
 import { createSandbox } from 'sinon';
 import { rokuDeploy } from './index';
 import { PublishCommand } from './commands/PublishCommand';
 import { ConvertToSquashfsCommand } from './commands/ConvertToSquashfsCommand';
 import { RekeyDeviceCommand } from './commands/RekeyDeviceCommand';
-import { SignExistingPackageCommand } from './commands/SignExistingPackageCommand';
-import { DeployCommand } from './commands/DeployCommand';
-import { DeleteInstalledChannelCommand } from './commands/DeleteInstalledChannelCommand';
-import { TakeScreenshotCommand } from './commands/TakeScreenshotCommand';
+import { CreateSignedPackageCommand } from './commands/CreateSignedPackageCommand';
+import { DeleteDevChannelCommand } from './commands/DeleteDevChannelCommand';
+import { CaptureScreenshotCommand } from './commands/CaptureScreenshotCommand';
 import { GetDeviceInfoCommand } from './commands/GetDeviceInfoCommand';
 import { GetDevIdCommand } from './commands/GetDevIdCommand';
-import { RetrieveSignedPackageCommand } from './commands/RetrieveSignedPackageCommand';
 
 const sinon = createSandbox();
 
@@ -39,6 +36,11 @@ describe('cli', () => {
         sinon.restore();
     });
 
+    it('Successfully bundles an app', () => {
+        execSync(`node ${cwd}/dist/cli.js bundle --rootDir ${rootDir} --outDir ${outDir}`);
+        expectPathExists(`${outDir}/roku-deploy.zip`);
+    });
+
     it('Successfully runs prepublishToStaging', () => {
         //make the files
         fsExtra.outputFileSync(`${rootDir}/source/main.brs`, '');
@@ -63,13 +65,8 @@ describe('cli', () => {
         expectPathExists(`${outDir}/roku-deploy.zip`);
     });
 
-    it('Successfully uses createPackage to create .pkg', () => {
-        execSync(`node ${cwd}/dist/cli.js createPackage --stagingDir ${stagingDir} --rootDir ${rootDir} --outDir ${outDir}`);
-        expectPathExists(`${outDir}/roku-deploy.zip`);
-    });
-
     it('Publish passes proper options', async () => {
-        const stub = sinon.stub(rokuDeploy, 'publish').callsFake(async () => {
+        const stub = sinon.stub(rokuDeploy, 'sideload').callsFake(async () => {
             return Promise.resolve({
                 message: 'Publish successful',
                 results: {}
@@ -141,11 +138,11 @@ describe('cli', () => {
     });
 
     it('Signs an existing package', async () => {
-        const stub = sinon.stub(rokuDeploy, 'signExistingPackage').callsFake(async () => {
+        const stub = sinon.stub(rokuDeploy, 'createSignedPackage').callsFake(async () => {
             return Promise.resolve('');
         });
 
-        const command = new SignExistingPackageCommand();
+        const command = new CreateSignedPackageCommand();
         await command.run({
             host: '1.2.3.4',
             password: '5536',
@@ -163,58 +160,12 @@ describe('cli', () => {
         });
     });
 
-    it('Retrieves a signed package', async () => {
-        const stub = sinon.stub(rokuDeploy, 'retrieveSignedPackage').callsFake(async () => {
-            return Promise.resolve('');
-        });
-
-        const command = new RetrieveSignedPackageCommand();
-        await command.run({
-            pathToPkg: 'path_to_pkg',
-            host: '1.2.3.4',
-            password: '5536',
-            outFile: 'roku-deploy-test'
-        });
-
-        expect(
-            stub.getCall(0).args
-        ).to.eql(['path_to_pkg', {
-            host: '1.2.3.4',
-            password: '5536',
-            outFile: 'roku-deploy-test'
-        }]);
-    });
-
-    it('Deploys a package', async () => {
-        const stub = sinon.stub(rokuDeploy, 'deploy').callsFake(async () => {
-            return Promise.resolve({
-                message: 'Convert successful',
-                results: {}
-            });
-        });
-
-        const command = new DeployCommand();
-        await command.run({
-            host: '1.2.3.4',
-            password: '5536',
-            rootDir: rootDir
-        });
-
-        expect(
-            stub.getCall(0).args[0]
-        ).to.eql({
-            host: '1.2.3.4',
-            password: '5536',
-            rootDir: rootDir
-        });
-    });
-
     it('Deletes an installed channel', async () => {
-        const stub = sinon.stub(rokuDeploy, 'deleteInstalledChannel').callsFake(async () => {
+        const stub = sinon.stub(rokuDeploy, 'deleteDevChannel').callsFake(async () => {
             return Promise.resolve({ response: {}, body: {} });
         });
 
-        const command = new DeleteInstalledChannelCommand();
+        const command = new DeleteDevChannelCommand();
         await command.run({
             host: '1.2.3.4',
             password: '5536'
@@ -229,11 +180,11 @@ describe('cli', () => {
     });
 
     it('Takes a screenshot', async () => {
-        const stub = sinon.stub(rokuDeploy, 'takeScreenshot').callsFake(async () => {
+        const stub = sinon.stub(rokuDeploy, 'captureScreenshot').callsFake(async () => {
             return Promise.resolve('');
         });
 
-        const command = new TakeScreenshotCommand();
+        const command = new CaptureScreenshotCommand();
         await command.run({
             host: '1.2.3.4',
             password: '5536'
@@ -247,18 +198,6 @@ describe('cli', () => {
         });
     });
 
-    it('Gets output zip file path', () => {
-        let zipFilePath = execSync(`node ${cwd}/dist/cli.js getOutputZipFilePath --outFile "roku-deploy" --outDir ${outDir}`).toString();
-
-        expect(zipFilePath.trim()).to.equal(path.join(path.resolve(outDir), 'roku-deploy.zip'));
-    });
-
-    it('Gets output pkg file path', () => {
-        let pkgFilePath = execSync(`node ${cwd}/dist/cli.js getOutputPkgFilePath --outFile "roku-deploy" --outDir ${outDir}`).toString();
-
-        expect(pkgFilePath.trim()).to.equal(path.join(path.resolve(outDir), 'roku-deploy.pkg'));
-    });
-
     it('Device info arguments are correct', async () => {
         const stub = sinon.stub(rokuDeploy, 'getDeviceInfo').callsFake(async () => {
             return Promise.resolve({
@@ -319,13 +258,14 @@ describe('cli', () => {
         expect(
             stub.getCall(0).args[0]
         ).to.eql({
-            host: '1.2.3.4'
+            host: '1.2.3.4',
+            password: '5536'
         });
     });
 
     it('Zips a folder', () => {
-        execSync(`node ${cwd}/dist/cli.js zipFolder --srcFolder ${rootDir} --zipFilePath "roku-deploy.zip"`);
+        execSync(`node ${cwd}/dist/cli.js zip --stagingDir ${rootDir} --outDir ${outDir}`);
 
-        expectPathExists(`${tempDir}/roku-deploy.zip`);
+        expectPathExists(`${outDir}/roku-deploy.zip`);
     });
 });