diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..5582c0c8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +@ + +#### What issues does this address? + +- Fixes # +- WIP # + +#### What does this change do? + +#### Where should the reviewer start? + +#### Any background context? diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 211c870a..c8eabe18 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,7 +13,7 @@ build package: script: - echo 'CI BUILD' # install packages first - - npm install --production --no-optional + - npm run install-production - bash ./scripts/build_rpm.sh tags: - cm-official-docker-executor @@ -96,7 +96,7 @@ deploy_bigip: test package: stage: test script: - - npm install --no-optional + - npm run install-test - npm run lint - npm run test tags: @@ -107,7 +107,7 @@ test functional: script: - export TEST_HARNESS_FILE=${CI_PROJECT_DIR}/harness_facts_flat.json # really only need dev dependencies - - npm install --no-optional + - npm run install-test - ls ./dist -ls - npm run test-functional tags: diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/package-lock.json b/package-lock.json index 4fad6232..5b9676a0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -271,9 +271,9 @@ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, "aws-sdk": { - "version": "2.389.0", - "resolved": "https://registry.npmjs.org/aws-sdk/-/aws-sdk-2.389.0.tgz", - "integrity": "sha512-4KBH2o4f/ncTJfKzUsMNxxPNWkF7eFVZlYLRpeFAYEgw+r8xE//0YBReNnySS5Y5oQTOtg376bOlQSWtFhKv1g==", + "version": "2.391.0", + "resolved": "https://registry.npmjs.org/aws-sdk/-/aws-sdk-2.391.0.tgz", + "integrity": "sha512-2xL59xW/bosjccZdrPwV9MfMJ7vkg2dn83m4LTgk+p+y8IOE4DdCP9dE+toz0frtVatriPDIXCA0dyOVYFt8EA==", "requires": { "buffer": "4.9.1", "events": "1.1.1", diff --git a/package.json b/package.json index 7215e55e..93d50800 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,15 @@ { "name": "f5-telemetry", "version": "0.9.0", + "author": "F5 Networks", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "git+https://github.com/F5Networks/f5-telemetry-streaming.git" + }, "scripts": { + "install-production": "npm install --production --no-optional", + "install-test": "npm install --no-optional", "lint": "eslint src test", "test": "nyc --check-coverage --lines 80 --functions 80 --branches 70 mocha --recursive \"./test/*.js\"", "test-functional": "mocha --recursive \"./test/functional/*.js\"" diff --git a/src/nodejs/config.js b/src/nodejs/config.js index 86117bf1..3efad893 100644 --- a/src/nodejs/config.js +++ b/src/nodejs/config.js @@ -15,11 +15,11 @@ const EventEmitter = require('events'); const logger = require('./logger.js'); const util = require('./util.js'); -const baseSchema = require('./config/base_schema.json'); -const controlsSchema = require('./config/controls_schema.json'); -const systemPollerSchema = require('./config/system_poller_schema.json'); -const listenerSchema = require('./config/listener_schema.json'); -const consumerSchema = require('./config/consumer_schema.json'); +const baseSchema = require('./schema/base_schema.json'); +const controlsSchema = require('./schema/controls_schema.json'); +const systemPollerSchema = require('./schema/system_poller_schema.json'); +const listenerSchema = require('./schema/listener_schema.json'); +const consumerSchema = require('./schema/consumer_schema.json'); const customKeywords = require('./customKeywords.js'); const CONTROLS_CLASS_NAME = require('./constants.js').CONTROLS_CLASS_NAME; const CONTROLS_PROPERTY_NAME = require('./constants.js').CONTROLS_PROPERTY_NAME; diff --git a/src/nodejs/customKeywords.js b/src/nodejs/customKeywords.js index 8ae79db9..4ff27252 100644 --- a/src/nodejs/customKeywords.js +++ b/src/nodejs/customKeywords.js @@ -83,7 +83,7 @@ const keywords = { }; } }, - hostNetworkCheck: { + hostConnectivityCheck: { type: 'string', errors: true, modifying: true, @@ -107,7 +107,7 @@ const keywords = { return util.networkCheck(data, pData.port) .then(() => true) .catch((e) => { - ajvErrors.push({ keyword: 'hostNetworkCheck', message: e.message, params: {} }); + ajvErrors.push({ keyword: 'hostConnectivityCheck', message: e.message, params: {} }); throw new Ajv.ValidationError(ajvErrors); }); }; diff --git a/src/nodejs/restWorkers/main.js b/src/nodejs/restWorkers/main.js index 59a2e3f1..f467a64d 100644 --- a/src/nodejs/restWorkers/main.js +++ b/src/nodejs/restWorkers/main.js @@ -14,7 +14,7 @@ const path = require('path'); const logger = require('../logger.js'); const util = require('../util.js'); -const baseSchema = require('../config/base_schema.json'); +const baseSchema = require('../schema/base_schema.json'); const configWorker = require('../config.js'); const eventListener = require('../eventListener.js'); // eslint-disable-line no-unused-vars const consumers = require('../consumers.js'); // eslint-disable-line no-unused-vars diff --git a/src/nodejs/config/base_schema.json b/src/nodejs/schema/base_schema.json similarity index 100% rename from src/nodejs/config/base_schema.json rename to src/nodejs/schema/base_schema.json diff --git a/src/nodejs/config/consumer_schema.json b/src/nodejs/schema/consumer_schema.json similarity index 99% rename from src/nodejs/config/consumer_schema.json rename to src/nodejs/schema/consumer_schema.json index a18e802a..e05d086b 100644 --- a/src/nodejs/config/consumer_schema.json +++ b/src/nodejs/schema/consumer_schema.json @@ -16,7 +16,7 @@ { "format": "ipv6" }, { "format": "hostname" } ], - "hostNetworkCheck": true + "hostConnectivityCheck": true }, "protocol": { "$comment": "Required for certain consumers: standard property", diff --git a/src/nodejs/config/controls_schema.json b/src/nodejs/schema/controls_schema.json similarity index 100% rename from src/nodejs/config/controls_schema.json rename to src/nodejs/schema/controls_schema.json diff --git a/src/nodejs/config/listener_schema.json b/src/nodejs/schema/listener_schema.json similarity index 100% rename from src/nodejs/config/listener_schema.json rename to src/nodejs/schema/listener_schema.json diff --git a/src/nodejs/config/system_poller_schema.json b/src/nodejs/schema/system_poller_schema.json similarity index 98% rename from src/nodejs/config/system_poller_schema.json rename to src/nodejs/schema/system_poller_schema.json index 1bff69d4..d2601a20 100644 --- a/src/nodejs/config/system_poller_schema.json +++ b/src/nodejs/schema/system_poller_schema.json @@ -40,7 +40,7 @@ { "format": "hostname" } ], "default": "localhost", - "hostNetworkCheck": true + "hostConnectivityCheck": true }, "enableHostConnectivityCheck": { "$ref": "base_schema.json#/definitions/enableHostConnectivityCheck" }, "port": {