startapp 0.1.6

data/lib/rhc/commands/clone.rb

@@ -0,0 +1,66 @@
+require 'rhc/commands/git_clone'
+
+module RHC::Commands
+  class Clone < GitClone
+    summary "Clone and configure an application's repository locally"
+    description "This is a convenience wrapper for 'git clone' with the added",
+                "benefit of adding configuration data such as the application's",
+                "UUID to the local repository.  It also automatically",
+                "figures out the Git url from the application name so you don't",
+                "have to look it up."
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+    option ["-r", "--repo dir"], "Path to the Git repository (defaults to ./$app_name)"
+    # alias_action 'app git-clone', :deprecated => true, :root_command => true
+    # TODO: Implement default values for arguments once ffranz has added context arguments
+    # argument :directory, "The name of a new directory to clone into", [], :default => nil
+    def run(app_name)
+
+      if url? app_name
+        if app = clonable_url?(app_name)
+          app_name = options.app = app[:name]
+          options.namespace = app[:domain]
+        else
+          warn "URL is invalid. To clone app your url must be something like this: http://appname-domain.startapp.bg/"
+          return 1
+        end
+      end
+
+      super app_name
+    end
+
+    private
+
+    def clonable_url?(app_name)
+      if startapp_url? app_name
+        app_name = clean_url(app_name)
+        app = extract_name_and_domain(app_name)
+
+        app
+      else
+        false
+      end
+    end
+
+    def url?(candidate)
+      !!(/http|\./.match(candidate))
+    end
+
+    def startapp_url?(candidate)
+      !!(/[a-zA-Z0-9]+-[a-zA-Z0-9]+\.startapp\./.match(candidate))
+    end
+
+    def clean_url(url)
+      url.dup.gsub!(/http(s?):\/\/|\//,'')
+    end
+
+    def extract_name_and_domain(url)
+      result = {}
+      name_and_domain = /([a-zA-Z0-9]+)-([a-zA-Z0-9]+)/.match(url)
+      result[:name], result[:domain] = name_and_domain[1], name_and_domain[2]
+
+      result
+    end
+
+  end
+end

data/lib/rhc/commands/configure.rb

@@ -0,0 +1,20 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class Configure < App
+    summary "Configure several properties that apply to an application"
+    syntax "<app> [--[no-]auto-deploy] [--keep-deployments INTEGER] [--deployment-branch BRANCH] [--deployment-type TYPE] [--namespace NAME]"
+    takes_application :argument => true
+    option ["--[no-]auto-deploy"], "Build and deploy automatically when pushing to the git repo. Defaults to true."
+    option ["--keep-deployments INTEGER", Integer], "Number of deployments to preserve. Defaults to 1."
+    option ["--deployment-branch BRANCH"], "Which branch should trigger an automatic deployment, if automatic deployment is enabled with --auto-deploy. Defaults to master."
+    option ["--deployment-type git|binary"], "Type of deployment the application accepts ('git' or 'binary'). Defaults to git."
+
+    def run(app_name)
+      self.class.superclass.instance_method(:configure).bind(self).call app_name
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/create.rb

@@ -0,0 +1,100 @@
+require 'rhc/commands/app'
+require 'net/http'
+require 'json'
+
+module RHC::Commands
+  class Create < App
+
+    summary "Create an application"
+    description <<-DESC
+      Create an application. Every StartApp application must have one
+      web cartridge which serves web requests, and can have a number of
+      other cartridges which provide capabilities like databases,
+      scheduled jobs, or continuous integration.
+
+      You can see a list of all valid cartridge types by running
+      'app cartridge list'. StartApp also supports downloading cartridges -
+      pass a URL in place of the cartridge name and we'll download
+      and install that cartridge into your app.  Keep in mind that
+      these cartridges receive no security updates.  Note that not
+      all StartAPp servers allow downloaded cartridges.
+
+      When your application is created, a URL combining the name of
+      your app and the name of your domain will be registered in DNS.
+      A copy of the code for your application will be checked out locally
+      into a folder with the same name as your application.  Note that
+      different types of applications may require different folder
+      structures - check the README provided with the cartridge if
+      you have questions.
+
+      StartApp runs the components of your application on small virtual
+      servers called "gears".  Each account or plan is limited to a number
+      of gears which you can use across multiple applications.  Some
+      accounts or plans provide access to gears with more memory or more
+      CPU.  Run 'app account' to see the number and sizes of gears available
+      to you.  When creating an application the --gear-size parameter
+      may be specified to change the gears used.
+
+      DESC
+    syntax "<name> <cartridge> [... <cartridge>] [... VARIABLE=VALUE] [-n namespace]"
+    option ["-n", "--namespace NAME"], "Namespace for the application"
+    option ["-g", "--gear-size SIZE"], "Gear size controls how much memory and CPU your cartridges can use."
+    option ["-s", "--scaling"], "Enable scaling for the web cartridge."
+    option ["-r", "--repo DIR"], "Path to the Git repository (defaults to ./$app_name)"
+    option ["-e", "--env VARIABLE=VALUE"], "Environment variable(s) to be set on this app, or path to a file containing environment variables", :type => :list
+    option ["--from-code URL"], "URL to a Git repository that will become the initial contents of the application"
+    option ["--[no-]git"], "Skip creating the local Git repository."
+    option ["--[no-]dns"], "Skip waiting for the application DNS name to resolve. Must be used in combination with --no-git"
+    option ['--no-keys'], "Skip checking SSH keys during app creation", :hide => true
+    option ["--enable-jenkins [NAME]"], "Enable Jenkins builds for this application (will create a Jenkins application if not already available). The default name will be 'jenkins' if not specified."
+    argument :name, "Name for your application", ["-a", "--app NAME"], :optional => true
+    argument :cartridges, "The web framework this application should use", ["-t", "--type CARTRIDGE"], :optional => true, :type => :list
+
+    def run(name, cartridges)
+
+      quickstarts = get_quickstarts
+
+      if quickstarts.include? cartridges.first
+        bundle = quickstarts[cartridges.first]
+        cartridges = bundle["cartridges"]
+        options.from_code = bundle["code"]
+      end
+
+      cartridges = helping_words_cleaner(cartridges)
+      self.class.superclass.instance_method(:create).bind(self).call name, cartridges
+
+      0
+    end
+
+    private
+
+    def get_quickstarts
+      @response  ||= Net::HTTP.get(URI.parse('http://install.startapp.bg/q/quickstarts.json'))
+      JSON.parse @response
+    end
+
+    def list_quickstarts(quickstarts)
+      quicks = quickstarts.map{ |q| ([q[0], q[1]['name'] || '' ] ) if q[1]['view_on_cli'] == "true" }.compact!.sort{ |a,b| a[1].downcase <=> b[1].downcase }
+      quicks.unshift ['==========', '=========']
+      quicks.unshift ['Quickstart', 'Full name']
+      say table(quicks)
+    end
+
+    def helping_words_cleaner(words_list)
+      words = ['with', 'and']
+      words.each do |word|
+        words_list.delete word
+      end
+      words_list
+    end
+
+    def check_name!(name)
+      return unless name.blank?
+
+      paragraph{ say "You can choose some of ours quickstarts. Just write `app create myapp quickstart`" }
+      paragraph{ list_quickstarts(get_quickstarts) }
+
+    end
+
+  end
+end

data/lib/rhc/commands/delete.rb

@@ -0,0 +1,19 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class Delete < App
+    summary "Delete an application from the server"
+    description "Deletes your application and all of its data from the server.",
+                "Use with caution as this operation is permanent."
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+    option ["--confirm"], "Pass to confirm deleting the application"
+
+    def run(app)
+      self.class.superclass.instance_method(:delete).bind(self).call app
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/deploy.rb

@@ -0,0 +1,32 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class Deploy < App
+
+    summary "Deploy a git reference or binary file of an application"
+    syntax "<ref> --app NAME [--namespace NAME]"
+    description <<-DESC
+      By default OpenShift applications prepare, distribute, and activate deployments
+      on every git push. Alternatively, a user may choose to disable automatic
+      deployments and use 'rhc deploy' and 'rhc deployment' commands to fully control the
+      deployment lifecycle.
+
+      Use this command to prepare, distribute and deploy manually from a git reference
+      (commit id, tag or branch) or from a binary file. Check also 'rhc configure-app'
+      to configure your application to deploy manually and set the number of deployments
+      to keep in history.
+
+      DESC
+    takes_application
+    argument :ref, "Git tag, branch or commit id or path to binary file to be deployed", ["--ref REF"], :optional => false
+    option "--[no-]hot-deploy", "Perform hot deployment according to the specified argument rather than checking for the presence of the hot_deploy marker in the application git repo"
+    option "--[no-]force-clean-build", "Perform a clean build according to the specified argument rather than checking for the presence of the force_clean_build marker in the application git repo"
+
+    def run(ref)
+      self.class.superclass.instance_method(:delete).bind(self).call ref
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/deployment.rb

@@ -0,0 +1,82 @@
+require 'rhc/commands/base'
+require 'rhc/deployment_helpers'
+
+module RHC::Commands
+  class Deployment < Base
+    include RHC::DeploymentHelpers
+
+    summary "Commands for deploying and managing deployments of an application"
+    description <<-DESC
+      By default OpenShift applications prepare, distribute, and activate deployments
+      on every git push. Alternatively, a user may choose to disable automatic
+      deployments and use this 'rhc deployment' set of commands to fully control the
+      deployment lifecycle. Use these commands to deploy manually from a git reference
+      or from a binary file, list and display deployments and also activate existing
+      deployments. Check also 'rhc configure-app' to configure your application to
+      deploy manually.
+
+      DESC
+    syntax "<action>"
+    default_action :help
+
+    summary "List the existing deployments of an application"
+    description <<-DESC
+      List all existing deployments of a given application. Check the 'rhc configure-app'
+      command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<application>"
+    takes_application :argument => true
+    alias_action :"deployments", :root_command => true
+    def list(app)
+      rest_app = find_app
+      deployment_activations = rest_app.deployment_activations
+
+      raise RHC::DeploymentNotFoundException, "No deployments found for application #{app}." if !deployment_activations.present?
+
+      pager
+
+      display_deployment_list(deployment_activations)
+      0
+    end
+
+    summary "Show details of the given deployment"
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    description <<-DESC
+      Display details of the given deployment id.
+
+      DESC
+    takes_application
+    argument :id, "The deployment ID to show", ["--id ID"], :optional => false
+    def show(id)
+      rest_app = find_app
+      item = rest_app.deployment_activations.reverse_each.detect{|item| item[:deployment].id == id}
+
+      raise RHC::DeploymentNotFoundException, "Deployment ID '#{id}' not found for application #{rest_app.name}." if !item.present?
+
+      display_deployment(item)
+      paragraph { say "Use 'rhc show-app #{rest_app.name} --configuration' to check your deployment configurations." }
+      0
+    end
+
+    summary "Activate an existing deployment"
+    description <<-DESC
+      Switch between existing deployments. This command allows you to rollback from one
+      deployment to a previous one or activate subsequent deployments. Check the 'rhc
+      configure-app' command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    takes_application
+    argument :id, "The deployment ID to activate on the application", ["--id ID"], :optional => false
+    def activate(id)
+      rest_app = find_app
+
+      raise RHC::DeploymentsNotSupportedException.new if !rest_app.supports? "DEPLOY"
+
+      activate_deployment(rest_app, id)
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/domain.rb

@@ -0,0 +1,172 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Domain < Base
+    summary "Add or rename the container for your apps"
+    syntax "<action>"
+    description <<-DESC
+      All StartApp applications must belong to a domain.  The name of the domain
+      will be used as part of the public URL for an application.
+
+      For example, when creating a domain with the name "test", any applications
+      created in that domain will have the public URL:
+
+        http://<appname>-test.startapp.bg
+
+      Each account may have access to one or more domains shared by others.  Depending
+      on your plan or configuration, you may be able to create more than one domain.
+
+      To create your first domain, run 'app setup' or 'app create-domain'.
+      DESC
+    default_action :help
+
+    summary "Create a new container for applications."
+    syntax "<namespace>"
+    description <<-DESC
+      A domain is a container for your applications. Each account may have one
+      or more domains (depending on plan), and you may collaborate on applications
+      by adding members to your domain.
+
+      The name of the domain is called its "namespace", and becomes part of the
+      application public URLs. For example, when creating a domain with the name "test",
+      all applications in that domain will have the public URL:
+
+        http://<appname>-test.startapp.bg
+
+      The domain owner may limit the gear sizes available to applications by using the
+      '--allowed-gear-sizes' option.  If '--no-allowed-gear-sizes' is set, no applications
+      can be created in the domain.  Older servers may not support this option.
+      DESC
+    option ['--no-allowed-gear-sizes'], 'Do not allow any gear sizes in this domain.', :optional => true
+    option ['--allowed-gear-sizes [SIZES]'], 'A comma-delimited list of the gear sizes that will be allowed in this domain.', :optional => true
+    argument :namespace, "New domain name (letters and numbers, max 16 chars)", ["-n", "--namespace NAME"]
+    def create(namespace)
+      say "Creating domain '#{namespace}' ... "
+      rest_client.add_domain(namespace, :allowed_gear_sizes => check_allowed_gear_sizes)
+      success "done"
+
+      info "You may now create an application using the 'app create-app' command"
+
+      0
+    end
+
+    summary "Rename a domain (will change application urls)"
+    syntax "<old name> <new name>"
+    argument :old_namespace, "Existing domain name", []
+    argument :new_namespace, "New domain name (letters and numbers, max 16 chars)", ["-n", "--namespace NAME"]
+    alias_action :update, :deprecated => true
+    def rename(old_namespace, new_namespace)
+      domain = rest_client.find_domain(old_namespace)
+
+      say "Renaming domain '#{domain.name}' to '#{new_namespace}' ... "
+      domain.rename(new_namespace)
+      success "done"
+
+      info "Applications in this domain will use the new name in their URL."
+
+      0
+    end
+
+    summary "Change one or more configuration settings on the domain"
+    syntax "<namespace>"
+    option ['--no-allowed-gear-sizes'], 'Do not allow any gear sizes in this domain.', :optional => true
+    option ['--allowed-gear-sizes [SIZES]'], "A comma-delimited list of gear sizes allowed in this domain. To see available sizes, run 'app account'.", :optional => true
+    takes_domain :argument => true
+    def configure(_)
+      domain = find_domain
+      payload = {}
+      payload[:allowed_gear_sizes] = check_allowed_gear_sizes unless options.allowed_gear_sizes.nil? and options.no_allowed_gear_sizes.nil?
+
+      if payload.present?
+        say "Updating domain configuration ... "
+        domain.configure(payload)
+        success "done"
+      end
+
+      paragraph do
+        say format_table("Domain #{domain.name} configuration", get_properties(domain, :allowed_gear_sizes), :delete => true)
+      end
+
+      0
+    end
+
+    summary "Display a domain and its applications"
+    takes_domain :argument => true
+    def show(_)
+      domain = find_domain
+
+      warn "In order to deploy applications, you must create a domain with 'app setup' or 'app create-domain'." and return 1 unless domain
+
+      applications = domain.applications(:include => :cartridges)
+      display_domain(domain, applications, true)
+
+      if applications.present?
+        success "You have #{pluralize(applications.length, 'application')} in your domain."
+      else
+        success "The domain #{domain.name} exists but has no applications. You can use 'app create-app' to create a new application."
+      end
+
+      0
+    end
+
+    summary "Display all domains you have access to"
+    option ['--mine'], "Display only domains you own"
+    option ['--ids'], "Display the unique id of the domain (deprecated, domain IDs are now displayed by default)"
+    alias_action :domains, :root_command => true
+    def list
+      domains = rest_client.send(options.mine ? :owned_domains : :domains)
+
+      warn "In order to deploy applications, you must create a domain with 'app setup' or 'app create-domain'." and return 1 unless domains.present?
+      warn "The --ids option is deprecated. Domain IDs are displayed by default." if options.ids
+
+      domains.each do |d|
+        display_domain(d, nil, true)
+      end
+
+      success "You have access to #{pluralize(domains.length, 'domain')}."
+
+      0
+    end
+
+    summary "Delete a domain"
+    syntax "<namespace>"
+    takes_domain :argument => true
+    option ["-f", "--force"], "Force the action"
+    def delete(_)
+      domain = find_domain
+
+      say "Deleting domain '#{domain.name}' ... "
+      domain.destroy(options.force.present?)
+      success "deleted"
+
+      0
+    end
+
+    summary "Leave a domain (remove your membership)"
+    syntax "<namespace>"
+    argument :namespace, "Name of the domain", ["-n", "--namespace NAME"]
+    def leave(namespace)
+      domain = rest_client.find_domain(namespace)
+
+      say "Leaving domain ... "
+      domain.leave
+      success "done"
+
+      0
+    end
+
+    protected
+      def check_allowed_gear_sizes
+        raise OptionParser::InvalidOption, "--allowed-gear-sizes and --no-allowed-gear-sizes cannot both be specified" unless options.allowed_gear_sizes.nil? or options.no_allowed_gear_sizes.nil?
+        sizes = options.no_allowed_gear_sizes.nil? ? options.allowed_gear_sizes : false
+        raise OptionParser::InvalidOption, "The server does not support --allowed-gear-sizes" unless sizes.nil? || rest_client.api.has_param?(:add_domain, 'allowed_gear_sizes')
+        if sizes.is_a? String
+          sizes.split(',').map(&:strip).map(&:presence)
+        elsif sizes == false
+          []
+        elsif sizes
+          raise OptionParser::InvalidOption, "Provide a comma delimited list of valid gear sizes to --allowed-gear-sizes"
+        end
+      end
+  end
+end

data/lib/rhc/commands/env.rb

@@ -0,0 +1,142 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Env < Base
+    summary "Manages user-defined environment variables set on a given application"
+    syntax "<action>"
+    description <<-DESC
+      Manages the user-defined environment variables set on a given
+      application. To see a list of all environment variables use the command
+      'rhc list-env <application>'. Note that some predefined
+      cartridge-level environment variables can also be overriden,
+      but most variables provided by gears are read-only.
+
+      Type 'rhc set-env --help' for more details.
+
+      DESC
+    default_action :help
+    alias_action :"app env", :root_command => true
+
+    summary "Set one or more environment variable(s) to your application"
+    description <<-DESC
+      Set one or more environment variable(s) to your application.
+      Operands of the form 'VARIABLE=VALUE' set the environment
+      variable VARIABLE to value VALUE. Example:
+
+      rhc set-env VARIABLE1=VALUE1 VARIABLE2=VALUE2 -a myapp
+
+      Environment variables can also be set from a file containing one
+      or more VARIABLE=VALUE pairs (one per line). Example:
+
+      rhc set-env /path/to/file -a myapp
+
+      VALUE may be empty, in that case 'VARIABLE='. Setting a
+      variable to an empty value is different from unsetting it.
+
+      Some default cartridge-level variables can be overriden, but
+      variables provided by gears are read-only.
+
+      DESC
+    syntax "<VARIABLE=VALUE> [... <VARIABLE=VALUE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Environment variable name and value pair separated by an equal (=) sign, e.g. VARIABLE=VALUE", ["-e", "--env VARIABLE=VALUE"], :optional => false, :type => :list
+    takes_application
+    option ["--confirm"], "Pass to confirm setting the environment variable(s)"
+    alias_action :add
+    def set(env)
+      rest_app = find_app
+
+      with_file = env.index {|item| File.file? item}
+
+      env_vars = []
+      env.each {|item| env_vars.concat(collect_env_vars(item))}
+      raise RHC::EnvironmentVariableNotProvidedException.new(
+        (with_file ?
+          "Environment variable(s) not found in the provided file(s).\n" :
+          "Environment variable(s) not provided.\n") <<
+          "Please provide at least one environment variable using the syntax VARIABLE=VALUE. VARIABLE can only contain letters, digits and underscore ('_') and can't begin with a digit.") if env_vars.empty?
+
+      if with_file
+        env_vars.each {|item| default_display_env_var(item.name, item.value)}
+        confirm_action "Do you want to set these environment variables on '#{rest_app.name}?"
+      end
+
+      say 'Setting environment variable(s) ... '
+      rest_app.set_environment_variables(env_vars)
+      success 'done'
+
+      0
+    end
+
+    summary "Remove one or more environment variable(s) currently set to your application"
+    description <<-DESC
+      Remove one or more environment variable(s) currently set to your
+      application. Setting a variable to an empty value is
+      different from unsetting it. When unsetting a default cartridge-
+      level variable previously overriden, the variable will be set
+      back to its default value.
+
+      DESC
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :type => :list
+    takes_application
+    option ["--confirm"], "Pass to confirm removing the environment variable"
+    alias_action :remove
+    def unset(env)
+      rest_app = find_app
+
+      warn 'Removing environment variables is a destructive operation that may result in loss of data.'
+
+      env.each do |e|
+        default_display_env_var(e)
+      end
+
+      confirm_action "Are you sure you wish to remove the environment variable(s) above from application '#{rest_app.name}'?"
+      say 'Removing environment variable(s) ... '
+      rest_app.unset_environment_variables(env)
+      success 'removed'
+
+      0
+    end
+
+    summary "List all environment variables set on the application"
+    description <<-DESC
+      List all user-defined environment variables set on the application.
+      Gear-level variables overriden by the 'rhc set-env' command
+      will also be listed.
+
+      DESC
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+    option ["--table"], "Format the output list as a table"
+    option ["--quotes"], "Format the output list with double quotes for env var values"
+    def list(app)
+      rest_app = find_app
+      rest_env_vars = rest_app.environment_variables
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+    summary "Show the value of one or more environment variable(s) currently set to your application"
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :type => :list
+    takes_application
+    option ["--table"], "Format the output list as a table"
+    option ["--quotes"], "Format the output list with double quotes for env var values"
+    def show(env)
+      rest_app = find_app
+      rest_env_vars = rest_app.find_environment_variables(env)
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+  end
+
+end

data/lib/rhc/commands/force_stop.rb

@@ -0,0 +1,17 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class ForceStop < App
+
+    summary "Stops all application processes"
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+
+    def run(app)
+      self.class.superclass.instance_method(:force_stop).bind(self).call app
+
+      0
+    end
+
+  end
+end