api-clients 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27349b1c4e24b1f6365753c40b8c6d4eb45808bd77e56af4e2a4452f170a6463
-  data.tar.gz: f3c817aa66b949ffd78d98650eb2f85d59522e0080c6888a70dbf7a036f4727c
+  metadata.gz: 2d616c505ee1bc25f860ef1a86d70cbb3baf409bc22ce13c75c70029bd818501
+  data.tar.gz: 7e391a9af590565ae767849c76856b4af26c205b96ae7a917914b73a228baddf
 SHA512:
-  metadata.gz: 642b69d625d514bc5d61f7ba4537c76798b508911ecf3adab5cab54486b4ef71d6fbcdf481873d2bddcbe170e8e1a355fdd183ffb0475077dcdeeec11d159ab2
-  data.tar.gz: 71a573c26f8c602e190174f85b8c6d27c92ace795d0b076b61d178a9cade88dd00c993999ad3596281538a44aae0295832fb15217c42ac985e0be8f288c3b03f
+  metadata.gz: 5801e1db200707dcddace32ea0f5e9e0562bda0b59adbb37f05b2e43e03326d9a140d045b3d8e71407f2a767bb12e269b9fa2af2c42840516ea11153ecfb849b
+  data.tar.gz: f2d1b64e4fed0c5820cf7e9bec9c93f4a575f901576453ca5cbe6919815f5eeb5e28fedade8b9510e125b128ef13e322a6f5e0867a50b4fcc0a50ae814da828c

data/README.md

@@ -1,30 +1,207 @@
-# Api::Clients
+# CI jobs to tag projects in code tools
 
-TODO: Delete this and the text below, and describe your gem
+Adds jobs for cortex, mend and sonarqube to the pipelines, the jobs add the gitlab url of the hosting repository as a project tag on Mend, a project link in Sonarqube or open-api info in Cortex so that reporting can correlate tools by use of the gitlab url as the key.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api/clients`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Use jobs in your pipelines
 
-## Installation
+Add the following lines to your .gitlab-ci.yml file:
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```
+include: # add to your includes
+  - project: j.rivera/api-tools
+    file: gitlab-ci-includes.yml
+    ref: 53444d03851ffed62f457b8ad2aa6950f894d3aa
 
-Install the gem and add to the application's Gemfile by executing:
+stages:
+  - code_tools # add to your stages
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+That will add under the stage `code_tools` the jobs for Cortex (`cortex_project`), Mend (`mend_project`) and Sonarqube (`sonarqube_project`) to decorate those tools' projects with the url of the gitlab repository.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Next add environment variables needed by the jobs. Ask for help on it on slack channel #bet-tribe-odds-devops:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+- `APICLIENTS_TOKEN` a gitlab access token for the repository [Api Clients](https://gitlab.sportradar.ag/j.rivera/api-tools)
+- `CORTEX_API_KEY` Cortex API key
+- `MEND_ORG_TOKEN` Mend organization token. Defaults to value of variable `WHITESOURCE_ORG_TOKEN`
+- `MEND_PRODUCT` Mend product name. Defaults to value of `WHITESOURCE_PRODUCT`
+- `MEND_PROJECT` Mend project name. Defaults to value of `WHITESOURCE_PROJECT_NAME`
+- `MEND_USER_KEY` Mend user key. Defaults to value of `WHITESOURCE_USER_KEY`
+- `SQ_PROJECT` Sonarqube project key. Defaults to value of `SONAR_PROJECT_KEY`
+- `SQ_TOKEN` Sonarqube token
+- `SQ_USER` Sonarqube user
 
-## Usage
+### Adjust jobs to your pipeline
 
-TODO: Write usage instructions here
+To override the jobs declare them in your `.gitlab-ci.yml`, in the examples below other variables' values are passed to the jobs:
+
+```
+cortex-project:
+  extends: .cortex-project-decoration
+  variables:
+    CORTEX_API_KEY: $CORTEX_TOKEN
+
+mend-project:
+  extends: .mend-project-decoration
+  variables:
+    MEND_ORG_TOKEN: $MEND_ORG_TOKEN
+    MEND_PRODUCT: $MEND_PRODUCT
+    MEND_PROJECT: $MEND_PROJECT_NAME
+    MEND_USER_KEY: $MEND_USER_KEY
+
+sq-project:
+  extends: .sq-project-decoration
+  variables:
+    SQ_PROJECT: $SONARQUBE_PROJECT_KEY
+    SQ_TOKEN: $SONARQUBE_TOKEN
+    SQ_USER: $SONARQUBE_USER
+```
+
+## Ruby gem installation
+
+Install the ruby gem with:
+
+```
+$ gem install api-clients
+```
+
+Or add to your application's Gemfile by executing:
+
+```
+$ bundle add api-clients
+$ bundle install
+```
+
+Or install it from code, for that read below.
+
+## Ruby code usage
+
+To play with the ruby code first install the gem.
+
+### For Cortex
+
+To use cortex:
+
+```
+$ bundle exec bin/console
+
+irb > cortex = Api::Clients::Cortex.new gitlab_url: "https://gitlab.example.com/j.rivera/my-test-service"
+=>
+#<Api::Clients::Cortex:0x00005629f898d488
+...
+
+irb > cortex.update_service!
+=> nil
+
+irb > cortex.service_info
+=>
+{"info"=>
+  {"title"=>"odds-devops-test-service",
+   "description"=>"Test service for Odds devops tasks",
+   "x-cortex-git"=>
+    {"gitlab"=>
+      {"repository"=>"j.rivera/my-test-service"}},
+   "x-cortex-tag"=>
+    "oddsdevops_jrivera-my-test-service"},
+ "openapi"=>"3.0.1",
+ "servers"=>[{"url"=>"/"}]}
+```
+
+## Mend
+
+To use Mend:
+
+```
+export MEND_ORG_TOKEN=...
+export MEND_USER_KEY=...
+
+$ bundle exec bin/console
+
+irb > mend = Api::Clients::Mend.new gitlab_url: "https://gitlab.example.com/j.rivera/my-test-service", product: "devops", project: "jrivera_my-test-service"
+=>
+#<Api::Clients::Mend:0x00005629f897ca48
+...
+
+irb(main):010:0> mend.tag_project!
+=>
+{"projectTagsInfo"=>
+  {"name"=>"jrivera_my-test-service",
+   "token"=>
+    "1da9c170adeb421a89a9c4157acba3b30fe5856c02114536990eee8f17c87c7d",
+   "tags"=>
+    {"gitlab-url"=>
+      "https://gitlab.example.com/j.rivera/my-test-service"}}}
+
+irb > mend.project_tags
+=>
+{"gitlab-url"=>
+  ["https://gitlab.example.com/j.rivera/my-test-service"]}
+```
+
+## Sonarqube
+
+To use Sonarqube:
+
+```
+export SQ_TOKEN=...
+export SQ_USER=...
+
+$ bundle exec bin/console
+
+irb > sq = Api::Clients::Sonarqube.new gitlab_url: "https://gitlab.example.com/j.rivera/my-test-service", project: "jrivera_my-test-service"
+=>
+#<Api::Clients::Sonarqube:0x00005629f8248830
+...
+
+irb > sq.link_project!
+=> nil
+
+irb > sq.project
+=> "jrivera_my-test-service"
+
+irb(main):005:0> sq.project_links
+=>
+[...
+ {"id"=>"AYmrhzwtxhyS1ZWWXNJ5",
+  "name"=>"gitlab-url",
+  "type"=>"gitlab-url",
+  "url"=>
+   "https://gitlab.example.com/j.rivera/my-test-service"}]
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment.
+
+TODO test instructions
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Update ruby code in directory `lib/api/`, in file `lib/api/clients/version.rb` increase version (0.0.1 in the example), then build it with:
+
+```
+bundle
+gem build api-clients.gemspec
+```
+
+Install it locally to test:
+
+```
+sudo gem install --local api-clients-0.0.1.gem
+```
+
+Push it to rubygems for usage in pipelines:
+
+```
+gem push api-clients-0.0.1.gem
+```
+
+Tag the version:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+git tag 0.0.1
+git push --tags
+``
 
 ## Contributing
 

data/Rakefile

@@ -9,8 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]
+task default: %i[test]

data/gitlab-ci-includes.yml

@@ -0,0 +1,50 @@
+# Pipeline jobs to add gitlab-url to cortex, mend and sonarqube
+
+.cortex-project-decoration:
+  image: ruby:latest
+  script:
+    - gem install api-clients
+    - git clone https://dummy:$APICLIENTS_TOKEN@gitlab.sportradar.ag/j.rivera/api-tools.git api-clients
+    - api-clients/scripts/cortex.rb
+
+cortex-project:
+  extends: .cortex-project-decoration
+  stage: code_tools
+  variables:
+    CORTEX_API_KEY: $CORTEX_API_KEY
+    GITLAB_URL: $CI_PROJECT_URL
+
+
+.mend-project-decoration:
+  image: ruby:latest
+  script:
+    - gem install api-clients
+    - git clone https://dummy:$APICLIENTS_TOKEN@gitlab.sportradar.ag/j.rivera/api-tools.git api-clients
+    - api-clients/scripts/mend.rb
+
+mend-project:
+  extends: .mend-project-decoration
+  stage: code_tools
+  variables:
+    GITLAB_URL: $CI_PROJECT_URL
+    MEND_ORG_TOKEN: $WHITESOURCE_ORG_TOKEN
+    MEND_PRODUCT: $WHITESOURCE_PRODUCT
+    MEND_PROJECT: $WHITESOURCE_PROJECT_NAME
+    MEND_USER_KEY: $WHITESOURCE_USER_KEY
+
+
+.sq-project-decoration:
+  image: ruby:latest
+  script:
+    - gem install api-clients
+    - git clone https://dummy:$APICLIENTS_TOKEN@gitlab.sportradar.ag/j.rivera/api-tools.git api-clients
+    - api-clients/scripts/sonarqube.rb
+
+sq-project:
+  extends: .sq-project-decoration
+  stage: code_tools
+  variables:
+    GITLAB_URL: $CI_PROJECT_URL
+    SQ_PROJECT: $SONAR_PROJECT_KEY
+    SQ_TOKEN: $SQ_TOKEN
+    SQ_USER: $SQ_USER

data/lib/api/clients/cortex.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Public: Add gitlab path as info.x-cortex-tag to Cortex service
+# Public: Will check whether gitlab path is added as info.x-cortex-tag to Cortex service
 
 require 'httparty'
 require 'json'
@@ -32,10 +32,10 @@ module Api
         @service_info ||= get_call(get_service_url)
       end
 
-      # Public: add gitlab info to cortex service
-      def update_service!
-        return if service_has_gitlab_info?
-        post_call post_service_url, post_body
+      # Public: check gitlab info in cortex service
+      def check_service
+        service_has_gitlab_info?
+        # post_call post_service_url, post_body
       end
 
       private

data/lib/api/clients/version.rb

@@ -2,6 +2,6 @@
 
 module Api
   module Clients
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/scripts/cortex.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab path as info.x-cortex-tag to Cortex service
+
+require 'api/clients/cortex'
+cortex = Api::Clients::Cortex.new(gitlab_url: ENV["GITLAB_URL"])
+puts cortex.service_info
+if cortex.check_service
+  puts "Cortex service has correct gitlab path"
+else
+  puts "Cortex service has incorrect gitlab path! Please update your cortex.yaml with the gitlab path"
+  exit 1
+end

data/scripts/mend.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab url as tags to Mend project
+
+require 'api/clients/mend'
+mend = Api::Clients::Mend.new(product: ENV["MEND_PRODUCT"],
+                              project: ENV["MEND_PROJECT"],
+                              gitlab_url: ENV["GITLAB_URL"])
+mend.tag_project!
+puts "Project: #{mend.project}"
+puts "Project tags:"
+puts mend.project_tags

data/scripts/sonarqube.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Public: Add gitlab url as link to Sonarqube project
+
+require 'api/clients/sonarqube'
+sq = Api::Clients::Sonarqube.new(project: ENV["SQ_PROJECT"],
+                                 gitlab_url: ENV["GITLAB_URL"])
+sq.link_project!
+puts "Project: #{sq.project}"
+puts "Project links:"
+puts sq.project_links

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-clients
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joaquin Rivera Padron
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,11 +39,15 @@ files:
 - README.md
 - Rakefile
 - api-clients.gemspec
+- gitlab-ci-includes.yml
 - lib/api/clients.rb
 - lib/api/clients/cortex.rb
 - lib/api/clients/mend.rb
 - lib/api/clients/sonarqube.rb
 - lib/api/clients/version.rb
+- scripts/cortex.rb
+- scripts/mend.rb
+- scripts/sonarqube.rb
 - sig/api/clients.rbs
 homepage: 
 licenses: