Module: Beaker::DSL::InstallUtils::EZBakeUtils
- Included in:
- Beaker::DSL::InstallUtils
- Defined in:
- lib/beaker/dsl/install_utils/ezbake_utils.rb
Overview
This module contains methods to assist in installing projects from source that use ezbake for packaging.
Private helpers collapse
- LOCAL_COMMANDS_REQUIRED =
[ ['leiningen', 'lein --version', nil], ['lein-pprint', 'lein with-profile ci pprint :version', 'Must have lein-pprint installed under the :ci profile.'], ['java', 'java -version', nil], ['git', 'git --version', nil], ['rake', 'rake --version', nil], ]
Public DSL Methods collapse
Public DSL Methods collapse
-
#ezbake_dev_build(url = "[email protected]:puppetlabs/ezbake.git", branch = "master") ⇒ Object
Install a development version of ezbake into the local m2 repository.
-
#install_from_ezbake(host) ⇒ Object
Installs leiningen project with given name and version on remote host.
-
#install_termini_from_ezbake(host) ⇒ Object
Installs termini with given name and version on remote host.
Private helpers collapse
-
#conditionally_clone(upstream_uri, local_path, branch = "origin/HEAD") ⇒ Object
private
Only clone from given git URI if there is no existing git clone at the given local_path location.
-
#ezbake_config ⇒ Hash
private
Return the ezbake config.
-
#ezbake_install_dir ⇒ String
private
Returns the full path to the installed software on the remote host.
-
#ezbake_install_name ⇒ String
private
Retrieve the tarball installation name.
-
#ezbake_installsh(host, task = "") ⇒ Object
private
A helper that wraps the execution of install.sh in the proper ezbake installation directory.
-
#ezbake_lein_prefix ⇒ String
private
Returns a leiningen prefix with local m2 repo capability.
-
#ezbake_local_cmd(cmd, opts = {}) ⇒ bool
private
Executes a local command using system, logging the prepared command.
-
#ezbake_stage ⇒ Object
private
Prepares a staging directory for the specified project.
-
#ezbake_tools_available? ⇒ Boolean
private
Checks given host for the tools necessary to perform install_from_ezbake.
-
#ezbake_validate_support(host) ⇒ Object
private
Test for support in one place.
-
#install_ezbake_tarball_on_host(host) ⇒ Object
private
Build, copy & unpack tarball on remote host.
Class Attribute Details
.config ⇒ Object
60 61 62 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 60 def config @config end |
Instance Method Details
#conditionally_clone(upstream_uri, local_path, branch = "origin/HEAD") ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Only clone from given git URI if there is no existing git clone at the given local_path location.
241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 241 def conditionally_clone upstream_uri, local_path, branch="origin/HEAD" if ezbake_local_cmd "git --work-tree=#{local_path} --git-dir=#{local_path}/.git status" ezbake_local_cmd "git --work-tree=#{local_path} --git-dir=#{local_path}/.git fetch origin" ezbake_local_cmd "git --work-tree=#{local_path} --git-dir=#{local_path}/.git checkout #{branch}" else parent_dir = File.dirname(local_path) FileUtils.mkdir_p(parent_dir) ezbake_local_cmd "git clone #{upstream_uri} #{local_path}" ezbake_local_cmd "git --work-tree=#{local_path} --git-dir=#{local_path}/.git checkout #{branch}" end end |
#ezbake_config ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Return the ezbake config.
137 138 139 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 137 def ezbake_config EZBakeUtils.config end |
#ezbake_dev_build(url = "[email protected]:puppetlabs/ezbake.git", branch = "master") ⇒ Object
Install a development version of ezbake into the local m2 repository
This can be useful if you want to work on a development branch of ezbake that hasn’t been released yet. Ensure your project dependencies in your development branch include a reference to the -SNAPSHOT version of the project for it to successfully pickup a pre-shipped version of ezbake.
45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 45 def ezbake_dev_build url = "[email protected]:puppetlabs/ezbake.git", branch = "master" ezbake_dir = 'tmp/ezbake' conditionally_clone url, ezbake_dir, branch lp = ezbake_lein_prefix Dir.chdir(ezbake_dir) do ezbake_local_cmd "#{lp} install", :throw_on_failure => true end end |
#ezbake_install_dir ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the full path to the installed software on the remote host.
This only returns the path, it doesn’t work out if its installed or not.
220 221 222 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 220 def ezbake_install_dir "/root/#{ezbake_install_name}" end |
#ezbake_install_name ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Retrieve the tarball installation name. This is the name of the tarball without the .tar.gz extension, and the name of the path where it will unpack to.
206 207 208 209 210 211 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 206 def ezbake_install_name ezbake = ezbake_config project_package_version = ezbake[:package_version] project_name = ezbake[:project] "%s-%s" % [ project_name, project_package_version ] end |
#ezbake_installsh(host, task = "") ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
A helper that wraps the execution of install.sh in the proper ezbake installation directory.
230 231 232 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 230 def ezbake_installsh host, task="" on host, "cd #{ezbake_install_dir}; bash install.sh #{task}" end |
#ezbake_lein_prefix ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a leiningen prefix with local m2 repo capability
146 147 148 149 150 151 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 146 def ezbake_lein_prefix # Get the absolute path to the local repo m2_repo = File.join(Dir.pwd, 'tmp', 'm2-local') 'lein update-in : assoc :local-repo "\"' + m2_repo + '\"" --' end |
#ezbake_local_cmd(cmd, opts = {}) ⇒ bool
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Executes a local command using system, logging the prepared command
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 187 def ezbake_local_cmd cmd, opts={} opts = { :throw_on_failure => false, }.merge(opts) logger.notify "localhost $ #{cmd}" result = system cmd if opts[:throw_on_failure] && result == false raise RuntimeError, "Command failure #{cmd}" end result end |
#ezbake_stage ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Prepares a staging directory for the specified project.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 156 def ezbake_stage # Install the PuppetDB jar into the local repository ezbake_local_cmd "#{ezbake_lein_prefix} install", :throw_on_failure => true # Run ezbake stage ezbake_local_cmd "#{ezbake_lein_prefix} with-profile ezbake ezbake stage", :throw_on_failure => true # Boostrap packaging, and grab configuration info from project staging_dir = File.join('target','staging') Dir.chdir(staging_dir) do ezbake_local_cmd 'rake package:bootstrap' load 'ezbake.rb' ezbake = EZBake::Config ezbake[:package_version] = `printf $(rake pl:print_build_param[ref] | tail -n 1)` EZBakeUtils.config = ezbake end end |
#ezbake_tools_available? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Checks given host for the tools necessary to perform install_from_ezbake.
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 121 def ezbake_tools_available? LOCAL_COMMANDS_REQUIRED.each do |software_name, command, | if not system command = "Must have #{software_name} installed on development system.\n" if += end raise RuntimeError, end end end |
#ezbake_validate_support(host) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Test for support in one place
70 71 72 73 74 75 76 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 70 def ezbake_validate_support host variant, version, _, _ = host['platform'].to_array unless variant =~ /^(fedora|el|centos|debian|ubuntu)$/ raise RuntimeError, "No support for #{variant} within ezbake_utils ..." end end |
#install_ezbake_tarball_on_host(host) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Build, copy & unpack tarball on remote host
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 82 def install_ezbake_tarball_on_host host if not ezbake_config ezbake_stage end # Skip installation if the remote directory exists result = on host, "test -d #{ezbake_install_dir}", :acceptable_exit_codes => [0, 1] return if result.exit_code == 0 ezbake_staging_dir = File.join('target', 'staging') Dir.chdir(ezbake_staging_dir) do ezbake_local_cmd 'rake package:tar' end local_tarball = ezbake_staging_dir + "/pkg/" + ezbake_install_name + ".tar.gz" remote_tarball = ezbake_install_dir + ".tar.gz" scp_to host, local_tarball, remote_tarball # untar tarball on host on host, "tar -xzf " + remote_tarball # Check to ensure directory exists on host, "test -d #{ezbake_install_dir}" end |
#install_from_ezbake(host) ⇒ Object
Installs leiningen project with given name and version on remote host.
17 18 19 20 21 22 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 17 def install_from_ezbake host ezbake_validate_support host ezbake_tools_available? install_ezbake_tarball_on_host host ezbake_installsh host, "service" end |
#install_termini_from_ezbake(host) ⇒ Object
Installs termini with given name and version on remote host.
28 29 30 31 32 33 |
# File 'lib/beaker/dsl/install_utils/ezbake_utils.rb', line 28 def install_termini_from_ezbake host ezbake_validate_support host ezbake_tools_available? install_ezbake_tarball_on_host host ezbake_installsh host, "termini" end |