rename tail-logs to tail-log (#40)

Author: justinedelson

src/client.js

@@ -423,7 +423,7 @@ class Client {
         return res.headers.get("content-length");
     }
 
-    async tailLogs(programId, environmentId, service, name, writeStream) {
+    async tailLog(programId, environmentId, service, name, writeStream) {
         let environments = await this.listEnvironments(programId)
         let environment = environments.find(e => e.id === environmentId);
         if (!environment) {

src/commands/cloudmanager/tail-logs.js src/commands/cloudmanager/tail-log.jssrc/commands/cloudmanager/tail-logs.js renamed to src/commands/cloudmanager/tail-log.js

@@ -16,23 +16,23 @@ const { getApiKey, getOrgId, getProgramId } = require('../../cloudmanager-helper
 const Client = require('../../client')
 const commonFlags = require('../../common-flags')
 
-async function _tailLogs(programId, environmentId, service, logName, passphrase) {
+async function _tailLog(programId, environmentId, service, logName, passphrase) {
     const apiKey = await getApiKey()
     const accessToken = await getAccessToken(passphrase)
     const orgId = await getOrgId()
-    await new Client(orgId, accessToken, apiKey).tailLogs(programId, environmentId, service, logName, process.stdout)
+    await new Client(orgId, accessToken, apiKey).tailLog(programId, environmentId, service, logName, process.stdout)
 }
 
-class TailLogs extends Command {
+class TailLog extends Command {
     async run() {
-        const { args, flags } = this.parse(TailLogs)
+        const { args, flags } = this.parse(TailLog)
 
         const programId = await getProgramId(flags)
 
         let result
 
         try {
-            result = await this.tailLogs(programId, args.environmentId, args.service, args.name, flags.passphrase)
+            result = await this.tailLog(programId, args.environmentId, args.service, args.name, flags.passphrase)
         } catch (error) {
             this.error(error.message)
         }
@@ -42,22 +42,24 @@ class TailLogs extends Command {
         return result
     }
 
-    async tailLogs(programId, environmentId, service, name, passphrase = null) {
-        return _tailLogs(programId, environmentId, service, name, passphrase)
+    async tailLog(programId, environmentId, service, name, passphrase = null) {
+        return _tailLog(programId, environmentId, service, name, passphrase)
     }
 }
 
-TailLogs.description = 'lists available logs for an environment in a Cloud Manager program'
+TailLog.description = 'lists available logs for an environment in a Cloud Manager program'
 
-TailLogs.args = [
+TailLog.args = [
     {name: 'environmentId', required: true, description: "the environment id"},
     {name: 'service', required: true, description: "the service"},
     {name: 'name', required: true, description: "the log name"}
 ]
 
-TailLogs.flags = {
+TailLog.flags = {
     ...commonFlags.global,
     ...commonFlags.programId
 }
 
-module.exports = TailLogs
+TailLog.aliases = ['cloudmanager:tail-logs']
+
+module.exports = TailLog

src/index.js

@@ -24,7 +24,7 @@ const GetExecutionStepDetails = require('./commands/cloudmanager/get-execution-s
 const GetExecutionStepLog = require('./commands/cloudmanager/get-execution-step-log')
 const ListAvailableLogOptions = require('./commands/cloudmanager/list-available-log-options')
 const DownloadLogs = require('./commands/cloudmanager/download-logs')
-const TailLogs = require('./commands/cloudmanager/tail-logs')
+const TailLog = require('./commands/cloudmanager/tail-log')
 
 module.exports = {
   'aaa': CloudManagerCommand, // needs to be first alphabetically
@@ -41,5 +41,5 @@ module.exports = {
   'get-execution-step-log': new GetExecutionStepLog().getExecutionStepLog,
   'list-available-log-options': new ListAvailableLogOptions().listAvailableLogOptions,
   'download-logs': new DownloadLogs().downloadLogs,
-  'tail-logs': new TailLogs().tailLogs
+  'tail-log': new TailLog().tailLog
 }

test/commands/tail-logs.test.js test/commands/tail-log.test.jstest/commands/tail-logs.test.js renamed to test/commands/tail-log.test.js

@@ -11,30 +11,30 @@ governing permissions and limitations under the License.
 */
 
 const { setStore } = require('@adobe/aio-cna-core-config')
-const TailLogs = require('../../src/commands/cloudmanager/tail-logs')
+const TailLog = require('../../src/commands/cloudmanager/tail-log')
 const Client = require('../../src/client')
 
 beforeEach(() => {
     setStore({})
 })
 
-test('tail-logs - missing arg', async () => {
+test('tail-log - missing arg', async () => {
     expect.assertions(2)
 
-    let runResult = TailLogs.run([])
+    let runResult = TailLog.run([])
     await expect(runResult instanceof Promise).toBeTruthy()
     await expect(runResult).rejects.toSatisfy(err => err.message.indexOf("Missing 3 required args") === 0)
 })
 
-test('tail-logs - missing config', async () => {
+test('tail-log - missing config', async () => {
     expect.assertions(2)
 
-    let runResult = TailLogs.run(["5", "author", "aemerror", "--programId", "5"])
+    let runResult = TailLog.run(["5", "author", "aemerror", "--programId", "5"])
     await expect(runResult instanceof Promise).toBeTruthy()
     await expect(runResult).rejects.toEqual(new Error('missing config data: jwt-auth'))
 })
 
-test('tail-logs - failure', async () => {
+test('tail-log - failure', async () => {
     setStore({
         'jwt-auth': JSON.stringify({
             client_id: '1234',
@@ -46,12 +46,12 @@ test('tail-logs - failure', async () => {
 
     expect.assertions(2)
 
-    let runResult = TailLogs.run(["17", "author", "aemerror", "--programId", "5"])
+    let runResult = TailLog.run(["17", "author", "aemerror", "--programId", "5"])
     await expect(runResult instanceof Promise).toBeTruthy()
     await expect(runResult).rejects.toEqual(new Error('Could not find environment 17 for program 5'))
 })
 
-test('tail-logs - no logs for tailing', async () => {
+test('tail-log - no logs for tailing', async () => {
     setStore({
         'jwt-auth': JSON.stringify({
             client_id: '1234',
@@ -63,7 +63,7 @@ test('tail-logs - no logs for tailing', async () => {
 
     expect.assertions(2)
 
-    let runResult = TailLogs.run(["1", "publish", "aemerror", "--programId", "4"])
+    let runResult = TailLog.run(["1", "publish", "aemerror", "--programId", "4"])
     await expect(runResult instanceof Promise).toBeTruthy()
     await expect(runResult).rejects.toEqual(new Error('No logs for tailing available in 1 for program 4'))
 })