renuo-cli 4.15.0 → 4.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803278ba1e1fc8859287b68a32e3c3545afbaea2423f1a6eb3a8d5754d777f65
-  data.tar.gz: fb96573c7ae9899aa951ec5af5a11d2e6f8be58f753af48243095a7bb6e6f75d
+  metadata.gz: d001b3727b2158e75b84057e5520246f4a4983ebc9008a97802134a07a7fe9a1
+  data.tar.gz: d258158583a1659efea53a52cfb1e29569753e55e4c30d62c95984fed5498813
 SHA512:
-  metadata.gz: d593c03a92f2df9d17839056d156f125677ceb3780022aef734a4bb6c1d48d1ec3dde08875dd25fb86775aeb3908d02c41e850e95b203e0d20009d4756d33645
-  data.tar.gz: 707d0f050955cb8a56e8ef7803351a4fa23b9c2a6b153e6b9ed2913ef3544b4a480f7faaa4c95a55d7eb629985dd719afd11fae70ab543450ac2e5b1b64c84d0
+  metadata.gz: cea757ec3ba510fbec394fe7d313edac2ef4db8e7d31f53e0c9cf83af0ef8d8225e53fa68a3f3c4beea206ef55e022774ef2cd342a1545aa4af925016b936bb1
+  data.tar.gz: 38a9b4a0b037a9ec087fd39060b7b154fbb5ce77533e80f9d977246c62f25fc3dee99e88f36ac7cdf96ec7eb01f7651ef6a89eac22bcb43dbf8c2a95ae1a35bd

data/README.md

@@ -32,7 +32,8 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 ## Release
 
-* Bump the version number in `lib/renuo/cli/version.rb` and commit to `main`
+* Bump the version number in `lib/renuo/cli/version.rb`, run `bundle install`
+  to update the `Gemfile.lock` and commit to `main`
 
 ### Automatic
 

data/lib/renuo/cli/commands/create_deploio_object_storage.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+class Renuo::Cli::Commands::CreateDeploioObjectStorage
+  include CommandHelper
+
+  command "create-deploio-object-storage" do |c|
+    c.syntax = "renuo create-deploio-object-storage"
+    c.summary = "Generates the script necessary to setup object storage on Deploio."
+    c.description = <<~DESCRIPTION
+      This creates commands for creating buckets and bucket users.
+      It also guides you to set up ActiveStorage correctly, by setting the required ENV variables and config/storage.yml setting.
+
+      You will be asked for:
+      - project name so that the script can respect our naming conventions
+
+      The generated commands do the following:
+      - create a bucket user for each environment (main, develop)
+      - create buckets for each user who owns it
+      - enable versioning for main buckets
+    DESCRIPTION
+    c.example "Setup Deploio object storage (you will be asked for details)", "renuo create-deploio-object-storage"
+    c.example "renuo create-deploio-object-storage",
+              "Prompts the user for the necessary information and generates the commands " \
+              "to setup object storage on Deploio."
+    c.action { new.run }
+  end
+
+  def initialize
+    @project_name = ask('Project name (eg: "renuo-mtextur"): ') { |q| q.validate = /.+/ }
+    @location = ask('Location (Default: "nine-es34"): ') { |q| q.default = "nine-es34" }
+  end
+
+  BRANCHES = %w[main develop].freeze
+
+  def run
+    BRANCHES.each do |branch|
+      print_setup_commands(branch)
+    end
+    print_active_storage_config
+  end
+
+  private
+
+  def project_name_without_organisation
+    @project_name_without_organisation ||= @project_name.split("-")[1..].join("-")
+  end
+
+  def print_setup_commands(branch)
+    say "\n# Commands to create #{branch} bucket user and bucket\n".bold
+    versioning_flag = branch == "main" ? " --versioning" : ""
+    bucket_name = "#{project_name_without_organisation}-#{branch}"
+    say "nctl create bucketuser #{branch} --project #{@project_name} --location #{@location}\n"
+    say "nctl create bucket #{bucket_name} --project #{@project_name} --location #{@location}" \
+        "#{versioning_flag} --permissions reader=#{branch} --permissions writer=#{branch}\n"
+  end
+
+  def print_active_storage_config
+    say "\n# ActiveStorage Configuration".bold
+    print_storage_yml_config
+    print_retrieve_credentials
+    print_env_variables_config
+    print_active_storage_service_config
+  end
+
+  def print_storage_yml_config
+    puts <<~OUTPUT
+      Add the following service configuration to your "config/storage.yml" file:
+
+      deploio:
+        service: S3
+        access_key_id: <%= ENV["DEPLOIO_ACCESS_KEY"] %>
+        secret_access_key: <%= ENV["DEPLOIO_SECRET_KEY"] %>
+        endpoint: <%= ENV["DEPLOIO_ENDPOINT"] %>
+        region: us-east-1 # running in Switzerland, operated by Nine.
+        bucket: <%= ENV["DEPLOIO_BUCKET"] %>
+
+      INFO: For S3, a region must be specified. Deploio uses the S3 default value of us-east-1,
+      even though the servers are in Switzerland, operated by Nine.
+    OUTPUT
+  end
+
+  def print_retrieve_credentials
+    say "\n# Retrieve credentials from the bucket user".bold
+    say "After running the bucket user creation commands above, retrieve your credentials:\n\n"
+
+    BRANCHES.each do |branch|
+      say <<~OUTPUT
+        ## #{branch} environment credentials:
+        nctl get bucketuser #{branch} --project #{@project_name} --print-credentials
+
+      OUTPUT
+    end
+  end
+
+  def print_env_variables_config
+    say "\n# Set environment variables on your Deploio application".bold
+    say "Replace the placeholders with the values retrieved above:\n"
+
+    BRANCHES.each do |branch|
+      bucket_name = "#{project_name_without_organisation}-#{branch}"
+      say <<~OUTPUT
+
+        # #{branch} environment:
+        nctl update app #{branch} \\
+          --project #{@project_name} \\
+          --env="DEPLOIO_ACCESS_KEY={ACCESS_KEY}" \\
+          --env="DEPLOIO_SECRET_KEY={SECRET_KEY}" \\
+          --env="DEPLOIO_ENDPOINT=https://#{@location}.objects.nineapis.ch" \\
+          --env="DEPLOIO_BUCKET=#{bucket_name}"
+      OUTPUT
+    end
+  end
+
+  def print_active_storage_service_config
+    say "\n# Configure ActiveStorage in your Rails application".bold
+    say <<~OUTPUT
+      Set the ActiveStorage service in your production environment ("config/environments/production.rb"):
+
+      config.active_storage.service = :deploio
+    OUTPUT
+  end
+end

data/lib/renuo/cli/commands/fetch_secrets.rb

@@ -51,7 +51,8 @@ class Renuo::Cli::Commands::FetchSecrets # rubocop:disable Metrics/ClassLength
     end
 
     item_id = extract_item_id(private_link)
-    item_json = get_item(item_id)
+    account_id = extract_account_id(private_link)
+    item_json = get_item(item_id, account_id)
     return if item_json.nil?
 
     item[:env_variables]&.each do |env_variable|
@@ -67,8 +68,15 @@ class Renuo::Cli::Commands::FetchSecrets # rubocop:disable Metrics/ClassLength
     /&i=([^&]+)/.match(private_link)[1]
   end
 
-  def get_item(item_id)
-    output = execute_command(command: "op item get #{item_id} --format json",
+  def extract_account_id(private_link)
+    /&h=([^&]+)/.match(private_link)&.[](1)
+  end
+
+  def get_item(item_id, account_id = nil)
+    command = "op item get #{item_id} --format json"
+    command += " --account #{account_id}" if account_id
+
+    output = execute_command(command: command,
                              success_message: "",
                              error_message: "Error fetching item #{item_id}." \
                                             "Check `private_link` in  your #{CONFIG_FILE} file.")

data/lib/renuo/cli/commands/release.rb

@@ -6,13 +6,17 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
   UPDATE_TYPES = %w[major minor patch custom].freeze
   TMP_FOLDER_NAME = "_RENUO_RELEASE_TEMP_#{rand(100_000_000)}".freeze
   MOVE_TO_TMP_FOLDER = "mkdir -p #{TMP_FOLDER_NAME} && cd #{TMP_FOLDER_NAME}".freeze
+  SUPPORTED_HOSTS = %w[github.com gitlab.com].freeze
 
   command "release" do |c|
     c.syntax = "renuo release"
-    c.summary = "Release a projects state of develop (on github) to main in one command."
+    c.summary = "Release a project's state of develop to main in one command."
     c.description = "Creates a new release version of a project on main as either a Major, Minor, " \
-                    "Patch or Custom release based on the current state of develop on Github"
-    c.example "renuo release my-project minor", "release a minor release of my-project"
+                    "Patch or Custom release based on the current state of develop. " \
+                    "Supports GitHub and GitLab repositories."
+    c.example "renuo release my-project minor", "release a minor release of renuo/my-project on GitHub"
+    c.example "renuo release renuo/my-project minor", "release a minor release of renuo/my-project on GitHub"
+    c.example "renuo release https://gitlab.com/renuo/project patch", "release a patch of a GitLab project"
     c.example "renuo release my-project custom 2.5.0", "release my-project as release 2.5.0"
     c.action { |args| new.run(args) }
   end
@@ -39,6 +43,23 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
 
   def validate_project_name
     abort(">> No project name given.") unless @project_name
+
+    @host, @repo_path = repo_identifier(@project_name)
+  end
+
+  def repo_identifier(input)
+    return ["github.com", "renuo/#{input}"] unless input.include?("/")
+    return ["github.com", input] unless input.start_with?("http://", "https://", "git@")
+
+    # Convert git@host:path to https://host/path
+    uri = input.sub(/^git@([^:]+):/, 'https://\1/').sub(/\.git$/, "")
+    parsed = URI.parse(uri)
+    host = parsed.host
+    repo_path = parsed.path.sub(%r{^/}, "")
+
+    return [host, repo_path] if SUPPORTED_HOSTS.include?(host)
+
+    abort(">> Unsupported host '#{host}'. Supported hosts: #{SUPPORTED_HOSTS.join(", ")}")
   end
 
   def validate_update_type
@@ -74,11 +95,20 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
 
   def open_comparison_page
     puts "Opening browser to double-check what is going to be deployed…"
-    open_path "https://github.com/#{@project_name}/compare/#{main_branch}...develop"
+    open_path comparison_url
+  end
+
+  def comparison_url
+    case @host
+    when "gitlab.com"
+      "https://#{@host}/#{@repo_path}/-/compare/#{main_branch}...develop"
+    else
+      "https://#{@host}/#{@repo_path}/compare/#{main_branch}...develop"
+    end
   end
 
   def checkout_project
-    abort(">> Project not found on Github.") unless system("#{MOVE_TO_TMP_FOLDER} && gh repo clone #{@project_name}")
+    abort(">> Project not found.") unless system("#{MOVE_TO_TMP_FOLDER} && git clone git@#{@host}:#{@repo_path}.git")
 
     system(cmd_in_folder("git checkout #{main_branch} && git pull origin #{main_branch} &&" \
                          "git checkout #{develop_branch} && git pull origin #{develop_branch}"))
@@ -173,7 +203,7 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
   end
 
   def ask_for_final_confirmation
-    unless agree(">> Are you sure you wish to deploy '#{@project_name}' " \
+    unless agree(">> Are you sure you wish to deploy '#{@repo_path}' " \
                  "as a #{@update_type} release (#{current_version} => #{@version})?")
       abort(">> Cancelling Release.")
     end
@@ -195,7 +225,7 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
   end
 
   def folder_name
-    @project_name.split("/").last
+    @repo_path.split("/").last
   end
 
   def cleanup
@@ -203,7 +233,7 @@ class Renuo::Cli::Commands::Release # rubocop:disable Metrics/ClassLength
   end
 
   def main_branch
-    remote_repo = "git@github.com:#{@project_name}.git"
+    remote_repo = "git@#{@host}:#{@repo_path}.git"
     @main_branch ||= `git ls-remote --heads #{remote_repo} main`.empty? ? "master" : "main"
   end
 

data/lib/renuo/cli/version.rb

@@ -3,7 +3,7 @@
 # :nocov:
 module Renuo
   class Cli
-    VERSION = "4.15.0"
+    VERSION = "4.17.1"
     NAME = "renuo-cli"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renuo-cli
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.17.1
 platform: ruby
 authors:
 - Renuo AG
@@ -85,6 +85,7 @@ files:
 - lib/renuo/cli/commands/configure_sentry.rb
 - lib/renuo/cli/commands/create_aws_project.rb
 - lib/renuo/cli/commands/create_deploio_app.rb
+- lib/renuo/cli/commands/create_deploio_object_storage.rb
 - lib/renuo/cli/commands/create_heroku_app.rb
 - lib/renuo/cli/commands/create_new_logins.rb
 - lib/renuo/cli/commands/create_pr.rb
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: The Renuo CLI automates some common workflows.
 test_files: []