@itentialopensource/adapter-meraki 0.8.1 → 0.8.4
Sign up to get free protection for your applications and to get access to all the features.
- package/AUTH.md +14 -15
- package/BROKER.md +199 -0
- package/CALLS.md +158 -89
- package/CHANGELOG.md +68 -26
- package/CODE_OF_CONDUCT.md +12 -17
- package/CONTRIBUTING.md +88 -74
- package/ENHANCE.md +14 -14
- package/PROPERTIES.md +483 -89
- package/README.md +131 -51
- package/SUMMARY.md +2 -2
- package/TROUBLESHOOT.md +4 -3
- package/adapter.js +174 -732
- package/adapterBase.js +841 -88
- package/entities/.generic/action.json +105 -0
- package/entities/.generic/schema.json +6 -1
- package/package.json +5 -3
- package/pronghorn.json +642 -563
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +393 -195
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1651511176919.json +115 -0
- package/report/updateReport1652488414759.json +120 -0
- package/sampleProperties.json +132 -3
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestIntegration.js +24 -107
- package/test/unit/adapterBaseTestUnit.js +10 -3
- package/test/unit/adapterTestUnit.js +38 -131
- package/utils/adapterInfo.js +206 -0
- package/utils/entitiesToDB.js +12 -57
- package/utils/pre-commit.sh +3 -0
- package/utils/tbScript.js +35 -20
- package/utils/tbUtils.js +49 -31
- package/utils/testRunner.js +16 -16
package/CHANGELOG.md
CHANGED
|
@@ -1,23 +1,48 @@
|
|
|
1
1
|
|
|
2
|
-
## 0.8.
|
|
2
|
+
## 0.8.4 [05-14-2022]
|
|
3
3
|
|
|
4
|
-
*
|
|
4
|
+
* Migrate the adapter to the latest foundation
|
|
5
5
|
|
|
6
|
-
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!
|
|
6
|
+
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!19
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
## 0.8.0 [01-21-2022]
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
10
|
+
## 0.8.3 [05-08-2022] & 0.8.2 [05-02-2022] & 0.8.1 [04-13-2022] & 0.8.0 [01-21-2022]
|
|
11
|
+
|
|
12
|
+
- Multiple versions and releases due to this being one of the adapters heavily involved in the new addapter/broker integration effort.
|
|
13
|
+
- Add some items to .gitignore (e.g. DS_Store) to keep them out of the repos.
|
|
14
|
+
- Changes to the README (some typo fixes - Add how to extend the adapter). Split the README into various markdown files (AUTH, BROKER, CALLS, ENHANCE, PROPERTIES, SUMMARY, SYSTEMINFO, TROUBLESHOOT)
|
|
15
|
+
- Fix the issues with Confluence in the markdowns (Tables, Lists, Links)
|
|
16
|
+
- Add scripts for easier authentication, removing hooks, etc
|
|
17
|
+
- Script changes (install script as well as database changes in other scripts)
|
|
18
|
+
- Double # of path vars on generic call
|
|
19
|
+
- Update versions of foundation (e.g. adapter-utils)
|
|
20
|
+
- Update npm publish so it supports https
|
|
21
|
+
- Update dependencies
|
|
22
|
+
- Add preinstall for minimist
|
|
23
|
+
- Fix new lint issues that came from eslint dependency change
|
|
24
|
+
- Add more thorough Unit tests for standard files (Package, Pronghorn, Properties (Schema and Sample)
|
|
25
|
+
- Add the adapter type in the package.json
|
|
26
|
+
- Add AdapterInfo.js script
|
|
27
|
+
- Add json-query dependency
|
|
28
|
+
- Add the propertiesDecorators.json for product encryption
|
|
29
|
+
- Change the name of internal IAP/Adapter methods to avoid collisions and make more obvious in Workflow - iapRunAdapterBasicGet, iapRunAdapterConnectivity, iapRunAdapterHealthcheck, iapTroubleshootAdapter, iapGetAdapterQueue, iapUnsuspendAdapter, iapSuspendAdapter, iapFindAdapterPath, iapUpdateAdapterConfiguration, iapGetAdapterWorkflowFunctions
|
|
30
|
+
- Add the adapter config in the database support - iapMoveAdapterEntitiesToDB
|
|
31
|
+
- Add standard broker calls - hasEntities, getDevice, getDevicesFiltered, isAlive, getConfig and iapGetDeviceCount
|
|
32
|
+
- Add genericAdapterRequest that does not use the base_path and version so that the path can be unique - genericAdapterRequestNoBasePath
|
|
33
|
+
- Add AdapterInfo.json
|
|
34
|
+
- Add systemName for documentation
|
|
35
|
+
|
|
36
|
+
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!18
|
|
37
|
+
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!17
|
|
38
|
+
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!16
|
|
14
39
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!15
|
|
15
40
|
|
|
16
41
|
---
|
|
17
42
|
|
|
18
43
|
## 0.7.3 [06-08-2021]
|
|
19
44
|
|
|
20
|
-
|
|
45
|
+
- Update pronghorn.json and adpater.js for sending api call body directly
|
|
21
46
|
|
|
22
47
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!14
|
|
23
48
|
|
|
@@ -25,7 +50,19 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!14
|
|
|
25
50
|
|
|
26
51
|
## 0.7.2 [03-10-2021]
|
|
27
52
|
|
|
28
|
-
|
|
53
|
+
- migration to bring up to the latest foundation
|
|
54
|
+
- Change to .eslintignore (adapter_modification directory)
|
|
55
|
+
- Change to README.md (new properties, new scripts, new processes)
|
|
56
|
+
- Changes to adapterBase.js (new methods)
|
|
57
|
+
- Changes to package.json (new scripts, dependencies)
|
|
58
|
+
- Changes to propertiesSchema.json (new properties and changes to existing)
|
|
59
|
+
- Changes to the Unit test
|
|
60
|
+
- Adding several test files, utils files and .generic entity
|
|
61
|
+
- Fix order of scripts and dependencies in package.json
|
|
62
|
+
- Fix order of properties in propertiesSchema.json
|
|
63
|
+
- Update sampleProperties, unit and integration tests to have all new properties.
|
|
64
|
+
- Add all new calls to adapter.js and pronghorn.json
|
|
65
|
+
- Add suspend piece to older methods
|
|
29
66
|
|
|
30
67
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!13
|
|
31
68
|
|
|
@@ -33,7 +70,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!13
|
|
|
33
70
|
|
|
34
71
|
## 0.7.1 [07-08-2020]
|
|
35
72
|
|
|
36
|
-
|
|
73
|
+
- Update to the latest adapter foundation
|
|
37
74
|
|
|
38
75
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!12
|
|
39
76
|
|
|
@@ -41,7 +78,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!12
|
|
|
41
78
|
|
|
42
79
|
## 0.7.0 [03-02-2020]
|
|
43
80
|
|
|
44
|
-
|
|
81
|
+
- Add new version calls based on additional query parameters that Meraki has made available.
|
|
45
82
|
|
|
46
83
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!11
|
|
47
84
|
|
|
@@ -49,7 +86,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!11
|
|
|
49
86
|
|
|
50
87
|
## 0.6.0 [02-03-2020]
|
|
51
88
|
|
|
52
|
-
|
|
89
|
+
- Add new calls to the adapter that were in the new Postman Collection for Meraki (built swagger and put in report)
|
|
53
90
|
|
|
54
91
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!10
|
|
55
92
|
|
|
@@ -57,7 +94,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!10
|
|
|
57
94
|
|
|
58
95
|
## 0.5.2 [01-13-2020]
|
|
59
96
|
|
|
60
|
-
|
|
97
|
+
- Bring the adapter up to the latest adapter foundation
|
|
61
98
|
|
|
62
99
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!8
|
|
63
100
|
|
|
@@ -65,7 +102,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!8
|
|
|
65
102
|
|
|
66
103
|
## 0.5.1 [11-19-2019]
|
|
67
104
|
|
|
68
|
-
|
|
105
|
+
- Update the healthcheck url to one that was used in the lab
|
|
69
106
|
|
|
70
107
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!7
|
|
71
108
|
|
|
@@ -73,7 +110,18 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!7
|
|
|
73
110
|
|
|
74
111
|
## 0.5.0 [11-08-2019]
|
|
75
112
|
|
|
76
|
-
|
|
113
|
+
- Update the adapter to the latest adapter foundation.
|
|
114
|
+
- Updating to adapter-utils 4.24.3 (automatic)
|
|
115
|
+
- Add sample token schemas (manual)
|
|
116
|
+
- Adding placement property to getToken response schema (manual - before encrypt)
|
|
117
|
+
- Adding sso default into action.json for getToken (manual - before response object)
|
|
118
|
+
- Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
|
|
119
|
+
- Update sample properties to include new properties (manual)
|
|
120
|
+
- Update integration test for raw mockdata (automatic)
|
|
121
|
+
- Update test properties (manual)
|
|
122
|
+
- Changes to artifactize (automatic)
|
|
123
|
+
- Update type in sampleProperties so it is correct for the adapter (manual)
|
|
124
|
+
- Update the readme (automatic)
|
|
77
125
|
|
|
78
126
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!6
|
|
79
127
|
|
|
@@ -81,7 +129,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!6
|
|
|
81
129
|
|
|
82
130
|
## 0.4.0 [09-17-2019]
|
|
83
131
|
|
|
84
|
-
|
|
132
|
+
- Update the adapter to the latest adapter foundation
|
|
85
133
|
|
|
86
134
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!5
|
|
87
135
|
|
|
@@ -89,27 +137,21 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!5
|
|
|
89
137
|
|
|
90
138
|
## 0.3.1 [08-30-2019]
|
|
91
139
|
|
|
92
|
-
|
|
140
|
+
- Added the slash into the entity paths. Migrator does not currently update action files. This was fixed in the adapter builder a while ago but needed to be manually fixed in this adapter.
|
|
93
141
|
|
|
94
142
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!4
|
|
95
143
|
|
|
96
|
-
---
|
|
97
|
-
## 0.3.0 [07-30-2019]
|
|
98
|
-
* migratation, categorization and artifactize
|
|
99
|
-
|
|
100
|
-
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!3
|
|
101
|
-
|
|
102
144
|
---
|
|
103
145
|
|
|
104
|
-
## 0.2.0 [07-18-2019]
|
|
105
|
-
|
|
146
|
+
## 0.3.0 [07-30-2019] & 0.2.0 [07-18-2019]
|
|
147
|
+
- Migrate to the latest adapter foundation, categorize and prepare for app artifact
|
|
106
148
|
|
|
107
149
|
See merge request itentialopensource/adapters/sd-wan/adapter-meraki!3
|
|
108
150
|
|
|
109
151
|
---
|
|
110
152
|
|
|
111
153
|
## 0.1.1 [06-18-2019]
|
|
112
|
-
|
|
154
|
+
- Initial Commit
|
|
113
155
|
|
|
114
156
|
See merge request itentialopensource/adapters/adapter-meraki!2
|
|
115
157
|
|
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
|
|
|
8
8
|
|
|
9
9
|
Examples of behavior that contributes to creating a positive environment include:
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
- Using welcoming and inclusive language
|
|
12
|
+
- Being respectful of differing viewpoints and experiences
|
|
13
|
+
- Gracefully accepting constructive criticism
|
|
14
|
+
- Focusing on what is best for the community
|
|
15
|
+
- Showing empathy towards other community members
|
|
16
16
|
|
|
17
17
|
Examples of unacceptable behavior by participants include:
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
19
|
+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
|
20
|
+
- Trolling, insulting/derogatory comments, and personal or political attacks
|
|
21
|
+
- Public or private harassment
|
|
22
|
+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
|
23
|
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
24
24
|
|
|
25
25
|
## Our Responsibilities
|
|
26
26
|
|
|
@@ -34,15 +34,10 @@ This Code of Conduct applies both within project spaces and in public spaces whe
|
|
|
34
34
|
|
|
35
35
|
## Enforcement
|
|
36
36
|
|
|
37
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
|
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
|
38
38
|
|
|
39
39
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
|
40
40
|
|
|
41
41
|
## Attribution
|
|
42
42
|
|
|
43
|
-
This Code of Conduct is adapted from the
|
|
44
|
-
|
|
45
|
-
[homepage]: http://contributor-covenant.org
|
|
46
|
-
[version]: http://contributor-covenant.org/version/1/4/
|
|
47
|
-
|
|
48
|
-
_return to [README](../README.md)_
|
|
43
|
+
This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>
|
package/CONTRIBUTING.md
CHANGED
|
@@ -1,29 +1,12 @@
|
|
|
1
1
|
# Contributing
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
First off, thanks for taking the time to contribute!
|
|
4
4
|
|
|
5
5
|
The following is a set of rules for contributing.
|
|
6
6
|
|
|
7
|
-
## Table Of Contents
|
|
8
|
-
|
|
9
|
-
[Code of Conduct](#code-of-conduct)
|
|
10
|
-
|
|
11
|
-
[How Can I Contribute?](#how-can-i-contribute)
|
|
12
|
-
|
|
13
|
-
* [Reporting Bugs](#reporting-bugs)
|
|
14
|
-
* [Your First Code Contribution](#your-first-code-contribution)
|
|
15
|
-
* [Merge Requests](#merge-requests)
|
|
16
|
-
|
|
17
|
-
[Styleguides](#styleguides)
|
|
18
|
-
|
|
19
|
-
* [Git Commit Messages](#git-commit-messages)
|
|
20
|
-
* [JavaScript Styleguide](#javascript-styleguide)
|
|
21
|
-
* [Tests Styleguide](#tests-styleguide)
|
|
22
|
-
* [Documentation Styleguide](#documentation-styleguide)
|
|
23
|
-
|
|
24
7
|
## Code of Conduct
|
|
25
8
|
|
|
26
|
-
This project and everyone participating in it is governed by the
|
|
9
|
+
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
|
|
27
10
|
|
|
28
11
|
## How to Contribute
|
|
29
12
|
|
|
@@ -31,45 +14,45 @@ This project and everyone participating in it is governed by the [Code of Conduc
|
|
|
31
14
|
|
|
32
15
|
This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :left_right_arrow: :computer:, and find related reports :mag_right:.
|
|
33
16
|
|
|
34
|
-
Before creating bug reports, please check
|
|
17
|
+
Before creating bug reports, please check before-submitting-a-bug-report, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you have an Itential support contract, please create an Itential Service Desk ticket. If you don't have an Itential support contract, please send an email of the issue to support@itential.com.
|
|
35
18
|
|
|
36
19
|
#### Before Submitting A Bug Report
|
|
37
20
|
|
|
38
|
-
* **Check the
|
|
21
|
+
* **Check the README.md.** You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem __in the latest version__.
|
|
39
22
|
* **Work through the troubleshooting process.** Troubleshooting will include changing the log level of Itential Automation Platform (IAP) and adapters and checking the logs to see what the issues are. These logs should be included in any ticket you open for this issue.
|
|
40
|
-
* **Check for resolutions to the issue.** Check the
|
|
23
|
+
* **Check for resolutions to the issue.** Check the <a href="https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921" target="_blank">Itential Knowledge Base</a> to see if there is a known resolution for the issue you are having.
|
|
41
24
|
* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
|
|
42
25
|
|
|
43
26
|
#### How to Submit a (Good) Bug Report
|
|
44
27
|
|
|
45
28
|
Bugs are tracked through the Itential Service Desk. Explain the problem and include additional details to help maintainers reproduce the problem:
|
|
46
29
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
30
|
+
- **Use a clear and descriptive title** for the issue to identify the problem.
|
|
31
|
+
- **Describe the exact steps which reproduce the problem** in as much detail as possible. For example, start by explaining how you configured the adapter (e.g., which properties you used and how they were set) or how you are using an artifact.
|
|
32
|
+
- **Provide specific examples to demonstrate the steps**. Include logs, or copy/paste snippets, in your examples.
|
|
33
|
+
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
|
34
|
+
- **Explain which behavior you expected to see instead and why.**
|
|
35
|
+
- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/" target="_blank">this tool</a> to record GIFs on macOS and Windows. Use <a href="https://github.com/colinkeenan/silentcast" target="_blank">this tool</a> or <a href="https://github.com/rhcarvalho/byzanz-guiz" target="_blank">program</a> on Linux.
|
|
36
|
+
- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
|
|
54
37
|
|
|
55
38
|
Provide more context by answering these questions:
|
|
56
39
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
40
|
+
- **Did the problem start happening recently** (e.g. after updating to a new version/tag) or was this always a problem?
|
|
41
|
+
- If the problem started happening recently, **can you reproduce the problem in an older version/tag?** What's the most recent version in which the problem does not happen?
|
|
42
|
+
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
|
60
43
|
|
|
61
44
|
Include details about your configuration and environment:
|
|
62
45
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
46
|
+
- **Which version of the adapter/artifact are you using?** You can get the exact version by checking the project version in the package.json file.
|
|
47
|
+
- **What's the name and version of the OS you're using**?
|
|
48
|
+
- **Are you running or using IAP in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and guest?
|
|
49
|
+
- **Are there firewalls between IAP and any other system you are integrating with?** If so, have you tried running curl from the system IAP is on to the other system to verify you have connectivity between the systems?
|
|
67
50
|
|
|
68
51
|
### Your First Code Contribution
|
|
69
52
|
|
|
70
53
|
#### Local development
|
|
71
54
|
|
|
72
|
-
This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the
|
|
55
|
+
This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the README.md. The README.mdprovides many more details on cloning the repository for local development, how to lint and test your changes.
|
|
73
56
|
|
|
74
57
|
#### Development Process
|
|
75
58
|
|
|
@@ -92,17 +75,50 @@ Make all of the desired changes.
|
|
|
92
75
|
|
|
93
76
|
> **Note:** All code changes should be accompanied by additional Unit and Integration tests to minimize the likelihood that any changes will negatively impact the adapter/artifact as well as to ensure the desired functionality is achieved.
|
|
94
77
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
78
|
+
|
|
79
|
+
<table border="1" class="bordered-table">
|
|
80
|
+
<tr>
|
|
81
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Files</span></th>
|
|
82
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Changes</span></th>
|
|
83
|
+
</tr>
|
|
84
|
+
<tr>
|
|
85
|
+
<td style="padding:15px">.codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore</td>
|
|
86
|
+
<td style="padding:15px">These are foundational files that are used in linting and building of the adapter. Changes to these files are heavily scrutinized and may be implemented in a different manner so that the changes can be implemented across all adapters.</td>
|
|
87
|
+
</tr>
|
|
88
|
+
<tr>
|
|
89
|
+
<td style="padding:15px">CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md</td>
|
|
90
|
+
<td style="padding:15px">These are license and process files for the repository. Changes to these files may require legal review and may also be implemented in a different manner so that the changes can be implemented across all adapters.</td>
|
|
91
|
+
</tr>
|
|
92
|
+
<tr>
|
|
93
|
+
<td style="padding:15px">utils/*, adapterBase.js</td>
|
|
94
|
+
<td style="padding:15px">Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.</td>
|
|
95
|
+
</tr>
|
|
96
|
+
<tr>
|
|
97
|
+
<td style="padding:15px">adapter.js</td>
|
|
98
|
+
<td style="padding:15px">Changes to this file are code changes. They should be accompanied by the appropriate unit and integration tests. If new methods are added, they should also be added to the pronghorn.json file, otherwise integration tests are likely to fail.</td>
|
|
99
|
+
</tr>
|
|
100
|
+
<tr>
|
|
101
|
+
<td style="padding:15px">error.json, propertiesSchema.json</td>
|
|
102
|
+
<td style="padding:15px">These files are utilized by the Itential Runtime libraries. You can make changes to these files, but the changes should be appending of new errors or properties. Removal of errors and properties can result in rejection of the changes.</td>
|
|
103
|
+
</tr>
|
|
104
|
+
<tr>
|
|
105
|
+
<td style="padding:15px">pacakge.json, package-lock.json</td>
|
|
106
|
+
<td style="padding:15px">The package-lock.json is automatically generated and should only be updated when the dependencies inside of the package.json are modified. You can make changes to the package.json to add additional scripts, add new dependencies, modify names, etc. However, changing the scripts or dependencies that are Itential specific will be overriden during the acceptance process.</td>
|
|
107
|
+
</tr>
|
|
108
|
+
<tr>
|
|
109
|
+
<td style="padding:15px">pronghorn.json</td>
|
|
110
|
+
<td style="padding:15px">Changes to this file are made for integration into IAP. The most common change here is adding new methods that shoud be exposed to the IAP Workflow.</td>
|
|
111
|
+
</tr>
|
|
112
|
+
<tr>
|
|
113
|
+
<td style="padding:15px">entities/*</td>
|
|
114
|
+
<td style="padding:15px">Changes to these files include adding new capabilities, updating existing capabilities, or removing deprecated capabilities in the adapter. Translation configuration can also be modified here.</td>
|
|
115
|
+
</tr>
|
|
116
|
+
<tr>
|
|
117
|
+
<td style="padding:15px">test/*</td>
|
|
118
|
+
<td style="padding:15px">Changes to these files include adding, updating, or removing unit and integration tests in the adapter. Tests should never be removed unless the methods that are being tested are removed also. Both the unit and integration test file should have a marker that identifies where modification can take place. Modifications above that marker are likely to be rejected or implemented in a different manner.</td>
|
|
119
|
+
</tr>
|
|
120
|
+
</table>
|
|
121
|
+
<br>
|
|
106
122
|
|
|
107
123
|
> **Note:** It is a best practice to lint and test your code prior to committing changes into the repository. You can lint your code by running **npm run lint** and test it by running **node utils/testRunner.sh**. However, there are pre-commit hooks that will run these scripts when you commit your changes.
|
|
108
124
|
|
|
@@ -120,39 +136,37 @@ Push the changes into the repository. This should only be done after the commit
|
|
|
120
136
|
git push origin <name_of_your_new_branch>
|
|
121
137
|
```
|
|
122
138
|
|
|
123
|
-
Create a
|
|
139
|
+
Create a Merge Request.
|
|
124
140
|
|
|
125
141
|
### Merge Requests
|
|
126
142
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
143
|
+
- Fill out the provided merge request template.
|
|
144
|
+
- Reference related issues and merge requests liberally.
|
|
145
|
+
- Include screenshots and animated GIFs in your merge request whenever possible.
|
|
146
|
+
- Follow the project Styleguide.
|
|
147
|
+
- End all files with a newline.
|
|
132
148
|
|
|
133
149
|
## Styleguide
|
|
134
150
|
|
|
135
151
|
### Git Commit Messages
|
|
136
152
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
153
|
+
- Use the present tense ("Add feature" not "Added feature")
|
|
154
|
+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
|
155
|
+
- Consider starting the commit message with an applicable emoji _(not required)_:
|
|
156
|
+
- :art: `:art:` When improving the format/structure of the code.
|
|
157
|
+
- :racehorse: `:racehorse:` When improving performance
|
|
158
|
+
- :non-potable_water: `:non-potable_water:` When plugging memory leaks.
|
|
159
|
+
- :memo: `:memo:` When writing documentation.
|
|
160
|
+
- :penguin: `:penguin:` When fixing something on Linux.
|
|
161
|
+
- :apple: `:apple:` When fixing something on macOS.
|
|
162
|
+
- :checkered_flag: `:checkered_flag:` When fixing something on Windows.
|
|
163
|
+
- :bug: `:bug:` When fixing a bug.
|
|
164
|
+
- :fire: `:fire:` When removing code or files.
|
|
165
|
+
- :green_heart: `:green_heart:` When fixing the CI build.
|
|
166
|
+
- :white_check_mark: `:white_check_mark:` When adding tests,
|
|
167
|
+
- :lock: `:lock:` When dealing with security.
|
|
168
|
+
- :arrow_up: `:arrow_up:` When upgrading dependencies.
|
|
169
|
+
- :arrow_down: `:arrow_down:` When downgrading dependencies.
|
|
170
|
+
- :shirt: `:shirt:` When removing linter warnings.
|
|
155
171
|
|
|
156
172
|
__Avoid installing unnecessary packages.__ Do not install packages just because they might be "nice to have". Itential Opensource projects are supposed to be minimal, specific, and compact by design.
|
|
157
|
-
|
|
158
|
-
_return to [README](./README.md)_
|
package/ENHANCE.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
|
|
1
|
+
## Enhancements
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
### Adding a Second Instance of an Adapter
|
|
4
4
|
|
|
5
|
-
You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances of the other system.
|
|
5
|
+
You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### Adding Adapter Calls
|
|
8
8
|
|
|
9
9
|
There are multiple ways to add calls to an existing adapter.
|
|
10
10
|
|
|
11
|
-
The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file
|
|
11
|
+
The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute `npm run adapter:update`.
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
mv updatePackage.zip adapter-meraki
|
|
@@ -18,7 +18,7 @@ npm run adapter:update
|
|
|
18
18
|
|
|
19
19
|
If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
|
|
20
20
|
|
|
21
|
-
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on Dev Site
|
|
21
|
+
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
|
|
22
22
|
|
|
23
23
|
```text
|
|
24
24
|
Files to update
|
|
@@ -30,7 +30,7 @@ Files to update
|
|
|
30
30
|
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
### Adding Adapter Properties
|
|
34
34
|
|
|
35
35
|
While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
|
|
36
36
|
|
|
@@ -42,22 +42,22 @@ Files to update
|
|
|
42
42
|
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
### Changing Adapter Authentication
|
|
46
46
|
|
|
47
|
-
Often an adapter is built before knowing the authentication and authentication
|
|
47
|
+
Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
|
|
48
48
|
|
|
49
49
|
```text
|
|
50
50
|
Files to update
|
|
51
|
-
* entities
|
|
52
|
-
* entities
|
|
53
|
-
* entities
|
|
51
|
+
* entities/.system/action.json: change the getToken action as needed
|
|
52
|
+
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
|
|
53
|
+
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
|
|
54
54
|
* propertiesSchema.json: add any new property and how it is defined
|
|
55
55
|
* sampleProperties: add any new property with a default value
|
|
56
56
|
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
|
|
57
57
|
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
|
|
60
|
+
### Enhancing Adapter Integration Tests
|
|
61
61
|
|
|
62
62
|
The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
|
|
63
63
|
|
|
@@ -66,4 +66,4 @@ Files to update
|
|
|
66
66
|
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on Dev Site
|
|
69
|
+
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
|