uffizzi-cli 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27a1f65cd69d407dc2f086733a20baaf6e129b7433322ac61682f6b8a1fa54e
-  data.tar.gz: 61c6860dbc035009ee6197f353c05d0af95eda6d6f77b67d25f672ba954e114f
+  metadata.gz: a7a27f279e964f07491f920557722194d65c8a9259487a5a717707f6075d164b
+  data.tar.gz: d9825fe3425b0dde3dbe1e4528686100c6ca22f30aed4aa7a332cf991bbb6480
 SHA512:
-  metadata.gz: 709d000e6701f32d3dcaa3745c68d2eb63695dba2dd8ef939201569605bb121fdd3422d730d3bdc2687a33cc81810b97a3a4f4841187aac68547824293523173
-  data.tar.gz: 1b0ae241adab3fb770f25cca8709ae779b5c8de16056fa71e6242d470123550b6cacc920f1e2b9474951323b72d1d18160a840ed64c4814469eb89e138d0c3d5
+  metadata.gz: 179a75d66bd89efc1ad9b3decf5ebc6c5526b2fe0fdd02e616940b4f12544505c956874a0649a99a2c5d1e14fce6e1dcda305a9028e08d8e9c2b8b5f63955fb5
+  data.tar.gz: a8d2637bef4250c33bb1cc8725556a2758384c9115938865e8acd70b92fce515ccd94b691913341c6b6f64a29f6d9ff34e99148fd62cacf8d6551d72a1222508

data/lib/uffizzi/cli/login.rb

@@ -34,17 +34,17 @@ module Uffizzi
 
     def set_server
       config_server = ConfigFile.exists? ? read_option_from_config(:server) : nil
-      server_address = @options[:server] || config_server || Uffizzi.ui.ask('Server: ')
+      server_address = (@options[:server] || config_server || Uffizzi.ui.ask('Server:')).sub(/\/+$/, '')
       server_address.start_with?('http:', 'https:') ? server_address : "https://#{server_address}"
     end
 
     def set_username
       config_username = ConfigFile.exists? ? read_option_from_config(:username) : nil
-      @options[:username] || config_username || Uffizzi.ui.ask('Username: ')
+      @options[:username] || config_username || Uffizzi.ui.ask('Username:')
     end
 
     def set_password
-      ENV['UFFIZZI_PASSWORD'] || Uffizzi.ui.ask('Password: ', echo: false)
+      ENV['UFFIZZI_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
     end
 
     def read_option_from_config(option)

data/lib/uffizzi/cli/preview.rb

@@ -12,19 +12,24 @@ module Uffizzi
     desc 'service', 'Show the preview services info'
     require_relative 'preview/service'
     subcommand 'service', Uffizzi::Cli::Preview::Service
+
     desc 'list', 'List all previews'
+    method_option :filter, required: false, type: :string, aliases: '-f'
+    method_option :output, required: false, type: :string, aliases: '-o', enum: ['json']
     def list
       run('list')
     end
 
     desc 'create [COMPOSE_FILE]', 'Create a preview'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
+    method_option :"set-labels", required: false, type: :string, aliases: '-s'
     def create(file_path = nil)
       run('create', file_path: file_path)
     end
 
     desc 'uffizzi preview update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'Update a preview'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
+    method_option :"set-labels", required: false, type: :string, aliases: '-s'
     def update(deployment_name, file_path)
       run('update', deployment_name: deployment_name, file_path: file_path)
     end
@@ -47,10 +52,7 @@ module Uffizzi
     private
 
     def run(command, file_path: nil, deployment_name: nil)
-      unless options[:output].nil?
-        Uffizzi.ui.output_format = options[:output]
-        Uffizzi.ui.disable_stdout
-      end
+      Uffizzi.ui.output_format = options[:output]
       raise Uffizzi::Error.new('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
       raise Uffizzi::Error.new('This command needs project to be set in config file') unless CommandService.project_set?(options)
 
@@ -58,11 +60,11 @@ module Uffizzi
 
       case command
       when 'list'
-        handle_list_command(project_slug)
+        handle_list_command(project_slug, options[:filter])
       when 'create'
-        handle_create_command(file_path, project_slug)
+        handle_create_command(file_path, project_slug, options[:"set-labels"])
       when 'update'
-        handle_update_command(deployment_name, file_path, project_slug)
+        handle_update_command(deployment_name, file_path, project_slug, options[:"set-labels"])
       when 'delete'
         handle_delete_command(deployment_name, project_slug)
       when 'describe'
@@ -72,8 +74,9 @@ module Uffizzi
       end
     end
 
-    def handle_list_command(project_slug)
-      response = fetch_deployments(ConfigFile.read_option(:server), project_slug)
+    def handle_list_command(project_slug, filter)
+      parsed_filter = filter.nil? ? {} : build_filter_params(filter)
+      response = fetch_deployments(ConfigFile.read_option(:server), project_slug, parsed_filter)
 
       if ResponseHelper.ok?(response)
         handle_succeed_list_response(response)
@@ -82,8 +85,10 @@ module Uffizzi
       end
     end
 
-    def handle_create_command(file_path, project_slug)
-      params = file_path.nil? ? {} : prepare_params(file_path)
+    def handle_create_command(file_path, project_slug, labels)
+      Uffizzi.ui.disable_stdout unless options[:output].nil?
+      params = prepare_params(file_path, labels)
+
       response = create_deployment(ConfigFile.read_option(:server), project_slug, params)
 
       if !ResponseHelper.created?(response)
@@ -101,12 +106,13 @@ module Uffizzi
       handle_preview_interruption(deployment_id, ConfigFile.read_option(:server), project_slug)
     end
 
-    def handle_update_command(deployment_name, file_path, project_slug)
+    def handle_update_command(deployment_name, file_path, project_slug, labels)
+      Uffizzi.ui.disable_stdout unless options[:output].nil?
       deployment_id = PreviewService.read_deployment_id(deployment_name)
 
       raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
-      params = prepare_params(file_path)
+      params = prepare_params(file_path, labels)
       response = update_deployment(ConfigFile.read_option(:server), project_slug, deployment_id, params)
 
       if !ResponseHelper.ok?(response)
@@ -175,7 +181,11 @@ module Uffizzi
       raise Uffizzi::Error.new('The project has no active deployments') if deployments.empty?
 
       deployments.each do |deployment|
-        Uffizzi.ui.say("deployment-#{deployment[:id]}")
+        if Uffizzi.ui.output_format.nil?
+          Uffizzi.ui.say("deployment-#{deployment[:id]}")
+        else
+          Uffizzi.ui.pretty_say(deployment)
+        end
       end
     end
 
@@ -205,26 +215,10 @@ module Uffizzi
       end
     end
 
-    def prepare_params(file_path)
-      begin
-        compose_file_data = EnvVariablesService.substitute_env_variables(File.read(file_path))
-      rescue Errno::ENOENT => e
-        raise Uffizzi::Error.new(e.message)
-      end
-
-      compose_file_dir = File.dirname(file_path)
-      dependencies = ComposeFileService.parse(compose_file_data, compose_file_dir)
-      absolute_path = File.absolute_path(file_path)
-      compose_file_params = {
-        path: absolute_path,
-        content: Base64.encode64(compose_file_data),
-        source: absolute_path,
-      }
-
-      {
-        compose_file: compose_file_params,
-        dependencies: dependencies,
-      }
+    def prepare_params(file_path, labels)
+      compose_file_params = file_path.nil? ? {} : build_compose_file_params(file_path)
+      metadata_params = labels.nil? ? {} : build_metadata_params(labels)
+      compose_file_params.merge(metadata_params)
     end
 
     def handle_preview_interruption(deployment_id, server, project_slug)
@@ -251,10 +245,77 @@ module Uffizzi
     end
 
     def build_deployment_data(deployment)
+      url_server = ConfigFile.read_option(:server)
+
       {
         id: "deployment-#{deployment[:id]}",
         url: "https://#{deployment[:preview_url]}",
+        containers_uri: "#{url_server}/projects/#{deployment[:project_id]}/deployments/#{deployment[:id]}/containers",
       }
     end
+
+    def build_compose_file_params(file_path)
+      begin
+        compose_file_data = EnvVariablesService.substitute_env_variables(File.read(file_path))
+      rescue Errno::ENOENT => e
+        raise Uffizzi::Error.new(e.message)
+      end
+
+      compose_file_dir = File.dirname(file_path)
+      dependencies = ComposeFileService.parse(compose_file_data, compose_file_dir)
+      absolute_path = File.absolute_path(file_path)
+      compose_file_params = {
+        path: absolute_path,
+        content: Base64.encode64(compose_file_data),
+        source: absolute_path,
+      }
+
+      {
+        compose_file: compose_file_params,
+        dependencies: dependencies,
+      }
+    end
+
+    def build_metadata_params(labels)
+      {
+        metadata: {
+          'labels' => parse_params(labels, 'Labels'),
+        },
+      }
+    end
+
+    def build_filter_params(filter_params)
+      {
+        'labels' => parse_params(filter_params, 'Filtering parameters'),
+      }
+    end
+
+    def parse_params(params, params_type)
+      validate_params(params, params_type)
+      params.split(' ').reduce({}) do |acc, param|
+        stringified_keys, value = param.split('=', 2)
+        keys = stringified_keys.split('.', -1)
+        inner_pair = { keys.pop => value }
+        prepared_param = keys.reverse.reduce(inner_pair) { |res, key| { key => res } }
+        merge_params(acc, prepared_param)
+      end
+    end
+
+    def validate_params(params, params_type)
+      params.split(' ').each do |param|
+        stringified_keys, value = param.split('=', 2)
+        raise Uffizzi::Error.new("#{params_type} were set in incorrect format.") if value.nil? || stringified_keys.nil? || value.empty?
+
+        keys = stringified_keys.split('.', -1)
+        raise Uffizzi::Error.new("#{params_type} were set in incorrect format.") if keys.empty? || keys.any?(&:empty?)
+      end
+    end
+
+    def merge_params(result, param)
+      key = param.keys.first
+      return result.merge(param) unless result.has_key?(key)
+
+      { key => result[key].merge(merge_params(result[key], param[key])) }
+    end
   end
 end

data/lib/uffizzi/clients/api/api_client.rb

@@ -147,8 +147,8 @@ module ApiClient
     build_response(response)
   end
 
-  def fetch_deployments(server, project_slug)
-    uri = deployments_uri(server, project_slug)
+  def fetch_deployments(server, project_slug, filter)
+    uri = deployments_uri(server, project_slug, filter)
     response = http_client.make_get_request(uri)
 
     build_response(response)

data/lib/uffizzi/clients/api/api_routes.rb

@@ -32,8 +32,10 @@ module ApiRoutes
     "#{compose_files_uri(server, project_slug)}/validate"
   end
 
-  def deployments_uri(server, project_slug)
-    "#{server}/api/cli/v1/projects/#{project_slug}/deployments"
+  def deployments_uri(server, project_slug, filter = nil)
+    return "#{server}/api/cli/v1/projects/#{project_slug}/deployments" if filter.nil?
+
+    "#{server}/api/cli/v1/projects/#{project_slug}/deployments?q=#{filter.to_json}"
   end
 
   def deployment_uri(server, project_slug, deployment_id)

data/lib/uffizzi/clients/api/http_client.rb

@@ -50,13 +50,13 @@ module Uffizzi
       headers = { 'Content-Type' => 'application/json' }
       request = case method
                 when :get
-                  Net::HTTP::Get.new(uri.path, headers)
+                  Net::HTTP::Get.new(uri.request_uri, headers)
                 when :post
-                  Net::HTTP::Post.new(uri.path, headers)
+                  Net::HTTP::Post.new(uri.request_uri, headers)
                 when :delete
-                  Net::HTTP::Delete.new(uri.path, headers)
+                  Net::HTTP::Delete.new(uri.request_uri, headers)
                 when :put
-                  Net::HTTP::Put.new(uri.path, headers)
+                  Net::HTTP::Put.new(uri.request_uri, headers)
       end
       if request.instance_of?(Net::HTTP::Post) || request.instance_of?(Net::HTTP::Put)
         request.body = params.to_json

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '0.12.0'
+  VERSION = '0.14.0'
 end

data/man/uffizzi-preview-create

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-PREVIEW\-CREATE" "" "May 2022" ""
+.TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-preview\-create\fR \- create a preview
 .SH "SYNOPSIS"
@@ -32,6 +32,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
     the previews they create: when the preview is deleted, the
     alternate compose is deleted by the Uffizzi API\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-set\-labels=METADATA
+    Metadata of deployment that contains any information which can
+    be usefull for filtering deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -46,5 +52,14 @@ To create a preview with the project\'s default compose file, run:
 To create a preview with an alternate compose file, run:
 
     $ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
+
+To create a preview with single label, run:
+
+    $ uffizzi preview create \-\-set\-labels github\.repo=my_repo
+
+To create a preview with multiple labels, run:
+
+    $ uffizzi preview create \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-create.ronn

@@ -27,6 +27,11 @@ uffizzi-preview-create - create a preview
         the previews they create: when the preview is deleted, the 
         alternate compose is deleted by the Uffizzi API. 
 
+## FLAGS
+    --set-labels=METADATA
+        Metadata of deployment that contains any information which can
+        be usefull for filtering deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -39,3 +44,12 @@ uffizzi-preview-create - create a preview
     To create a preview with an alternate compose file, run:
 
         $ uffizzi preview create docker-compose.uffizzi.alt.yml
+
+    To create a preview with single label, run:
+
+        $ uffizzi preview create --set-labels github.repo=my_repo
+
+    To create a preview with multiple labels, run:
+
+        $ uffizzi preview create \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-list

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-PREVIEW\-LIST" "" "May 2022" ""
+.TH "UFFIZZI\-PREVIEW\-LIST" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-preview\-list\fR \- list previews in a project
 .SH "SYNOPSIS"
@@ -15,6 +15,15 @@ deploying and failed previews\.
 For more information on Uffizzi previews, see:
 https://github\.com/UffizziCloud/uffizzi_cli
 .fi
+.SH "FLAGS"
+.nf
+\-\-filter=METADATA
+    Metadata to filtering list of deployments\.
+
+\-\-output=json
+    Use this option for a more detailed description of listed
+    deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -29,5 +38,20 @@ To list all previews in the default project, run:
 To list all previews in a project with name my_project, run:
 
     $ uffizzi preview list \-\-project="my_project"
+
+To list all previews in json format, run:
+
+    $ uffizzi preview list \-\-output="json"
+
+To list all previews filtered by metadata using single
+label, run:
+
+    $ uffizzi preview list \-\-filter github\.repo=my_repo
+
+To list all previews filtered by metadata using multiple
+labels, run:
+
+    $ uffizzi preview list \e
+    \-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-list.ronn

@@ -11,6 +11,14 @@ uffizzi-preview-list - list previews in a project
     For more information on Uffizzi previews, see:
     https://github.com/UffizziCloud/uffizzi_cli
 
+## FLAGS
+    --filter=METADATA
+        Metadata to filtering list of deployments.
+
+    --output=json
+        Use this option for a more detailed description of listed
+        deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -23,3 +31,18 @@ uffizzi-preview-list - list previews in a project
     To list all previews in a project with name my_project, run:
 
         $ uffizzi preview list --project="my_project"
+
+    To list all previews in json format, run:
+
+        $ uffizzi preview list --output="json"
+
+    To list all previews filtered by metadata using single
+    label, run:
+
+        $ uffizzi preview list --filter github.repo=my_repo
+
+    To list all previews filtered by metadata using multiple
+    labels, run:
+
+        $ uffizzi preview list \
+        --filter="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-update

@@ -1,8 +1,8 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UPDATE" "" "May 2022" ""
+.TH "UPDATE" "" "August 2022" ""
 .SH "NAME"
-\fBuffizzi preview update\fR \- update a preview
+\fBupdate\fR \- update a preview
 .SH "SYNOPSIS"
 .nf
 uffizzi preview update [PREVIEW_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
@@ -27,6 +27,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
 [COMPOSE_FILE]
     The new compose file you want to preview\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-set\-labels=METADATA
+    Metadata of deployment that contains any information which can
+    be usefull for filtering deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -38,5 +44,17 @@ The following command updates a preview with ID deployment\-67 using
 compose file docker\-compose\.alt\.yml:
 
     $ uffizzi preview update deployment\-67 docker\-compose\.alt\.yml
+
+To update a preview with single label, run:
+
+    $ uffizzi preview update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels github\.repo=my_repo
+
+To update a preview with multiple labels, run:
+
+    $ uffizzi preview update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-update.ronn

@@ -22,6 +22,11 @@ uffizzi preview update - update a preview
     [COMPOSE_FILE]
         The new compose file you want to preview.
 
+## FLAGS
+    --set-labels=METADATA
+        Metadata of deployment that contains any information which can
+        be usefull for filtering deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -31,3 +36,15 @@ uffizzi preview update - update a preview
     compose file docker-compose.alt.yml:
 
         $ uffizzi preview update deployment-67 docker-compose.alt.yml
+
+    To update a preview with single label, run:
+
+        $ uffizzi preview update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels github.repo=my_repo
+
+    To update a preview with multiple labels, run:
+
+        $ uffizzi preview update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print