conjur-api 5.3.1 → 5.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.codeclimate.yml +3 -1
- data/.github/ISSUE_TEMPLATE/bug.md +27 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +27 -0
- data/.gitignore +1 -0
- data/.gitleaks.toml +219 -0
- data/.rubocop_settings.yml +3 -2
- data/.rubocop_todo.yml +2 -2
- data/CHANGELOG.md +333 -179
- data/CONTRIBUTING.md +149 -0
- data/Gemfile +1 -1
- data/Jenkinsfile +24 -3
- data/LICENSE +202 -0
- data/README.md +6 -140
- data/bin/parse-changelog.sh +12 -0
- data/bin/release +43 -0
- data/ci/codeclimate.dockerfile +6 -0
- data/conjur-api.gemspec +4 -1
- data/docker-compose.yml +2 -0
- data/features/authenticators.feature +33 -0
- data/features/support/env.rb +2 -0
- data/features/update_password.feature +2 -2
- data/features_v4/support/env.rb +2 -0
- data/lib/conjur-api/version.rb +1 -1
- data/lib/conjur/api.rb +1 -0
- data/lib/conjur/api/authenticators.rb +35 -0
- data/lib/conjur/api/router/v5.rb +13 -0
- data/lib/conjur/base_object.rb +5 -0
- data/lib/conjur/cert_utils.rb +14 -0
- data/lib/conjur/configuration.rb +1 -7
- data/spec/base_object_spec.rb +14 -0
- data/spec/cert_utils_spec.rb +92 -0
- data/spec/spec_helper.rb +3 -0
- data/test.sh +13 -0
- metadata +22 -10
- data/LICENSE.md +0 -195
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,149 @@
|
|
1
|
+
# Contributing
|
2
|
+
|
3
|
+
For general contribution and community guidelines, please see the [community repo](https://github.com/cyberark/community).
|
4
|
+
|
5
|
+
## Contributing
|
6
|
+
|
7
|
+
1. [Fork the project](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
|
8
|
+
2. [Clone your fork](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
|
9
|
+
3. Make local changes to your fork by editing files
|
10
|
+
3. [Commit your changes](https://help.github.com/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line)
|
11
|
+
4. [Push your local changes to the remote server](https://help.github.com/en/github/using-git/pushing-commits-to-a-remote-repository)
|
12
|
+
5. [Create new Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
|
13
|
+
|
14
|
+
From here your pull request will be reviewed and once you've responded to all
|
15
|
+
feedback it will be merged into the project. Congratulations, you're a
|
16
|
+
contributor!
|
17
|
+
|
18
|
+
|
19
|
+
## Development (V5)
|
20
|
+
To develop and run tests against Conjur V5, use the `start` and `stop` scripts in the `dev` folder. The start script brings up an open source Conjur (and Postgres database), CLI container, and a "work" container, with the gem code mounted into the working directory.
|
21
|
+
|
22
|
+
### Starting a Shell
|
23
|
+
To begin:
|
24
|
+
```sh
|
25
|
+
$ cd dev
|
26
|
+
$ ./start
|
27
|
+
...
|
28
|
+
root@9df0ac10ada2:/src/conjur-api#
|
29
|
+
```
|
30
|
+
You'll be dropped into development container upon completion. From there, install the development gems:
|
31
|
+
|
32
|
+
```sh
|
33
|
+
root@9df0ac10ada2:/src/conjur-api# bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
#### Running Tests
|
37
|
+
*NOTE*: There are some existing challenges around running tests from the development console. For now, run tests
|
38
|
+
by using the `./test.sh` script utilized for Jenkins Pipelines.
|
39
|
+
|
40
|
+
<!--
|
41
|
+
Commented out until I can get tests running locally
|
42
|
+
|
43
|
+
Tests can be run with:
|
44
|
+
```sh
|
45
|
+
root@9df0ac10ada2:/src/conjur-api# bundle exec cucumber features
|
46
|
+
root@9df0ac10ada2:/src/conjur-api# bundle exec rspec
|
47
|
+
```
|
48
|
+
-->
|
49
|
+
|
50
|
+
#### Stopping & Environment Cleanup
|
51
|
+
Once you're done, exit the shell, and stop the containers:
|
52
|
+
|
53
|
+
```sh
|
54
|
+
root@9df0ac10ada2:/src/conjur-api# exit
|
55
|
+
$ ./stop
|
56
|
+
```
|
57
|
+
|
58
|
+
## Development (V4)
|
59
|
+
|
60
|
+
The file `docker-compose.yml` is a self-contained development environment for the project.
|
61
|
+
|
62
|
+
### Starting
|
63
|
+
|
64
|
+
To bring it up, run:
|
65
|
+
|
66
|
+
```sh-session
|
67
|
+
$ docker-compose build
|
68
|
+
$ docker-compose up -d pg conjur_4 conjur_5
|
69
|
+
```
|
70
|
+
|
71
|
+
Then configure the v4 and v5 servers:
|
72
|
+
|
73
|
+
```sh-session
|
74
|
+
$ ./ci/configure_v4.sh
|
75
|
+
...
|
76
|
+
$ ./ci/configure_v5.sh
|
77
|
+
...
|
78
|
+
```
|
79
|
+
|
80
|
+
### Using
|
81
|
+
|
82
|
+
Obtain the API key for the v5 admin user:
|
83
|
+
|
84
|
+
```
|
85
|
+
$ docker-compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]'
|
86
|
+
3aezp05q3wkem3hmegymwzz8wh3bs3dr6xx3y3m2q41k5ymebkc
|
87
|
+
```
|
88
|
+
|
89
|
+
The password of the v4 admin user is "secret".
|
90
|
+
|
91
|
+
Now you can run the client `dev` container:
|
92
|
+
|
93
|
+
```sh-session
|
94
|
+
$ docker-compose run --rm dev
|
95
|
+
```
|
96
|
+
|
97
|
+
This gives you a shell session with `conjur_4` and `conjur_5` available as linked containers.
|
98
|
+
|
99
|
+
### Demos
|
100
|
+
|
101
|
+
For a v5 demo, run:
|
102
|
+
|
103
|
+
```sh-session
|
104
|
+
$ bundle exec ./example/demo_v5.rb <admin-api-key>
|
105
|
+
```
|
106
|
+
|
107
|
+
For a v4 demo, run:
|
108
|
+
|
109
|
+
```sh-session
|
110
|
+
$ bundle exec ./example/demo_v4.rb
|
111
|
+
```
|
112
|
+
|
113
|
+
### Stopping
|
114
|
+
|
115
|
+
To bring it down, run:
|
116
|
+
|
117
|
+
```sh-session
|
118
|
+
$ docker-compose down
|
119
|
+
```
|
120
|
+
|
121
|
+
## Releasing
|
122
|
+
|
123
|
+
Releasing a new version of this Gem involves a two step process:
|
124
|
+
1. Tag and Release (using `bin/release`)
|
125
|
+
2. Approving the push to RubyGems in Jenkins
|
126
|
+
|
127
|
+
### Step 1: Tag and Release
|
128
|
+
|
129
|
+
First, update the following files:
|
130
|
+
|
131
|
+
- The version file (`lib/conjur-api/version.rb`) has been updated with an appropriate Semantic version number.
|
132
|
+
- The `CHANGELOG.md` file has been updated to reflect the release version and appropriate release notes.
|
133
|
+
|
134
|
+
Next, save -- but do not commit -- the changes above.
|
135
|
+
|
136
|
+
Finally, when you're ready to release, run the following:
|
137
|
+
|
138
|
+
```sh
|
139
|
+
$ bin/release
|
140
|
+
```
|
141
|
+
|
142
|
+
### Step 2: Approve the push to RubyGems in Jenkins
|
143
|
+
|
144
|
+
- Navigate to Jenkins: https://jenkins.conjur.net/job/cyberark--conjur-api-ruby/job/master/.
|
145
|
+
- Once the pipeline reaches the `Publish to RubyGems?` stage, click the blue box, and then click `Logs`.
|
146
|
+
- Open the confirmation step (`Wait for interactive input -- Publish to RubyGems?`), and click `Proceed`. Nothing appears to happen, but the "Publish" stage will be run.
|
147
|
+
- Finally, verify that the new library is present in RubyGems: https://rubygems.org/gems/conjur-api
|
148
|
+
|
149
|
+
The release is now complete.
|
data/Gemfile
CHANGED
data/Jenkinsfile
CHANGED
@@ -8,15 +8,35 @@ pipeline {
|
|
8
8
|
buildDiscarder(logRotator(numToKeepStr: '30'))
|
9
9
|
}
|
10
10
|
|
11
|
+
triggers {
|
12
|
+
cron(getDailyCronString())
|
13
|
+
}
|
14
|
+
|
11
15
|
stages {
|
16
|
+
stage('Validate') {
|
17
|
+
parallel {
|
18
|
+
stage('Changelog') {
|
19
|
+
steps { sh './bin/parse-changelog.sh' }
|
20
|
+
}
|
21
|
+
}
|
22
|
+
}
|
23
|
+
|
12
24
|
stage('Test') {
|
13
25
|
steps {
|
26
|
+
script {
|
27
|
+
ccCoverage.setGitEnvVars();
|
28
|
+
}
|
14
29
|
milestone(1)
|
15
30
|
sh './test.sh'
|
31
|
+
}
|
16
32
|
|
17
|
-
|
18
|
-
|
19
|
-
|
33
|
+
post {
|
34
|
+
always {
|
35
|
+
junit 'spec/reports/*.xml'
|
36
|
+
junit 'features/reports/*.xml'
|
37
|
+
junit 'features_v4/reports/*.xml'
|
38
|
+
cobertura autoUpdateHealth: true, autoUpdateStability: true, coberturaReportFile: 'coverage/coverage.xml', conditionalCoverageTargets: '100, 0, 0', failUnhealthy: true, failUnstable: false, lineCoverageTargets: '99, 0, 0', maxNumberOfBuilds: 0, methodCoverageTargets: '100, 0, 0', onlyStable: false, sourceEncoding: 'ASCII', zoomCoverageChart: false
|
39
|
+
}
|
20
40
|
}
|
21
41
|
}
|
22
42
|
|
@@ -59,6 +79,7 @@ pipeline {
|
|
59
79
|
deleteDir()
|
60
80
|
}
|
61
81
|
}
|
82
|
+
|
62
83
|
}
|
63
84
|
|
64
85
|
post {
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright (c) 2020 CyberArk Software Ltd. All rights reserved.
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -117,147 +117,13 @@ Conjur::API.new_from_key login, api_key
|
|
117
117
|
Note that if you are connecting as a [Host](http://developer.conjur.net/reference/services/directory/host), the login should be
|
118
118
|
prefixed with `host/`. For example: `host/myhost.example.com`, not just `myhost.example.com`.
|
119
119
|
|
120
|
+
## Contributing
|
120
121
|
|
121
|
-
|
122
|
-
|
122
|
+
We welcome contributions of all kinds to this repository. For instructions on how to get started and descriptions of our development workflows, please see our [contributing
|
123
|
+
guide][contrib].
|
123
124
|
|
124
|
-
|
125
|
-
To begin:
|
126
|
-
```sh
|
127
|
-
$ cd dev
|
128
|
-
$ ./start
|
129
|
-
...
|
130
|
-
root@9df0ac10ada2:/src/conjur-api#
|
131
|
-
```
|
132
|
-
You'll be dropped into development container upon completion. From there, install the development gems:
|
133
|
-
|
134
|
-
```sh
|
135
|
-
root@9df0ac10ada2:/src/conjur-api# bundle
|
136
|
-
```
|
137
|
-
|
138
|
-
#### Running Tests
|
139
|
-
*NOTE*: There are some existing challenges around running tests from the development console. For now, run tests
|
140
|
-
by using the `./test.sh` script utilized for Jenkins Pipelines.
|
141
|
-
|
142
|
-
<!--
|
143
|
-
Commented out until I can get tests running locally
|
144
|
-
|
145
|
-
Tests can be run with:
|
146
|
-
```sh
|
147
|
-
root@9df0ac10ada2:/src/conjur-api# bundle exec cucumber features
|
148
|
-
root@9df0ac10ada2:/src/conjur-api# bundle exec rspec
|
149
|
-
```
|
150
|
-
-->
|
151
|
-
|
152
|
-
#### Stopping & Environment Cleanup
|
153
|
-
Once you're done, exit the shell, and stop the containers:
|
154
|
-
|
155
|
-
```sh
|
156
|
-
root@9df0ac10ada2:/src/conjur-api# exit
|
157
|
-
$ ./stop
|
158
|
-
```
|
159
|
-
|
160
|
-
# Development (V4)
|
161
|
-
|
162
|
-
The file `docker-compose.yml` is a self-contained development environment for the project.
|
163
|
-
|
164
|
-
## Starting
|
165
|
-
|
166
|
-
To bring it up, run:
|
167
|
-
|
168
|
-
```sh-session
|
169
|
-
$ docker-compose build
|
170
|
-
$ docker-compose up -d pg conjur_4 conjur_5
|
171
|
-
```
|
172
|
-
|
173
|
-
Then configure the v4 and v5 servers:
|
174
|
-
|
175
|
-
```sh-session
|
176
|
-
$ ./ci/configure_v4.sh
|
177
|
-
...
|
178
|
-
$ ./ci/configure_v5.sh
|
179
|
-
...
|
180
|
-
```
|
181
|
-
|
182
|
-
## Using
|
183
|
-
|
184
|
-
Obtain the API key for the v5 admin user:
|
185
|
-
|
186
|
-
```
|
187
|
-
$ docker-compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]'
|
188
|
-
3aezp05q3wkem3hmegymwzz8wh3bs3dr6xx3y3m2q41k5ymebkc
|
189
|
-
```
|
190
|
-
|
191
|
-
The password of the v4 admin user is "secret".
|
192
|
-
|
193
|
-
Now you can run the client `dev` container:
|
194
|
-
|
195
|
-
```sh-session
|
196
|
-
$ docker-compose run --rm dev
|
197
|
-
```
|
198
|
-
|
199
|
-
This gives you a shell session with `conjur_4` and `conjur_5` available as linked containers.
|
200
|
-
|
201
|
-
## Demos
|
202
|
-
|
203
|
-
For a v5 demo, run:
|
204
|
-
|
205
|
-
```sh-session
|
206
|
-
$ bundle exec ./example/demo_v5.rb <admin-api-key>
|
207
|
-
```
|
208
|
-
|
209
|
-
For a v4 demo, run:
|
210
|
-
|
211
|
-
```sh-session
|
212
|
-
$ bundle exec ./example/demo_v4.rb
|
213
|
-
```
|
214
|
-
|
215
|
-
## Stopping
|
216
|
-
|
217
|
-
To bring it down, run:
|
218
|
-
|
219
|
-
```sh-session
|
220
|
-
$ docker-compose down
|
221
|
-
```
|
222
|
-
|
223
|
-
# Releasing
|
224
|
-
Releasing a new version of this Gem involves a two step process:
|
225
|
-
1. Tag and Release (using `bin/release`)
|
226
|
-
2. Approving the push to RubyGems in Jenkins
|
227
|
-
|
228
|
-
Before releasing, make sure:
|
229
|
-
- The version file (`lib/conjur-api/version.rb`) has been updated with an appropriate Semantic version number.
|
230
|
-
- The `CHANGELOG.md` file has been updated to reflect the release version and appropriate release notes.
|
231
|
-
|
232
|
-
Save, but do not commit these the changes above. When your ready to release, run the following:
|
233
|
-
```sh
|
234
|
-
$ bin/release
|
235
|
-
```
|
236
|
-
|
237
|
-
Navigate to Jenkins, and approve: https://jenkins.conjur.net/job/cyberark--conjur-api-ruby/job/master/.
|
238
|
-
|
239
|
-
Finally, verify that the new library is present in RubyGems: https://rubygems.org/gems/conjur-api
|
240
|
-
|
241
|
-
# Contributing
|
242
|
-
|
243
|
-
1. Fork it
|
244
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
245
|
-
3. Commit your changes (`git commit -am 'Added some feature'`)
|
246
|
-
4. Push to the branch (`git push origin my-new-feature`)
|
247
|
-
5. Create new Pull Request
|
248
|
-
|
249
|
-
# License
|
250
|
-
|
251
|
-
Copyright 2016-2017 CyberArk
|
252
|
-
|
253
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
254
|
-
you may not use this software except in compliance with the License.
|
255
|
-
You may obtain a copy of the License at
|
125
|
+
[contrib]: https://github.com/cyberark/conjur-api-ruby/blob/master/CONTRIBUTING.md
|
256
126
|
|
257
|
-
|
127
|
+
## License
|
258
128
|
|
259
|
-
|
260
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
261
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
262
|
-
See the License for the specific language governing permissions and
|
263
|
-
limitations under the License.
|
129
|
+
This repository is licensed under Apache License 2.0 - see [`LICENSE`](LICENSE) for more details.
|