Merge pull request #4 from Conjur-Enterprise/remove-v4

CNJR-2935: Remove support for Conjur v4

Author: szh

.rubocop_todo.yml

@@ -309,8 +309,7 @@ Lint/UnneededSplatExpansion:
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/conjur/api.rb'
-    - 'lib/conjur/api/router/v4.rb'
-    - 'lib/conjur/api/router/v5.rb'
+    - 'lib/conjur/api/router.rb'
     - 'lib/conjur/base_object.rb'
     - 'lib/conjur/cache.rb'
     - 'lib/conjur/has_attributes.rb'
@@ -538,7 +537,7 @@ Style/MethodDefParentheses:
     - 'lib/conjur/acts_as_rolsource.rb'
     - 'lib/conjur/acts_as_user.rb'
     - 'lib/conjur/api.rb'
-    - 'lib/conjur/api/router/v5.rb'
+    - 'lib/conjur/api/router.rb'
     - 'lib/conjur/configuration.rb'
     - 'lib/conjur/escape.rb'
     - 'lib/conjur/has_attributes.rb'
@@ -552,8 +551,7 @@ Style/MethodDefParentheses:
 # SupportedStyles: module_function, extend_self
 Style/ModuleFunction:
   Exclude:
-    - 'lib/conjur/api/router/v4.rb'
-    - 'lib/conjur/api/router/v5.rb'
+    - 'lib/conjur/api/router.rb'
 
 # Offense count: 1
 Style/MultilineBlockChain:

CHANGELOG.md

@@ -9,7 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Nothing should go in this section, please add to the latest unreleased version
   (and update the corresponding date), or add a new version.
 
-## [5.4.2] - 2023-09-11
+## [6.0.0] - 2023-12-28
+
+### Removed
+- Remove support for Conjur V4 (CNJR-2935)
 
 ## [5.4.1] - 2023-06-14
 
@@ -386,8 +389,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [2.0.0] - 2013-13-12
 
-[Unreleased]: https://github.com/cyberark/conjur-api-ruby/compare/v5.4.1...HEAD
-[5.4.2]: https://github.com/cyberark/conjur-api-ruby/compare/v5.4.1...v5.4.2
+[Unreleased]: https://github.com/cyberark/conjur-api-ruby/compare/v6.0.0...HEAD
+[6.0.0]: https://github.com/cyberark/conjur-api-ruby/compare/v5.4.1...v6.0.0
 [5.4.1]: https://github.com/cyberark/conjur-api-ruby/compare/v5.4.0...v5.4.1
 [5.4.0]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.7...v5.4.0
 [5.3.7]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.6...v5.3.7

CONTRIBUTING.md

@@ -7,132 +7,88 @@ For general contribution and community guidelines, please see the [community rep
 1. [Fork the project](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
 2. [Clone your fork](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
 3. Make local changes to your fork by editing files
-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)
-4. [Push your local changes to the remote server](https://help.github.com/en/github/using-git/pushing-commits-to-a-remote-repository)
-5. [Create new Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
+4. [Commit your changes](https://help.github.com/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line)
+5. [Push your local changes to the remote server](https://help.github.com/en/github/using-git/pushing-commits-to-a-remote-repository)
+6. [Create new Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
 
 From here your pull request will be reviewed and once you've responded to all
 feedback it will be merged into the project. Congratulations, you're a
 contributor!
 
+## Development
 
-## Development (V5)
-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.
+To develop and run tests against Conjur, 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.
 
 ### Starting a Shell
+
 To begin:
+
 ```sh
 $ cd dev
 $ ./start
 ...
 root@9df0ac10ada2:/src/conjur-api#
 ```
+
 You'll be dropped into development container upon completion. From there, install the development gems:
 
 ```sh
 root@9df0ac10ada2:/src/conjur-api# bundle
 ```
 
 #### Running Tests
-*NOTE*: There are some existing challenges around running tests from the development console.  For now, run tests
-by using the `./test.sh` script utilized for Jenkins Pipelines.
-
-<!--
-Commented out until I can get tests running locally
 
 Tests can be run with:
+
 ```sh
 root@9df0ac10ada2:/src/conjur-api# bundle exec cucumber features
 root@9df0ac10ada2:/src/conjur-api# bundle exec rspec
 ```
--->
+
+Note: At the moment some of the cucumber tests are failing when run in the development container.
+You can use the CI script, `test.sh` to run the full test suite instead.
 
 #### Stopping & Environment Cleanup
+
 Once you're done, exit the shell, and stop the containers:
 
 ```sh
 root@9df0ac10ada2:/src/conjur-api# exit
 $ ./stop
 ```
 
-## Development (V4)
-
-The file `docker-compose.yml` is a self-contained development environment for the project.
-
-### Starting
-
-To bring it up, run:
-
-```sh-session
-$ docker compose build
-$ docker compose up -d pg conjur_4 conjur_5
-```
-
-Then configure the v4 and v5 servers:
-
-```sh-session
-$ ./ci/configure_v4.sh
-...
-$ ./ci/configure_v5.sh
-...
-```
-
-### Using
-
-Obtain the API key for the v5 admin user:
-
-```
-$ docker compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]'
-3aezp05q3wkem3hmegymwzz8wh3bs3dr6xx3y3m2q41k5ymebkc
-```
-
-The password of the v4 admin user is "secret".
-
-Now you can run the client `dev` container:
-
-```sh-session
-$ docker compose run --rm dev
-```
-
-This gives you a shell session with `conjur_4` and `conjur_5` available as linked containers.
-
 ### Demos
 
-For a v5 demo, run:
-
 ```sh-session
-$ bundle exec ./example/demo_v5.rb <admin-api-key>
-```
-
-For a v4 demo, run:
-
-```sh-session
-$ bundle exec ./example/demo_v4.rb
+bundle exec ./example/demo.rb <admin-api-key>
 ```
 
 ### Stopping
 
 To bring it down, run:
 
 ```sh-session
-$ docker compose down
+docker compose down
 ```
 
 ## Releasing
 
 ### Update the version and changelog
 
 1. Create a new branch for the version bump.
+1. Based on the changelog content, determine the new version number and update.
+1. Review the [changelog](CHANGELOG.md) to make sure all relevant changes since
+   the last release have been captured. You may find it helpful to look at the
+   list of commits since the last release.
+
+   This is also a good time to make sure all entries conform to our
+   [changelog guidelines](https://github.com/cyberark/community/blob/main/Conjur/CONTRIBUTING.md#changelog-guidelines).
 1. Commit these changes - `Bump version to x.y.z` is an acceptable commit message - and open a PR
    for review. Your PR should include updates to `CHANGELOG.md`.
 
-### Add a git tag
-
-1. Once your changes have been **reviewed and merged into main**, tag the version
-   using `git tag -a "vx.y.z" -m "vx.y.z release"`. Note this requires you to be able to sign releases.
-   Consult the [github documentation on signing commits](https://help.github.com/articles/signing-commits-with-gpg/)
-   on how to set this up. `vx.y.z release` is an acceptable tag message.
-1. Push the tag: `git push vx.y.z` (or `git push origin vx.y.z` if you are working
-   from your local machine).
+### Release and Promote
 
-After pushing the tag, a matching version will be published to [RubyGems](https://rubygems.org/gems/conjur-api/versions)!
+1. Jenkins build parameters can be utilized to release and promote successful builds.
+1. Merging into main/master branches will automatically trigger a release.
+1. Reference the [internal automated release doc](https://github.com/conjurinc/docs/blob/master/reference/infrastructure/automated_releases.md#release-and-promotion-process)
+   for releasing and promoting.

README.md

@@ -4,26 +4,6 @@ Programmatic Ruby access to the Conjur API.
 
 RDocs are available from the through the [Ruby Gem details page](https://rubygems.org/gems/conjur-api)
 
-# Server Versions
-
-The Conjur server comes in two major versions:
-
-* **4.x** Conjur 4 is a commercial, non-open-source product, which is documented at [https://developer.conjur.net/](https://developer.conjur.net/).
-* **5.x** Conjur 5 is open-source software, hosted and documented at [https://www.conjur.org/](https://www.conjur.org/).
-
-You can use the `main` branch of this project, which is `conjur-api` version `5.x`, to do all of the following things against either type of Conjur server:
-
-* Authenticate
-* Fetch secrets
-* Check permissions
-* List roles, resources, members, memberships and permitted roles.
-* Create hosts using host factory
-* Rotate API keys
-
-Use the configuration setting `Conjur.configuration.version` to select your server version, or set the environment variable `CONJUR_VERSION`. In either case, the valid values are `4` and `5`; the default is `5`.
-
-If you are using Conjur server version `4.x`, you can also choose to use the `conjur-api` version `4.x`. In this case, the `Configuration.version` setting is not required (actually, it doesn't exist).
-
 ## Using conjur-api-ruby with Conjur Open Source 
 
 Are you using this project with [Conjur Open Source](https://github.com/cyberark/conjur)? Then we 
@@ -33,7 +13,7 @@ Conjur maintainers perform additional testing on the suite release versions to e
 compatibility. When possible, upgrade your Conjur version to match the 
 [latest suite release](https://docs.conjur.org/Latest/en/Content/ReleaseNotes/ConjurOSS-suite-RN.htm); 
 when using integrations, choose the latest suite release that matches your Conjur version. For any 
-questions, please contact us on [Discourse](https://discuss.cyberarkcommons.org/c/conjur/5).
+questions, please contact us on [Discourse](https://discuss.cyberarkcommons.org/).
 
 # Installation
 

Rakefile

@@ -23,11 +23,7 @@ begin
   require 'cucumber'
   require 'cucumber/rake/task'
 
-  Cucumber::Rake::Task.new(:cucumber_4) do |t|
-    t.cucumber_opts = "--tags ~@wip --format pretty --format junit --out features_v4/reports -r features_v4/step_definitions/ -r features_v4/support/ features_v4/"
-  end
-
-  Cucumber::Rake::Task.new(:cucumber_5) do |t|
+  Cucumber::Rake::Task.new(:cucumber) do |t|
     t.cucumber_opts = "--tags ~@wip --format pretty --format junit --out features/reports"
   end
 
@@ -36,8 +32,7 @@ begin
     desc "Run the spec and cucumber suites, compute the test results and coverage statistics, build Yard docs"
     task :jenkins_init => [ :init_coverage, :cuke_report_cleanup ]
     task :jenkins_spec => [ :"ci:setup:rspec", :spec ]
-    task :jenkins_cucumber_v4 => [ :cucumber_4 ]
-    task :jenkins_cucumber_v5 => [ :cucumber_5 ]
+    task :jenkins_cucumber => [ :cucumber ]
   rescue LoadError
     warn "ci_reporter_rspec not found, jenkins task will be unavailable"
   end

ci/configure_v5.sh ci/configure.shci/configure_v5.sh renamed to ci/configure.sh

@@ -2,7 +2,7 @@
 
 source ./ci/oauth/keycloak/keycloak_functions.sh
 
-cat << "CONFIGURE" | docker exec -i $(docker compose ps -q conjur_5) bash
+cat << "CONFIGURE" | docker exec -i $(docker compose ps -q conjur) bash
 set -e
 
 for _ in $(seq 20); do

ci/configure_v4.sh

@@ -67,5 +67,5 @@ function fetch_keycloak_certificate() {
   # Fetch SSL cert to communicate with keycloak (OIDC provider).
   echo "Initialize keycloak certificate in conjur server"
   docker compose exec -T \
-    conjur_5 /scripts/fetch_certificate
+    conjur /scripts/fetch_certificate
 }

ci/oauth/keycloak/keycloak_functions.sh

@@ -1,56 +1,47 @@
 version: '3'
 services:
   pg:
-    image: postgres:9.3
+    image: postgres:15
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
 
-  conjur_5:
+  conjur:
     image: cyberark/conjur
     command: server -a cucumber
     environment:
       DATABASE_URL: postgres://postgres@pg/postgres
       CONJUR_DATA_KEY: 'WMfApcDBtocRWV+ZSUP3Tjr5XNU+Z2FdBb6BEezejIs='
     volumes:
-      - authn_local_5:/run/authn-local
+      - authn_local:/run/authn-local
     depends_on:
       - pg
 
-  conjur_4:
-    image: registry2.itci.conjur.net/conjur-appliance-cuke-master:4.9-stable
-    security_opt:
-      - seccomp:unconfined
-    volumes:
-      - ../features_v4/support/policy.yml:/etc/policy.yml
-      - authn_local_4:/run/authn-local
-
   gem:
     build:
       context: ../
       dockerfile: dev/Dockerfile.dev
     entrypoint: sleep
     command: infinity
     environment:
-      CONJUR_APPLIANCE_URL: http://conjur_5
-      CONJUR_VERSION: 5
+      CONJUR_APPLIANCE_URL: http://conjur
       CONJUR_ACCOUNT: cucumber
     links:
-      - conjur_5:conjur_5
-      - conjur_4:conjur_4
+      - conjur:conjur
     volumes:
       - ..:/src/conjur-api
-      - authn_local_4:/run/authn-local-4
-      - authn_local_5:/run/authn-local-5
+      - authn_local:/run/authn-local
 
   client:
+    # TODO: Upgrade to V8
     image: conjurinc/cli5
     entrypoint: sleep
     command: infinity
     environment:
-      CONJUR_APPLIANCE_URL: http://conjur_5
+      CONJUR_APPLIANCE_URL: http://conjur
       CONJUR_ACCOUNT: cucumber
       CONJUR_AUTHN_LOGIN: admin
     links:
-    - conjur_5:conjur_5
+    - conjur:conjur
 
 volumes:
-  authn_local_5:
-  authn_local_4:
+  authn_local:

dev/docker-compose.yml

@@ -1,12 +1,12 @@
 #!/bin/bash -ex
 
-function v5_development() {
-  docker compose up -d --no-deps conjur_5 pg gem client
+function development() {
+  docker compose up -d --no-deps conjur pg gem client
 
-  docker compose exec -T conjur_5 conjurctl wait
+  docker compose exec -T conjur conjurctl wait
 
-  local api_key=$(docker compose exec -T conjur_5 rake 'role:retrieve-key[cucumber:user:admin]')
-  api_key=$(docker compose exec -T conjur_5 conjurctl role retrieve-key cucumber:user:admin | tr -d '\r')
+  local api_key=$(docker compose exec -T conjur rake 'role:retrieve-key[cucumber:user:admin]')
+  api_key=$(docker compose exec -T conjur conjurctl role retrieve-key cucumber:user:admin | tr -d '\r')
 
   docker exec -e CONJUR_AUTHN_API_KEY="$api_key" -it --detach-keys 'ctrl-\' $(docker compose ps -q gem) bash
 }
@@ -19,4 +19,4 @@ fi
 docker compose pull
 docker compose build
 
-v5_development
+development