feat: kubectl apply view-last-applied

Fixes #4822

this includes a newly exported type from the core: ViewTransformer

Author: starpit

packages/core/src/index.ts

@@ -40,6 +40,7 @@ export {
   ParsedOptions,
   EvaluatorArgs as Arguments,
   Event,
+  ViewTransformer,
   CommandRegistrar as Registrar
 } from './models/command'
 export { optionsToString as unparse } from './core/utility'

packages/core/src/models/command.ts

@@ -43,6 +43,11 @@ export enum ExecType {
   Nested
 }
 
+export type ViewTransformer<T extends KResponse, O extends ParsedOptions> = (
+  args: EvaluatorArgs<O>,
+  response: T
+) => Promise<T> | void | Promise<void>
+
 export interface CommandOptions extends CapabilityRequirements {
   /** does this command accept no arguments of any sort (neither positional nor optional)? */
   noArgs?: boolean
@@ -86,10 +91,7 @@ export interface CommandOptions extends CapabilityRequirements {
   alwaysViewIn?: 'Terminal'
 
   /** model to view transformer */
-  viewTransformer?<T extends KResponse, O extends ParsedOptions>(
-    args: EvaluatorArgs<O>,
-    response: T
-  ): Promise<T> | void | Promise<void>
+  viewTransformer?: ViewTransformer<KResponse, ParsedOptions>
 }
 
 export interface Event {

plugins/plugin-kubectl/i18n/resources_en_US.json

@@ -14,6 +14,7 @@
   "createResource": "Create this resource",
   "This resource has been deleted": "This resource has been deleted",
   "Error fetching resource": "Error fetching resource",
+  "This resource has no last applied configuration": "This resource has no last applied configuration",
   "Unknown": "Unknown",
   "summary": "Summary",
   "resources": "Resources",

plugins/plugin-kubectl/oc/src/controller/kubectl/delegates.ts

@@ -25,6 +25,7 @@ import {
   describer,
   registerConfig,
   registerEdit,
+  registerApplySubcommands,
   doRun
 } from '@kui-shell/plugin-kubectl'
 import { doLogs } from '@kui-shell/plugin-kubectl/logs'
@@ -42,4 +43,5 @@ export default (registrar: Registrar) => {
   describer(registrar, command)
   registerConfig(registrar, command)
   registerEdit(registrar, command)
+  registerApplySubcommands(registrar, command)
 }

plugins/plugin-kubectl/src/controller/kubectl/apply-subcommands.ts

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2020 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Notes: this file covers the three (as of this writing) subcommands
+ * of apply:
+ *  - view-last-applied
+ *  - set-last-applied
+ *  - edit-last-applied
+ *
+ */
+
+import { Arguments, CodedError, CommandOptions, ViewTransformer, Registrar, i18n } from '@kui-shell/core'
+
+import { flags } from './flags'
+import commandPrefix from '../command-prefix'
+import { isUsage, doHelp } from '../../lib/util/help'
+import { getCommandFromArgs } from '../../lib/util/util'
+import { viewTransformer as getTransformer } from './get'
+import { KubeOptions, getNamespaceForArgv } from './options'
+import KubeResource, { isKubeResource } from '../../lib/model/resource'
+import { hasLastApplied, mode as lastAppliedMode } from '../../lib/view/modes/last-applied'
+
+const strings = i18n('plugin-kubectl')
+
+/** View Transformer for view-last-applied */
+export async function viewLastApplied(args: Arguments<KubeOptions>, response: KubeResource) {
+  if (isKubeResource(response)) {
+    if (hasLastApplied(response)) {
+      const baseView = await getTransformer(args, response)
+      return Object.assign(baseView, { defaultMode: lastAppliedMode })
+    } else {
+      const error: CodedError = new Error(strings('This resource has no last applied configuration'))
+      error.code = 404
+      throw error
+    }
+  }
+}
+
+function get(subcommand: string, args: Arguments<KubeOptions>) {
+  const command = getCommandFromArgs(args)
+
+  if (isUsage(args)) {
+    // special case: --help/-h
+    return doHelp(command === 'k' ? 'kubectl' : command, args)
+  }
+
+  const idx = args.argvNoOptions.indexOf(subcommand)
+  const kind = args.argvNoOptions[idx + 1]
+  const name = args.argvNoOptions[idx + 2]
+
+  return args.REPL.qexec<KubeResource>(`${command} get ${kind} ${name} ${getNamespaceForArgv(args)} -o yaml`)
+}
+
+function withTransformer(viewTransformer: ViewTransformer<KubeResource, KubeOptions>): CommandOptions {
+  return Object.assign({}, flags, { viewTransformer })
+}
+
+export function registerApplySubcommands(registrar: Registrar, cmd: string) {
+  registrar.listen(
+    `/${commandPrefix}/${cmd}/apply/view-last-applied`,
+    get.bind(undefined, 'view-last-applied'),
+    withTransformer(viewLastApplied)
+  )
+}
+
+export default function registerForKubectl(registrar: Registrar) {
+  registerApplySubcommands(registrar, 'kubectl')
+  registerApplySubcommands(registrar, 'k')
+}

plugins/plugin-kubectl/src/controller/kubectl/options.ts

@@ -138,6 +138,15 @@ export async function getNamespace(args: Arguments<KubeOptions>): Promise<string
   return args.parsedOptions.n || args.parsedOptions.namespace || (await getCurrentDefaultNamespace(args))
 }
 
+/**
+ * A variant of getNamespace where you *only* want to use what was
+ * provided by the user in their command line.
+ */
+export function getNamespaceForArgv(args: Arguments<KubeOptions>): string {
+  const ns = args.parsedOptions.n || args.parsedOptions.namespace
+  return !ns ? '' : `-n ${ns}`
+}
+
 export function getContext(args: Arguments<KubeOptions>) {
   return args.parsedOptions.context
 }

plugins/plugin-kubectl/src/index.ts

@@ -97,6 +97,7 @@ export { doCreate } from './controller/kubectl/create'
 export { doDelete } from './controller/kubectl/delete'
 export { describer } from './controller/kubectl/describe'
 export { register as registerConfig } from './controller/kubectl/config'
+export { registerApplySubcommands } from './controller/kubectl/apply-subcommands'
 
 export { viewTransformer as getTransformer } from './controller/kubectl/get'
 

plugins/plugin-kubectl/src/lib/view/modes/last-applied.ts

@@ -20,6 +20,9 @@ import { KubeResource } from '../../model/resource'
 
 const strings = i18n('plugin-kubectl')
 
+/** Mode identifier. Not a UI string. Only for internal referencing. */
+export const mode = 'last applied'
+
 /**
  * @return The last-applied-configuration annotation, as a raw string
  *
@@ -33,7 +36,7 @@ function getLastAppliedRaw(resource: KubeResource): string {
  * @return whether the given resource has a last applied configuration annotation
  *
  */
-function hasLastApplied(resource: KubeResource): boolean {
+export function hasLastApplied(resource: KubeResource): boolean {
   return !resource.isSimulacrum && getLastAppliedRaw(resource) !== undefined
 }
 
@@ -60,7 +63,7 @@ const renderLastApplied = async (tab: Tab, resource: KubeResource) => {
 export default {
   when: hasLastApplied,
   mode: {
-    mode: 'last applied',
+    mode,
     label: strings('lastApplied'),
     content: renderLastApplied
   }

plugins/plugin-kubectl/src/plugin.ts

@@ -31,6 +31,7 @@ import run from './controller/kubectl/run'
 import status from './controller/kubectl/status'
 import top from './controller/kubectl/top'
 import config from './controller/kubectl/config'
+import applySubcommands from './controller/kubectl/apply-subcommands'
 
 import fetchFile from './controller/fetch-file'
 import catchall from './controller/kubectl/catchall'
@@ -51,6 +52,7 @@ export default async (registrar: Registrar) => {
   status(registrar)
   top(registrar)
   config(registrar)
+  applySubcommands(registrar)
 
   fetchFile(registrar)
   catchall(registrar)

plugins/plugin-kubectl/src/test/k8s1/apply-subcommands.ts

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2020 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Common, CLI, ReplExpect, SidecarExpect, Selectors } from '@kui-shell/test'
+import { waitForGreen, createNS, allocateNS, deleteNS } from '@kui-shell/plugin-kubectl/tests/lib/k8s/utils'
+
+import { mode as lastAppliedMode } from '../../lib/view/modes/last-applied'
+
+const commands = ['kubectl']
+if (process.env.NEEDS_OC) {
+  commands.push('oc')
+}
+
+const podName = 'nginx'
+const sourceFile = 'https://raw.githubusercontent.com/kubernetes/examples/master/staging/pod'
+
+commands.forEach(command => {
+  describe(`${command} apply view-last-applied ${process.env.MOCHA_RUN_TARGET || ''}`, function(this: Common.ISuite) {
+    before(Common.before(this))
+    after(Common.after(this))
+
+    const ns: string = createNS()
+    const inNamespace = `-n ${ns}`
+
+    allocateNS(this, ns, command)
+
+    const doCreate = (verb: 'create' | 'apply') => {
+      it(`should ${verb === 'create' ? 'create' : 'update'} sample pod from URL via ${command} ${verb}`, async () => {
+        try {
+          const selector = await CLI.command(`${command} ${verb} -f ${sourceFile} ${inNamespace}`, this.app).then(
+            ReplExpect.okWithCustom({ selector: Selectors.BY_NAME(podName) })
+          )
+
+          // wait for the badge to become green
+          await waitForGreen(this.app, selector)
+        } catch (err) {
+          await Common.oops(this, true)(err)
+        }
+      })
+    }
+
+    doCreate('create')
+
+    // no last applied configuration, yet
+    it(`view last applied configuration and expect 404 via ${command}`, () =>
+      CLI.command(`${command} apply view-last-applied pod ${podName} ${inNamespace}`, this.app)
+        .then(ReplExpect.error(404))
+        .catch(Common.oops(this, true)))
+
+    // now use apply to get us a last applied configuration
+    doCreate('apply')
+
+    // check that we can view this last applied configuration via "apply view-last-applied"
+    it(`view last applied configuration via ${command} apply view-last-applied`, () =>
+      CLI.command(`${command} apply view-last-applied pod ${podName} ${inNamespace}`, this.app)
+        .then(ReplExpect.justOK)
+        .then(SidecarExpect.open)
+        .then(SidecarExpect.showing(podName, undefined, undefined, ns))
+        .then(SidecarExpect.mode(lastAppliedMode))
+        .catch(Common.oops(this, true)))
+
+    deleteNS(this, ns, command)
+  })
+})