feat: add new output formats: jsonArray and yamlArray (#897)

## What

## Why

## Notes

---------

Co-authored-by: Mikhail Klimko <mikhail.klimko@octopus.com>

Author: alinashklyar

Dockerfile

@@ -1,6 +1,6 @@
 # go hub binary
 FROM golang:alpine AS go
-RUN apk --update add ca-certificates git
+RUN apk --update add --no-scripts ca-certificates git
 RUN go install github.com/github/hub@latest
 
 # python yq binary

Dockerfile-debian

@@ -1,6 +1,6 @@
 # go hub binary
 FROM golang:alpine as go
-RUN apk --update add ca-certificates git
+RUN apk --update add --no-scripts ca-certificates git
 RUN go install github.com/github/hub@latest
 
 # python yq binary

Dockerfile-debian-rootless

@@ -1,6 +1,6 @@
 # go hub binary
 FROM golang:alpine as go
-RUN apk --update add ca-certificates git
+RUN apk --update add --no-scripts ca-certificates git
 RUN go install github.com/github/hub@latest
 
 # python yq binary

Dockerfile-rootless

@@ -1,6 +1,6 @@
 # go hub binary
 FROM golang:alpine as go
-RUN apk --update add ca-certificates git
+RUN apk --update add --no-scripts ca-certificates git
 RUN go install github.com/github/hub@latest
 
 # python yq binary

lib/interface/cli/commands/root/get.cmd.js

@@ -22,7 +22,7 @@ const get = new Command({
             .option('output', {
                 describe: 'Output format',
                 alias: 'o',
-                choices: ['json', 'yaml', 'wide', 'name', 'id'],
+                choices: ['json', 'yaml', 'wide', 'name', 'id', 'jsonArray', 'yamlArray'],
                 group: 'Output Options',
             })
             .option('date-format', {

lib/interface/cli/commands/root/get.completion.js

@@ -8,7 +8,7 @@ function optionHandler({ word, argv, option }) {
         return fileDir(word);
     }
     if (OUTPUT_OPTIONS.includes(option)) {
-        return ['json', 'yaml', 'wide', 'name', 'id'];
+        return ['json', 'yaml', 'wide', 'name', 'id', 'jsonArray', 'yamlArray'];
     }
     return [];
 }

lib/output/Output.js

@@ -13,6 +13,8 @@ const TYPES = {
     table: require('./types/table.output'),
     id: require('./types/id.output'),
     name: require('./types/name.output'),
+    jsonArray: require('./types/jsonArray.output'),
+    yamlArray: require('./types/yamlArray.output'),
 };
 
 const TABLE_TYPES = ['default', 'wide'];

lib/output/types/jsonArray.output.js

@@ -0,0 +1,19 @@
+const CFError = require('cf-errors'); // eslint-disable-line
+const Entity = require('../../logic/entities/Entity');
+const _ = require('lodash');
+
+function output(data) {
+    const entities = _.isArray(data) ? data : [data];
+    const jsonArray = [];
+
+    _.forEach(entities, (entity) => {
+        if (!(entity instanceof Entity)) {
+            throw new CFError('Cannot extract data for "jsonArray" output -- data contains not Entity');
+        }
+        jsonArray.push(entity.info);
+    });
+
+    return JSON.stringify(jsonArray, null, '\t');
+}
+
+module.exports = output;

lib/output/types/jsonArray.output.spec.js

@@ -0,0 +1,37 @@
+const CFError = require('cf-errors');
+const Entity = require('../../logic/entities/Entity');
+const output = require('./jsonArray.output');
+
+describe('jsonArray output', () => {
+    it('should return empty array for an empty array', () => {
+        expect(output([])).toBe('[]');
+    });
+
+    it('should wrap single Entity into array', () => {
+        const entity = new Entity();
+        entity.info = { id: '1', status: 'ok' };
+
+        const result = JSON.parse(output(entity));
+        expect(Array.isArray(result)).toBe(true);
+        expect(result).toHaveLength(1);
+        expect(result[0]).toEqual(entity.info);
+    });
+
+    it('should keep multiple Entities as array', () => {
+        const entity1 = new Entity();
+        entity1.info = { id: '1' };
+        const entity2 = new Entity();
+        entity2.info = { id: '2' };
+
+        const result = JSON.parse(output([entity1, entity2]));
+        expect(Array.isArray(result)).toBe(true);
+        expect(result).toHaveLength(2);
+        expect(result[0]).toEqual(entity1.info);
+        expect(result[1]).toEqual(entity2.info);
+    });
+
+    it('should throw CFError if element is not an Entity', () => {
+        expect(() => output({ id: '1' })).toThrow(CFError);
+        expect(() => output([new Entity(), {}])).toThrow(CFError);
+    });
+});

lib/output/types/yamlArray.output.js

@@ -0,0 +1,20 @@
+const CFError = require('cf-errors');
+const Entity = require('../../logic/entities/Entity');
+const _ = require('lodash');
+const yaml = require('js-yaml');
+
+function output(data) {
+    const entities = _.isArray(data) ? data : [data];
+    const yamlArray = [];
+
+    _.forEach(entities, (entity) => {
+        if (!(entity instanceof Entity)) {
+            throw new CFError('Cannot extract data for "yamlArray" output -- data contains not Entity');
+        }
+        yamlArray.push(entity.info);
+    });
+
+    return yaml.dump(yamlArray);
+}
+
+module.exports = output;