CY-1560 - Add function for getting node status icon (#12)

* Added function for getting node status icon (CY-1560)
* Improved no SSH key error message
* Updated JS API documentation
* Improved JS API documentation verification

Author: qooban

ci/verify-docs.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+
+git diff --exit-code ./src/README.md
+EXIT_CODE=$?
+
+if [ "$EXIT_CODE" != "0" ]; then
+  echo "ERROR: JS API documentation not up-to-date with the source code. Follow these steps:"
+  echo " - verify if 'documentation.yml' configuration is up-to-date with the 'src' folder content,"
+  echo " - run 'npm run docs',"
+  echo " - check output 'src/README.md' file,"
+  echo " - commit updated 'src/README.md' file."
+  exit 1
+fi;

documentation.yml

@@ -1,6 +1,14 @@
 toc:
+  - name: consts
+    description: |
+      Common constants.
+    children:
+      - nodeStatuses
   - name: icons
     description: |
       Icons API intends to provide helper functions to access icons defined within [cloudify](#fonts) font.
     children:
+      - getEventIcon
       - getNodeIcon
+      - getNodeStatusIcon
+

package.json

@@ -38,7 +38,7 @@
     "test:coverage": "jest test --coverage",
     "test:docs": "npm run docs && npm run verify:docs",
     "test:only": "jest test",
-    "verify:docs": "git diff --exit-code ./src/README.md || echo Run `npm run docs` and commit updated `src/README.md` file."
+    "verify:docs": "sh ci/verify-docs.sh"
   },
   "repository": {
     "type": "git",

scripts/upload-package.sh

@@ -37,7 +37,7 @@ uploadPackage() {
 
     # SSH key check
     if [ ! -f "${SSH_KEY_PATH}" ]; then
-        echo "ERROR: SSH key to Cloudify Manager - '${SSH_KEY_PATH}' - not found.";
+        echo "ERROR: SSH key to Cloudify Manager (SSH_KEY_PATH variable) - '${SSH_KEY_PATH}' - not found.";
         ((ERROR_CODE++))
     fi
 

src/README.md

@@ -2,35 +2,86 @@
 
 ### Table of Contents
 
--   [icons][1]
-    -   [getNodeIcon][2]
-        -   [Parameters][3]
+-   [consts][1]
+    -   [nodeStatuses][2]
+-   [icons][3]
+    -   [getEventIcon][4]
+        -   [Parameters][5]
+    -   [getNodeIcon][6]
+        -   [Parameters][7]
+    -   [getNodeStatusIcon][8]
+        -   [Parameters][9]
+
+## consts
+
+Common constants.
+
+
+### nodeStatuses
+
+Node statuses constants.
+
+Type: [string][10]
 
 ## icons
 
-Icons API intends to provide helper functions to access icons defined within [cloudify][4] font.
+Icons API intends to provide helper functions to access icons defined within [cloudify][11] font.
+
 
+### getEventIcon
+
+Get event type icon character to be used with cloudify font.
+
+#### Parameters
+
+-   `eventType` **[string][10]** event type, eg. "workflow_started" or "task_received".
+
+Returns **[string][10]** character from cloudify font
 
 ### getNodeIcon
 
 Get node type icon character to be used with cloudify font.
 
 #### Parameters
 
--   `hierarchy` **([string][5] \| [Array][6]<[string][5]>)** node type hierarchy, from the most specific to the most generic,
+-   `hierarchy` **([string][10] \| [Array][12]<[string][10]>)** node type hierarchy, from the most specific to the most generic,
     can be single string (eg. "cloudify.nodes.Root")
     or array of strings (eg. ["cloudify.nodes.CloudifyManager", "cloudify.nodes.SoftwareComponent", "cloudify.nodes.Root"]).
 
-Returns **[string][5]** character from cloudify font
+Returns **[string][10]** character from cloudify font
+
+### getNodeStatusIcon
+
+Get node status icon character to be used with cloudify font.
+
+#### Parameters
+
+-   `nodeStatus` **[nodeStatuses][13]** node status value.
+
+Returns **[string][10]** character from cloudify font or empty string for not [nodeStatuses][2] value
+
+[1]: #consts
+
+[2]: #nodestatuses
+
+[3]: #icons
+
+[4]: #geteventicon
+
+[5]: #parameters
+
+[6]: #getnodeicon
+
+[7]: #parameters-1
 
-[1]: #icons
+[8]: #getnodestatusicon
 
-[2]: #getnodeicon
+[9]: #parameters-2
 
-[3]: #parameters
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[4]: #fonts
+[11]: #fonts
 
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[13]: #nodestatuses

src/consts.js

@@ -0,0 +1,13 @@
+/**
+ * Node statuses constants.
+ * @enum {string}
+ */
+export const nodeStatuses = {
+    UNINITIALIZED: 'uninitialized',
+    LOADING: 'loading',
+    DONE: 'done',
+    ALERT: 'alert',
+    FAILED: 'failed'
+};
+
+export default { nodeStatuses };

src/icons.js

@@ -1,3 +1,5 @@
+import { nodeStatuses } from './consts';
+
 /**
  * Get node type icon character to be used with cloudify font.
  *
@@ -7,7 +9,7 @@
  *
  * @returns {string} character from cloudify font
  */
-function getNodeIcon(hierarchy) {
+export function getNodeIcon(hierarchy) {
     const nodeTypeToChar = {
         'cloudify.nodes.ApplicationModule': '\ue616',
         'cloudify.nodes.ApplicationServer': '\ue61e',
@@ -40,14 +42,34 @@ function getNodeIcon(hierarchy) {
     return knownType ? nodeTypeToChar[knownType] : nodeTypeToChar[defaultNodeType];
 }
 
+/**
+ * Get node status icon character to be used with cloudify font.
+ *
+ * @param {nodeStatuses} nodeStatus - node status value.
+ *
+ * @returns {string} character from cloudify font or empty string for not {@link nodeStatuses} value
+ */
+export function getNodeStatusIcon(nodeStatus) {
+    const nodeStatusToChar = {
+        [nodeStatuses.ALERT]: '\ue629',
+        [nodeStatuses.DONE]: '\ue62a',
+        [nodeStatuses.FAILED]: '\ue62b',
+        [nodeStatuses.LOADING]: '\ue630'
+    };
+    const defaultChar = '';
+    const knownType = !!nodeStatusToChar[nodeStatus];
+
+    return knownType ? nodeStatusToChar[nodeStatus] : defaultChar;
+}
+
 /**
  * Get event type icon character to be used with cloudify font.
  *
  * @param {string} eventType - event type, eg. "workflow_started" or "task_received".
  *
  * @returns {string} character from cloudify font
  */
-function getEventIcon(eventType) {
+export function getEventIcon(eventType) {
     const eventTypeToChar = {
         policy_failed: '\ue605',
         policy_success: '\ue606',
@@ -75,5 +97,6 @@ function getEventIcon(eventType) {
 
 export default {
     getEventIcon,
-    getNodeIcon
+    getNodeIcon,
+    getNodeStatusIcon
 };

src/index.js

@@ -1,2 +1,3 @@
 // eslint-disable-next-line import/prefer-default-export
 export { default as icons } from './icons'; // to re-export default
+export { default as consts } from './consts'; // to re-export default

test/consts.test.js

@@ -0,0 +1,19 @@
+import { nodeStatuses } from '../src/consts';
+
+describe('nodeStatuses', () => {
+    test('getting alert state', () => {
+        expect(nodeStatuses.ALERT).toBe('alert');
+    });
+
+    test('getting done state', () => {
+        expect(nodeStatuses.DONE).toBe('done');
+    });
+
+    test('getting failed state', () => {
+        expect(nodeStatuses.FAILED).toBe('failed');
+    });
+
+    test('getting loading state', () => {
+        expect(nodeStatuses.LOADING).toBe('loading');
+    });
+});

test/icons.test.js

@@ -1,37 +1,51 @@
-import icons from '../src/icons';
+import { getEventIcon, getNodeIcon, getNodeStatusIcon } from '../src/icons';
 
 describe('getNodeIcon', () => {
     test('handles empty string', () => {
-        expect(icons.getNodeIcon('')).toBe('\ue616');
+        expect(getNodeIcon('')).toBe('\ue616');
     });
 
     test('handles string', () => {
-        expect(icons.getNodeIcon('cloudify.nodes.Compute')).toBe('\ue61b');
+        expect(getNodeIcon('cloudify.nodes.Compute')).toBe('\ue61b');
     });
 
     test('handles empty array', () => {
-        expect(icons.getNodeIcon([])).toBe('\ue616');
+        expect(getNodeIcon([])).toBe('\ue616');
     });
 
     test('handles array', () => {
-        expect(icons.getNodeIcon(['cloudify.nodes.Compute', 'cloudify.nodes.Root'])).toBe('\ue61b');
+        expect(getNodeIcon(['cloudify.nodes.Compute', 'cloudify.nodes.Root'])).toBe('\ue61b');
     });
 
     test('handles invalid input', () => {
-        expect(icons.getNodeIcon(555)).toBe('\ue616');
+        expect(getNodeIcon(555)).toBe('\ue616');
+    });
+});
+
+describe('getNodeStatusIcon', () => {
+    test('handles empty string', () => {
+        expect(getNodeStatusIcon('')).toBe('');
+    });
+
+    test('handles string', () => {
+        expect(getNodeStatusIcon('alert')).toBe('\ue629');
+    });
+
+    test('handles invalid input', () => {
+        expect(getNodeStatusIcon('abcd')).toBe('');
     });
 });
 
 describe('getEventIcon', () => {
     test('handles empty string', () => {
-        expect(icons.getEventIcon('')).toBe('\ue60a');
+        expect(getEventIcon('')).toBe('\ue60a');
     });
 
     test('handles string', () => {
-        expect(icons.getEventIcon('task_succeeded')).toBe('\ue60b');
+        expect(getEventIcon('task_succeeded')).toBe('\ue60b');
     });
 
     test('handles invalid input', () => {
-        expect(icons.getEventIcon(555)).toBe('\ue60a');
+        expect(getEventIcon(555)).toBe('\ue60a');
     });
 });