gleis 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad8f8e30fef22c8c714d92e602847f01d0ff7168e083cf134c223678545c43a
-  data.tar.gz: 24e396158f978e59f026e129f5c789eef09be4241c4f2f4f024117e624cc5ec8
+  metadata.gz: 8832f19d9aa54a36a1a1d1e7682b1ce6017294c22115bf83755d6eeb7331a2e3
+  data.tar.gz: 15f7458349747ce180483878bb02761473324130ac254d0754a388d7fb6535ff
 SHA512:
-  metadata.gz: 51d40cf0a453b0ce8186cb0f4a5f99c5d46aa30cada7cae15834c7c9d02a0fb70cfec6168c983628de442a2d9cb04f1ac5ecd52a6c4ddf418c44c339e998b5c6
-  data.tar.gz: a58043fce6783a3d38d7105abe198ec3bb63599eeb86286804fecac09b142ac7c11302bf99232470b044eb9f03496565771913f426b3acf78cac964fe627cbb5
+  metadata.gz: ca53e5e9fae14cd827ce6b476a911a3add034fec36fc70858b157cc898c3325a4c446a37aeb2efc6d320589a250831cbdb91ddd698a90bbcf4d2bd3905e03a92
+  data.tar.gz: 685270a20f7c4076aac97dc46784974abfbca9607567e2ef3a061210fcce5028c639631425c077934e51d4eff7720ad870e4e60d461fcae4b8a9431c2e6033ca

data/CHANGELOG.md

@@ -5,6 +5,65 @@ All notable changes to the Gleis CLI will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.0 - 2020-08-21
+
+### Added
+
+- New command called healthcheck in order to show and change the health check path of an app
+
+### Changed
+
+- References to old gleis.cloud domain by new domain name gleis.io
+- Version dependency of thor
+
+## 0.9.0 - 2020-06-26
+
+### Added
+
+- Meaningful reason why app create command failed in case of problem
+
+### Fixed
+
+- Extra space in SSH key generator comment and typo in user message when command is unavailable
+- Raw invalid token message when session times out during the app logs command in follow mode
+
+## 0.8.0 - 2020-04-19
+
+### Changed
+
+- Calls to system commands to check first if external system command exists
+- External system call to which command with own which method
+- Path separator to be dynamic for cross-platform compatibility
+- Password prompt to use IO.noecho instead of depending on stty system command
+- Save path of database dump file to be stored into user home directory instead of tmp
+
+### Fixed
+
+- Adding SSH Host configuration in non-existing SSH config file
+
+## 0.7.1 - 2020-03-20
+
+### Changed
+
+- API URL to use .app top-level domain
+
+## 0.7.0 - 2020-03-07
+
+### Changed
+
+- Version dependency of mdl, rest-client and rubocop
+- Actual year of copyright to be dynamic
+- API POST request read timeout from default of 60s to 600s
+
+### Added
+
+- New command called rebuild in order to rebuild an app image from the git repo
+- Rescue read timeout from API request
+
+### Fixed
+
+- Error message when restarting a not yet deployed app by deprecating error_text usage
+
 ## 0.6.2 - 2019-08-24
 
 ### Fixed

data/exe/gleis

@@ -2,7 +2,7 @@
 
 require 'gleis/main'
 
-puts "\n###  Gleis CLI Copyright (c) 2018-2019 towards GmbH - v#{Gleis::VERSION} - https://gleis.cloud  ###\n\n" \
+puts "\n###  Gleis CLI Copyright (c) 2018-#{Time.new.year} towards GmbH - v#{Gleis::VERSION} - https://gleis.io  ###\n\n" \
   unless ARGF.argv.include?('-q')
 
 trap 'SIGINT' do

data/lib/gleis/api.rb

@@ -12,17 +12,22 @@ module Gleis
           resp = RestClient.send(method, url, 'X-Gleis-Token': token, content_type: :json, accept: :json,
                                               user_agent: user_agent)
         when 'post', 'put'
-          if token
-            resp =
-              RestClient.send(method, url, body.to_json, 'X-Gleis-Token': token, content_type: :json, accept: :json,
-                                                         user_agent: user_agent)
-          else
-            resp = RestClient.send(method, url, body.to_json, content_type: :json, accept: :json,
+          resp = if token
+                   RestClient::Request.execute(method: method.to_s, url: url, payload: body.to_json, read_timeout: 600,
+                                               headers: { 'X-Gleis-Token': token, 'Content-Type': 'application/json',
+                                                          'Accept': 'application/json', 'User-Agent': user_agent })
+                 else
+                   RestClient.send(method, url, body.to_json, content_type: :json, accept: :json,
                                                               user_agent: user_agent)
-          end
+                 end
         when 'stream'
           stream_output = proc { |response|
             response.read_body do |chunk|
+              # Catch timed out session during streaming response to client (e.g. follow log)
+              # in order not to display raw "invalid token" JSON response from API
+              chunk == '{"message":"invalid token"}' && abort('Session has timed out, please login again (invalid token).')
+              # Catch application not found raw JSON response from API
+              chunk == '{"message":"app not found"}' && abort('Application not found.')
               puts chunk
             end
           }
@@ -44,12 +49,15 @@ module Gleis
         abort('Application not found.')
       rescue RestClient::InternalServerError
         abort('An error occured on the platform. Please contact support if this problem persists.')
+      rescue RestClient::Exceptions::ReadTimeout
+        abort('The request timed out reading data from the platform.')
       rescue StandardError # (e.g. SocketError, Errno::ECONNREFUSED, RestClient::BadGateway, ...)
         abort('There was an issue connecting to the Gleis API server.')
       else
-        # Streaming GET returns Net::HTTPInternalServerError in case of issue and no usable response body
-        # In that case the class of resp.body == Net::ReadAdapter
-        if defined? resp
+        # In case the user's session expires during streaming the response class will be NilClass
+        if (defined? resp) && resp.class != NilClass
+          # Streaming GET returns Net::HTTPInternalServerError in case of issue and no usable response body,
+          # in that case the class of resp.body == Net::ReadAdapter
           if resp.body.empty?
             # If there is no body return whole response object
             resp

data/lib/gleis/application.rb

@@ -38,6 +38,7 @@ module Gleis
         puts "You can then access your app using the URL https://#{body['dns_name']}" if body.key? 'dns_name'
       else
         puts 'failed!'
+        puts "\nReason for failure: #{body['message']}" unless body['message'].nil?
       end
     end
 
@@ -74,6 +75,7 @@ module Gleis
 
     def self.exec(app_name, command)
       token = Token.check
+      abort('The SSH client command ssh is not installed on this system.') unless Utils.which('ssh')
       config_body = Config.get_env_vars(app_name, token)
       # Get storage and generate mount parameter
       mount_param = Utils.generate_exec_mount_param(API.request('get', "storage/#{app_name}", token), app_name)
@@ -86,8 +88,8 @@ module Gleis
           -p #{p['run_port']} \
           #{p['run_username']}@#{p['run_server']} \
           '#{Utils.generate_exec_env_param(config_body['env_vars'])} #{mount_param} \
-            #{p['registry_server']}/#{dp_body['namespace']}/#{app_name}:#{dp_body['deployments'].last['commit'][0..6]} \
-            #{command}'")
+          #{p['registry_server']}/#{dp_body['namespace']}/#{app_name}:#{dp_body['deployments'].last['commit'][0..6]} \
+          #{command}'")
       else
         puts 'No deployments found, please deploy your app first.'
       end
@@ -108,6 +110,28 @@ module Gleis
       end
     end
 
+    def self.healthcheck(app_name, path)
+      token = Token.check
+      if path.empty?
+        body = API.request('get', "healthcheck/#{app_name}", token)
+        if body['success'] == 1
+          puts "The path for the health check of the #{app_name} app is: #{body['data']}"
+        else
+          puts 'Failed to fetch health check path for app.'
+        end
+      elsif Utils.uri_path_valid?(path)
+        body = API.request('post', 'healthcheck', token, 'name': app_name, 'path': path)
+        if body['success'] == 1
+          puts "Successfully changed app health check path to: #{path}\n\n"
+          puts "Don't forget to restart your app to make your change effective"
+        else
+          puts "Failed to change app health chech path: #{body['message']}"
+        end
+      else
+        puts 'Invalid health check path'
+      end
+    end
+
     def self.logs(app_name, follow, process)
       token = Token.check
       action = "logs/#{app_name}/#{process}?follow=#{follow}"
@@ -145,13 +169,25 @@ module Gleis
       end
     end
 
+    def self.rebuild(app_name)
+      token = Token.check
+      puts 'Please wait while rebuilding, it could take a few minutes depending on app dependencies and complexity...'
+      body = API.request('post', 'rebuild', token, 'name': app_name)
+      if body['success'] == 1
+        puts "\nSuccessfully rebuilt app from git repo, detailed output from image build below:"
+        puts body['data']
+      else
+        puts 'Failed to rebuild app: ' + body['message']
+      end
+    end
+
     def self.restart(app_name)
       token = Token.check
       body = API.request('post', 'restart', token, 'name': app_name)
       if body['success'] == 1
         puts 'Successfully restarted app using rolling update'
       else
-        puts 'Failed to restart app: ' + body['error_text']
+        puts 'Failed to restart app: ' + body['message']
       end
     end
 

data/lib/gleis/cli/app.rb

@@ -35,6 +35,11 @@ module Gleis
         Application.git(options[:app], options[:quiet])
       end
 
+      desc 'healthcheck [PATH]', 'Show or change the path for the health check'
+      def healthcheck(path = '')
+        Application.healthcheck(options[:app], path)
+      end
+
       desc 'logs', 'View last log entries of a process'
       option :follow, aliases: :'-f', type: :boolean, default: false,
                       desc: 'Follow live log data'
@@ -62,6 +67,11 @@ module Gleis
         Application.ps(options[:app])
       end
 
+      desc 'rebuild', 'Rebuild app from git repo'
+      def rebuild
+        Application.rebuild(options[:app])
+      end
+
       desc 'restart', 'Restart application (rolling update)'
       def restart
         Application.restart(options[:app])

data/lib/gleis/config.rb

@@ -2,14 +2,14 @@ module Gleis
   # Global parameters of gleis gem and app config env variables
   class Config
     # Override default API URL if GLEIS_API_URL env variable is set
-    API_URL = ENV['GLEIS_API_URL'].nil? ? 'https://api.basel.gleis.one/' : ENV['GLEIS_API_URL']
+    API_URL = ENV['GLEIS_API_URL'].nil? ? 'https://api.basel.gleis.app/' : ENV['GLEIS_API_URL']
     API_VERSION = 'v0'.freeze
-    SSH_KEY_FILE_BASE = Dir.home + '/.ssh/gleis'
-    TOKEN_FILE = Dir.home + '/.gleis-token'
+    SSH_KEY_FILE_BASE = File.join(Dir.home, '.ssh', 'gleis')
+    TOKEN_FILE = File.join(Dir.home, '.gleis-token')
 
     def self.get_env_vars(app_name, token)
       body = API.request('get', "config/#{app_name}", token)
-      abort("Failed to get app environment variables: #{body['error_text']}") if body['success'] != 1
+      abort("Failed to get app environment variables: #{body['message']}") if body['success'] != 1
       body
     end
 

data/lib/gleis/database.rb

@@ -8,7 +8,7 @@ module Gleis
       abort('There is no database configured under the DATABASE_URL variable.') unless url
       db_name = url.split('/').last
       timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-      backup_file = "/tmp/#{app_name}_#{db_name}_#{timestamp}.pgdump"
+      backup_file = File.join(Dir.home, "#{app_name}_#{db_name}_#{timestamp}.pgdump")
       if system("pg_dump -f #{backup_file} #{url}")
         puts "Database configured at DATABASE_URL succesfully backed up locally in #{backup_file}"
       else
@@ -102,7 +102,7 @@ module Gleis
 
     def self.psql(app_name)
       token = Token.check
-      abort('The PostgreSQL client psql is not installed on this system.') unless system('which psql >/dev/null')
+      abort('The PostgreSQL client psql is not installed on this system.') unless Utils.which('psql')
       url = Config.get_env_var(app_name, token, 'DATABASE_URL')
       abort('There is no database configured under the DATABASE_URL variable.') unless url
       ENV['PGCONNECT_TIMEOUT'] = '5'

data/lib/gleis/main.rb

@@ -3,6 +3,10 @@ require 'gleis'
 module Gleis
   # This class defines all the main command-line interface commands for gleis
   class Main < Thor
+    def self.exit_on_failure?
+      true
+    end
+
     desc 'login USERNAME', 'Login into Gleis'
     def login(username)
       Authentication.login(username)

data/lib/gleis/management.rb

@@ -21,7 +21,7 @@ module Gleis
     def self.license
       puts <<LICENSE
       Gleis Command Line Interface for the Gleis Platform as a Service
-      Copyright (C) 2018-2019 towards GmbH
+      Copyright (C) 2018-#{Time.new.year} towards GmbH
 
       This program is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by

data/lib/gleis/ssh.rb

@@ -11,9 +11,13 @@ module Gleis
 
       hostname = Socket.gethostname
       datetime = Time.now.strftime('%Y-%m-%d %H:%M')
-      # returns true on success
-      system('ssh-keygen', '-f', key_file, '-b 4096',
-             "-C generated by Gleis CLI for #{username} by #{ENV['USER']}@#{hostname} on #{datetime}")
+      # returns true on success and nil if command is not found or failed
+      if Utils.which('ssh-keygen')
+        system('ssh-keygen', '-f', key_file, '-b 4096',
+               "-Cgenerated by Gleis CLI for #{username} by #{ENV['USER']}@#{hostname} on #{datetime}")
+      else
+        puts 'The SSH key generator command ssh-keygen is not installed on this system.'
+      end
     end
 
     def self.load_public_key(public_key_file)
@@ -21,10 +25,10 @@ module Gleis
     end
 
     def self.add_host_to_config(host_name, private_key_file)
-      config_file = Dir.home + '/.ssh/config'
+      config_file = File.join(Dir.home, '.ssh', 'config')
       ssh_host_line = "Host #{host_name}"
-      # Check if SSH config for hosts already exists
-      return if Utils.line_exists_in_file(config_file, ssh_host_line)
+      # Do not continue if host already exists in current SSH config file
+      return if File.exist?(config_file) && Utils.line_exists_in_file(config_file, ssh_host_line)
 
       f = File.open(config_file, 'a')
       f.puts "\n# Added by Gleis CLI on #{Time.now.strftime('%Y-%m-%d %H:%M')}"

data/lib/gleis/storage.rb

@@ -51,7 +51,7 @@ module Gleis
       abort("Directory #{dir} does not exist or is not a directory.") unless Dir.exist?(dir)
       # Get CLI parameters from API server
       params = Params.get_cli_parameters(token)
-      abort('The rsync tool is not installed on this system.') unless system('which rsync >/dev/null')
+      abort('The rsync tool is not installed on this system.') unless Utils.which('rsync')
       body = API.request('get', "storage/#{app_name}", token)
       if body['success'] == 1
         if (storage = body['data']['storage'].first)

data/lib/gleis/utils.rb

@@ -1,3 +1,5 @@
+require 'io/console'
+
 module Gleis
   # This class gathers various utilities as small methods
   class Utils
@@ -7,9 +9,7 @@ module Gleis
 
     def self.prompt_password
       print 'Password: '
-      system 'stty -echo'
-      password = $stdin.gets.chomp
-      system 'stty echo'
+      password = STDIN.noecho(&:gets).chomp
       puts
       password
     end
@@ -32,7 +32,7 @@ module Gleis
 
     def self.check_for_local_pg_command(command)
       abort("The PostgreSQL client required to run the command #{command}) is not installed on this system.") unless
-        system("which #{command} >/dev/null")
+        which(command)
     end
 
     def self.validate_scale_count(count)
@@ -48,7 +48,7 @@ module Gleis
     end
 
     def self.add_remote_to_git_config(remote_url)
-      config_file = Dir.pwd + '/.git/config'
+      config_file = File.join(Dir.pwd, '.git', 'config')
       return false unless File.exist?(config_file)
 
       # Check if gleis remote already exists
@@ -119,5 +119,25 @@ module Gleis
     def self.update_available?(actual_version)
       Gem::Version.new(Gleis::VERSION) < Gem::Version.new(actual_version)
     end
+
+    def self.which(command)
+      file_extensions = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        file_extensions.each do |extension|
+          executable = File.join(path, "#{command}#{extension}")
+          return executable if File.executable?(executable) && !File.directory?(executable)
+        end
+      end
+      nil
+    end
+
+    def self.uri_path_valid?(path)
+      begin
+        URI.parse("http://localhost:3000#{path}")
+      rescue URI::InvalidURIError
+        return false
+      end
+      true
+    end
   end
 end

data/lib/gleis/version.rb

@@ -1,3 +1,3 @@
 module Gleis
-  VERSION = '0.6.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gleis
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.0.0
 platform: ruby
 authors:
-- Marc Bigler
+- towards GmbH
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,44 +86,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: 0.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: 0.68.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
-description: Command-line interface to deploy and manage your Rails apps on the Swiss
-  PaaS https://gleis.cloud
+        version: '1.0'
+description: "    Command-line interface to deploy and manage your apps on the https://gleis.io
+  Swiss Platform as a Service supporting Ruby, Node.js, Python and .NET Core.\n"
 email:
 - gleis@towards.ch
 executables:
@@ -165,7 +165,7 @@ files:
 - lib/gleis/token.rb
 - lib/gleis/utils.rb
 - lib/gleis/version.rb
-homepage: https://gleis.cloud
+homepage: https://gleis.io
 licenses:
 - GPL-3.0
 metadata:
@@ -188,5 +188,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Gleis CLI to deploy and manage Rails apps on the Gleis PaaS
+summary: Gleis CLI to deploy and manage apps on the Gleis PaaS
 test_files: []