uffizzi-cli 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beaa38102ec282e48c643ba8f6a8c80a331d6ded1760681a004341e2b671b5cf
-  data.tar.gz: c6517ea90506e72c11cb244f02f00760d5bb2afa1171f48fc9a997a8489165f0
+  metadata.gz: de1f8c92c08b2d323c6c379bd5521aa394db91d85ed02ebc73f8c8457bb083d9
+  data.tar.gz: 5c19dc240896c322b27d7dcf42499d6c5a67ce911ef3df625caf78fc71c259c5
 SHA512:
-  metadata.gz: 2736a387fb65e9efe83fda0311f9f79bf4916bc828e9b6113bbf7e4e407256438e607af8f1f46dc6df1fa43423ba4728f6432396b60e06c24e16270024382f7a
-  data.tar.gz: 53b0f5951c72ebfba472e147e4397d311380b051baf41d3ca2c7e20f894a3ea417406f4ac8fbc3063902a79c7e11f1e39d5246aee0505377b01583d733056914
+  metadata.gz: b653f34930cd546941d9646f7b5e2fccb854a784ed375e7da0b51f2a0cd9d9642b2463598ed6092e2d86be2de6ba804c9ae4c474290e5bdcee12123ad04fcd96
+  data.tar.gz: 7f4c915af4bebe54b1ae2e96b2661d08374ce4d71a9fed04388b815bf3c6c6e02039bed214d8e6da678dc427d6753ac17869473a172df5c81bc5f2dca9c0c7c3

data/README.md

@@ -4,22 +4,20 @@ A command-line interace (CLI) for [Uffizzi App](https://github.com/UffizziCloud/
 
 ## Uffizzi Overview
 
-Uffizzi is the Full-stack Previews Engine that makes it easy for your team to preview code changes before merging—whether frontend, backend or microserivce. Define your full-stack apps with a familiar syntax based on Docker Compose, and Uffizzi will create on-demand test environments when you open pull requests or build new images. Preview URLs are updated when there’s a new commit, so your team can catch issues early, iterate quickly, and accelerate your release cycles.
+Uffizzi is an open-source engine for creating lightweight, ephemeral test environments for APIs and full-stack applications. Uffizzi enables teams to preview new features before merging and to mitigate the risk of introducing regressions into a codebase. Each preview gets a shareable URL that's updated when you push new commits or image tags, so teams can provide continual feedback during the development/QA process. Previews can be configured to expire or be destroyed when a pull request is closed, so environments exist only as long as they are needed. Uffizzi also helps deconflict shared development environments since previews are deployed as isolated namespaces—there is no risk of clobbering another developer's preview. 
 
-## Getting started with Uffizzi
+While Uffizzi depends on Kubernetes, it does not require end-users to interface with Kubernetes directly. Instead, Uffizzi leverages Docker Compose as its configuration file format, so developers do not need modify Kubernetes manifests or even know about Kubernetes.
 
-The fastest and easiest way to get started with Uffizzi is via the fully hosted version available at https://uffizzi.com, which includes free plans for small teams and qualifying open-source projects.
-
-Alternatively, you can self-host Uffizzi via the open-source repositories available here on GitHub. The remainder of this README is intended for users interested in self-hosting Uffizzi or for those who are just curious about how Uffizzi works.
+Uffizzi is designed to integrate with any CI/CD system.
 
 ## Uffizzi Architecture
+<img src="https://github.com/UffizziCloud/uffizzi_app/blob/main/docs/images/uffizzi-architecture.png" description="Uffizzi Architecture" width="320"/>  
 
 Uffizzi consists of the following components:
 
 - [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app) - The primary REST API for creating and managing Previews
 - [Uffizzi Controller](https://github.com/UffizziCloud/uffizzi_controller) - A smart proxy service that handles requests from Uffizzi App to the Kubernetes API
 - Uffizzi CLI (this repository) - A command-line interface for Uffizzi App
-- [Uffizzi Dashboard](https://app.uffizzi.com) - A graphical user interface for Uffizzi App, available as a paid service at https://uffizzi.com
 
 To host Uffizzi yourself, you will also need the following external dependencies:
 
@@ -29,197 +27,145 @@ To host Uffizzi yourself, you will also need the following external dependencies
 
 ## Installation
 
-Add this line to your application's `Gemfile`:
-
-```ruby
-gem 'uffizzi-cli'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install uffizzi-cli
+The Uffizzi CLI can be used interactively or as part of an automated workflow (e.g. GitHub Actions). Both options use the `uffizzi/cli` container image available on Docker Hub.
 
-### Docker image
+### Interactive mode
 
-We also provide an image on Docker Hub:
-
-```bash
-docker run -it --rm uffizzi/cli project list
+Run the CLI as a Docker container in interactive mode:  
+```
+docker run --interactive --rm --tty --entrypoint=sh uffizzi/cli
 ```
 
 If you specify the following environment variables, the Docker image's
 entrypoint script can log you into Uffizzi before executing your command.
 
 - `UFFIZZI_USER`
-- `UFFIZZI_HOSTNAME`
+- `UFFIZZI_SERVER`
 - `UFFIZZI_PASSWORD`
 - `UFFIZZI_PROJECT` (optional)
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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).
-
-Run rubocop:
-`bundle exec rubocop -A`
-
-## Testing
+### Automated mode  
 
-Run tests:
-`bundle exec rake test`
-
-Run tests from a file:
-`bundle exec rake test TEST=test/uffizzi/cli/preview_test.rb`
-
-Run single test
-`bundle exec rake test TEST=test/uffizzi/cli/preview_test.rb TESTOPTS="--name=test_name"`
-
-## Commands
-
-### login
+If you want to use Uffizzi as part of an automated workflow, you can pass the Uffizzi commands to the Docker run command. For example:    
 
 ```
-$ uffizzi login --user your@email.com --hostname localhost:8080
+docker run -it --rm uffizzi/cli project list
 ```
 
-Logging you into the app which you set in the hostname option.
-
-### login options
+## Sample commands and examples
 
-| Option       | Aliase | Description               |
-| ------------ | ------ | ------------------------- |
-| `--user`     | `-u`   | Your email for logging in |
-| `--hostname` |        | Adress of your app        |
+### help
 
-If hostname uses basic authentication you can specify options for it by setting `basic_auth_user` and `basic_auth_password` via `config set` command.
+The `help` subcommand can be used to see more information about a particular command.
 
-### project
+Examples:
 
 ```
-$ uffizzi project
+uffizzi help
 ```
 
-Use this command to configure your projects. This command has 2 subcommands `list` and `compose`.
-
 ```
-$ uffizzi project list
+uffizzi preview help
 ```
 
-Shows all your projects' slugs
-
-If you have only one project it will be added to your config file automatically, if there's more than one project you need to set up your project manually with the command `uffizzi config set YOUR_PROJECT_SLUG`
-
-### compose
-
 ```
-$ uffizzi project compose
+uffizzi project compose help
 ```
 
-That's the subcommand for project command. Use it to configure your compose file. This command has 3 subcommands `set`, `describe` and `unset`.
+### login
 
 ```
-$ uffizzi project compose set -f path_to_your_compose_file.yml
+uffizzi login --server=localhost:8080 --username=your@email.com
 ```
 
-Creates a new or updates existed compose file in uffizzi app for project specified in config file
+Log in to the app with the specified server.
 
-```
-$ uffizzi project compose describe
-```
+#### login options
 
-Shows the content of compose file related to project specified in config file if it's valid or validation errors if it's not
+| Option       | Aliase | Description               |
+| ------------ | ------ | ------------------------- |
+| `--username`     | `-u`   | Your email for logging in |
+| `--server` |        | The URL of the Uffizzi installation  |
 
-```
-$ uffizzi project compose unset
-```
+If server uses basic authentication you can specify options for it by setting `basic_auth_user` and `basic_auth_password` via `config set` command.
 
-Removes compose file related to project specified in config file
+### config
 
-You need to set project before use any of these commands via `uffizzi config set project YOUR_PROJECT_SLUG` command
+Use this command to configure your cli app.
 
-### compose options
+```
+$ uffizzi config
+```
 
-| Option   | Aliase | Description               |
-| -------- | ------ | ------------------------- |
-| `--file` | `-f`   | Path to your compose file |
+Launching interactive setup guide that sets the values for `server`, `username` and `project`
 
-### config
+### config subcommands
 
-Use this command to configure your cli app. This command has 4 subcommands `list`, `get`, `set`, and `delete`.
+This command has 4 subcommands `list`, `get`, `set`, and `delete`.
 
 ```
-$ uffizzi config list
+uffizzi config list
 ```
 
 Shows all options and their values from the config file.
 
 ```
-$ uffizzi config get OPTION
+uffizzi config get-value OPTION
 ```
 
 Shows the value of the specified option.
 
 ```
-$ uffizzi config set OPTION VALUE
+uffizzi config set OPTION VALUE
 ```
 
 Sets specified value for specified option. If a specified option already exists and has value it will be overwritten.
 
 ```
-$ uffizzi config delete OPTION
+uffizzi config unset OPTION
 ```
 
-Deletes specified option.
+Unsets specified option.
 
-### disconnect ###
+### project
 
 ```
-$ uffizzi disconnect CREDENTIAL_TYPE
+uffizzi project
 ```
 
-Deletes credential of specified type
+Use this command to configure your projects. This command has 2 subcommands `list` and `compose`.
 
-Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
+```
+uffizzi project list
+```
 
-## Generate manual
+Shows all your projects' slugs
 
-In order to generate a manual, create a `.ronn` file having a name pattern like `uffizzi-{command-name}` (for example `uffizzi-project-compose`) in the `man` directory and run `bundle exec ronn man/{filename}.ronn` 
+If you have only one project it will be added to your config file automatically, if there's more than one project you need to set up your project manually with the command `uffizzi config set YOUR_PROJECT_SLUG`
 
-## Git workflow for the app:
+### preview
 
-1. Clone the repository and checkout to `develop` branch
+Create and manage previews
 
-2. Pull repository to ensure you have the latest changes
 ```
-git pull --rebase develop
+uffizzi preview create docker-compose.uffizzi.yml
 ```
+Create a preview from a compose file.
 
-3. Start new branch from `develop`
 ```
-git checkout -b feature/short_issue_description (e.g. feature/add_domain_settings)
+uffizzi preview delete deployment-21
 ```
+Delete a preview with preview ID `deployment-21`.
+
+### disconnect
 
-4. Make changes you need for the feature, commit them to the repo
 ```
-git add .
-git commit -m 'short commit description' (e.g. git commit -m 'added domain settings')
-git push origin BRANCH_NAME
+uffizzi disconnect CREDENTIAL_TYPE
 ```
 
-4. You already can create PR with develop branch as a target. Once the feature is ready let us know in the channel - we will review
+Deletes credential of specified type
 
-5. Merge your feature to `qa` branch and push. Ensure your pipeline is successful
-```
-git checkout qa
-git pull --rebase qa
-git merge --no-ff BRANCH_NAME
-git push origin qa
-```
+Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
 
 ## Contributing
 

data/config/uffizzi.rb

@@ -12,7 +12,7 @@ module Uffizzi
   end
 
   configure do |config|
-    config.hostname = 'http://web:7000'
+    config.server = 'http://web:7000'
     config.credential_types = {
       dockerhub: 'UffizziCore::Credential::DockerHub',
       azure: 'UffizziCore::Credential::Azure',
@@ -20,5 +20,6 @@ module Uffizzi
       amazon: 'UffizziCore::Credential::Amazon',
       github_container_registry: 'UffizziCore::Credential::GithubContainerRegistry',
     }
+    config.default_server = 'app.uffizzi.com'
   end
 end

data/lib/uffizzi/auth_helper.rb

@@ -5,14 +5,13 @@ module Uffizzi
     class << self
       def signed_in?
         ConfigFile.exists? &&
-          ConfigFile.option_exists?(:account_id) &&
-          ConfigFile.option_exists?(:cookie) &&
-          ConfigFile.option_exists?(:hostname)
+          ConfigFile.option_has_value?(:account_id) &&
+          ConfigFile.option_has_value?(:cookie) &&
+          ConfigFile.option_has_value?(:server)
       end
 
-      def project_set?
-        ConfigFile.exists? &&
-          ConfigFile.option_exists?(:project)
+      def project_set?(options)
+        !options[:project].nil? || (ConfigFile.exists? && ConfigFile.option_has_value?(:project))
       end
     end
   end

data/lib/uffizzi/cli/common.rb

@@ -6,7 +6,7 @@ module Cli
   class Common
     class << self
       def show_manual(command_name)
-        manual_doc_path = "man/#{command_name}"
+        manual_doc_path = File.join(Uffizzi.root, "man/#{command_name}")
 
         Open3.pipeline("man #{manual_doc_path}")
       end

data/lib/uffizzi/cli/config.rb

@@ -7,13 +7,19 @@ module Uffizzi
   class CLI::Config < Thor
     include ApiClient
 
+    class << self
+      def help(_shell, _subcommand)
+        Cli::Common.show_manual(:config)
+      end
+    end
+
     desc 'list', 'list'
     def list
       run('list')
     end
 
     desc 'get [PROPERTY]', 'get'
-    def get(property)
+    def get_value(property)
       run('get', property)
     end
 
@@ -22,11 +28,20 @@ module Uffizzi
       run('set', property, value)
     end
 
-    desc 'delete [PROPERTY]', 'delete'
-    def delete(property)
-      run('delete', property)
+    desc 'unset [PROPERTY]', 'unset'
+    def unset(property)
+      run('unset', property)
+    end
+
+    desc 'setup', 'setup'
+    def setup
+      run('setup')
     end
 
+    map('get-value' => :get_value)
+
+    default_task :setup
+
     private
 
     def run(command, property = nil, value = nil)
@@ -37,11 +52,26 @@ module Uffizzi
         handle_get_command(property)
       when 'set'
         handle_set_command(property, value)
-      when 'delete'
-        handle_delete_command(property)
+      when 'unset'
+        handle_unset_command(property)
+      when 'setup'
+        handle_setup_command
       end
     end
 
+    def handle_setup_command
+      Uffizzi.ui.say("Configure the default properties that will be used to authenticate with your \
+                      \nUffizzi API service and manage previews.\n")
+      server = Uffizzi.ui.ask('Server: ', default: Uffizzi.configuration.default_server.to_s)
+      username = Uffizzi.ui.ask('Username: ')
+      project = Uffizzi.ui.ask('Project: ')
+      ConfigFile.delete
+      ConfigFile.write_option(:server, server)
+      ConfigFile.write_option(:username, username)
+      ConfigFile.write_option(:project, project)
+      Uffizzi.ui.say('To login, run: uffizzi login')
+    end
+
     def handle_list_command
       ConfigFile.list
     end
@@ -55,10 +85,12 @@ module Uffizzi
 
     def handle_set_command(property, value)
       ConfigFile.write_option(property.to_sym, value)
+      Uffizzi.ui.say("Updated property [#{property}]")
     end
 
-    def handle_delete_command(property)
-      ConfigFile.delete_option(property.to_sym)
+    def handle_unset_command(property)
+      ConfigFile.unset_option(property.to_sym)
+      Uffizzi.ui.say("Unset property [#{property}]")
     end
   end
 end

data/lib/uffizzi/cli/connect.rb

@@ -35,8 +35,8 @@ module Uffizzi
         type: Uffizzi.configuration.credential_types[:dockerhub],
       }
 
-      hostname = ConfigFile.read_option(:hostname)
-      response = create_credential(hostname, params)
+      server = ConfigFile.read_option(:server)
+      response = create_credential(server, params)
 
       if ResponseHelper.created?(response)
         print_success_message('DockerHub')
@@ -57,8 +57,8 @@ module Uffizzi
         type: Uffizzi.configuration.credential_types[:azure],
       }
 
-      hostname = ConfigFile.read_option(:hostname)
-      response = create_credential(hostname, params)
+      server = ConfigFile.read_option(:server)
+      response = create_credential(server, params)
 
       if ResponseHelper.created?(response)
         print_success_message('ACR')
@@ -79,8 +79,8 @@ module Uffizzi
         type: Uffizzi.configuration.credential_types[:amazon],
       }
 
-      hostname = ConfigFile.read_option(:hostname)
-      response = create_credential(hostname, params)
+      server = ConfigFile.read_option(:server)
+      response = create_credential(server, params)
 
       if ResponseHelper.created?(response)
         print_success_message('ECR')
@@ -103,8 +103,8 @@ module Uffizzi
         type: Uffizzi.configuration.credential_types[:google],
       }
 
-      hostname = ConfigFile.read_option(:hostname)
-      response = create_credential(hostname, params)
+      server = ConfigFile.read_option(:server)
+      response = create_credential(server, params)
 
       if ResponseHelper.created?(response)
         print_success_message('GCR')

data/lib/uffizzi/cli/disconnect.rb

@@ -22,7 +22,7 @@ module Uffizzi
                           raise Uffizzi::Error.new('Unsupported credential type.')
       end
 
-      response = delete_credential(ConfigFile.read_option(:hostname), connection_type)
+      response = delete_credential(ConfigFile.read_option(:server), connection_type)
 
       if ResponseHelper.no_content?(response)
         Uffizzi.ui.say("Successfully disconnected #{connection_name(credential_type)} connection")

data/lib/uffizzi/cli/login.rb

@@ -13,13 +13,15 @@ module Uffizzi
     end
 
     def run
-      password = ENV['UFFIZZI_PASSWORD'] || IO::console.getpass('Enter Password: ')
-
-      params = prepare_request_params(password)
-      response = create_session(@options[:hostname], params)
+      Uffizzi.ui.say('Login to Uffizzi to your previews.')
+      server = set_server
+      username = set_username
+      password = set_password
+      params = prepare_request_params(username, password)
+      response = create_session(server, params)
 
       if ResponseHelper.created?(response)
-        handle_succeed_response(response)
+        handle_succeed_response(response, server, username)
       else
         ResponseHelper.handle_failed_response(response)
       end
@@ -27,20 +29,37 @@ module Uffizzi
 
     private
 
-    def prepare_request_params(password)
+    def set_server
+      config_server = ConfigFile.exists? && ConfigFile.option_has_value?(:server) ? ConfigFile.read_option(:server) : nil
+      @options[:server] || config_server || Uffizzi.ui.ask('Server: ')
+    end
+
+    def set_username
+      config_username = ConfigFile.exists? && ConfigFile.option_has_value?(:username) ? ConfigFile.read_option(:username) : nil
+      @options[:username] || config_username || Uffizzi.ui.ask('Username: ')
+    end
+
+    def set_password
+      ENV['UFFIZZI_PASSWORD'] || Uffizzi.ui.ask('Password: ', echo: false)
+    end
+
+    def prepare_request_params(username, password)
       {
         user: {
-          email: @options[:user],
-          password: password.strip,
+          email: username,
+          password: password,
         },
       }
     end
 
-    def handle_succeed_response(response)
+    def handle_succeed_response(response, server, username)
       account = response[:body][:user][:accounts].first
       return Uffizzi.ui.say('No account related to this email') unless account_valid?(account)
 
-      ConfigFile.create(account[:id], response[:headers], @options[:hostname])
+      ConfigFile.write_option(:server, server)
+      ConfigFile.write_option(:username, username)
+      ConfigFile.write_option(:cookie, response[:headers])
+      ConfigFile.write_option(:account_id, account[:id])
     end
 
     def account_valid?(account)

data/lib/uffizzi/cli/logout.rb

@@ -14,8 +14,8 @@ module Uffizzi
     def run
       return Uffizzi.ui.say('You are not logged in') unless Uffizzi::AuthHelper.signed_in?
 
-      hostname = ConfigFile.read_option(:hostname)
-      destroy_session(hostname)
+      server = ConfigFile.read_option(:server)
+      destroy_session(server)
 
       ConfigFile.delete
       Uffizzi.ui.say('You have been successfully logged out')

data/lib/uffizzi/cli/preview/service.rb

@@ -12,7 +12,7 @@ module Uffizzi
     desc 'logs [LOGS_TYPE] [DEPLOYMENT_ID] [CONTAINER_NAME]', 'logs'
     def logs(logs_type, deployment_name, container_name = args)
       return Uffizzi.ui.say('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
-      return Uffizzi.ui.say('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?
+      return Uffizzi.ui.say('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?(options)
 
       deployment_id = PreviewService.read_deployment_id(deployment_name)
       response = service_logs_response(logs_type, deployment_id, container_name)
@@ -28,12 +28,12 @@ module Uffizzi
     desc 'logs [DEPLOYMENT_ID]', 'list'
     def list(deployment_name)
       return Uffizzi.ui.say('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
-      return Uffizzi.ui.say('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?
+      return Uffizzi.ui.say('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?(options)
 
       project_slug = ConfigFile.read_option(:project)
-      hostname = ConfigFile.read_option(:hostname)
+      server = ConfigFile.read_option(:server)
       deployment_id = PreviewService.read_deployment_id(deployment_name)
-      response = fetch_deployment_services(hostname, project_slug, deployment_id)
+      response = fetch_deployment_services(server, project_slug, deployment_id)
 
       if ResponseHelper.ok?(response)
         handle_succeed_list_response(response, deployment_name)
@@ -46,11 +46,11 @@ module Uffizzi
 
     def service_logs_response(logs_type, deployment_id, container_name)
       project_slug = ConfigFile.read_option(:project)
-      hostname = ConfigFile.read_option(:hostname)
+      server = ConfigFile.read_option(:server)
 
       case logs_type
       when 'container'
-        fetch_deployment_service_logs(hostname, project_slug, deployment_id, container_name)
+        fetch_deployment_service_logs(server, project_slug, deployment_id, container_name)
       else
         raise Uffizzi::Error.new('Unknown log type')
       end