qb 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 352d78a052f07a71c9e99e5cbfdc58024d720fce
-  data.tar.gz: 68a8aef9f041c5670c580a962d3961f9147d106b
+  metadata.gz: b467ba91d8b3b0749fc18e96dd7ef662e7e5b4ba
+  data.tar.gz: a1f902cab87c9bf6f3da4987229ece3938dcc2ad
 SHA512:
-  metadata.gz: 7813746292a10f1a1d710379a4c7e524b92b295b6c8ce5d84d4c777a8f6e0a7f32838b2eb68691172314f4e8ad596f9ce4061e7fbc7833ceb990a047e4d6ddb1
-  data.tar.gz: 053bda3ec3198f7dd15d7b237560f0adf085568b7e6925f2e65ebe8670d981fcf7e4cde14d9683d84a2b5c352248ebd54cb4e512e0f418c4dfb23d06ae3acc15
+  metadata.gz: 2a8bf457e98e65e95dc121bd64e202a90e29991f3576686ec25d8426ccaaaf3d2e3ebcb3af4230a14de1f883678ba99571b39e381eb20a9652196b508d932141
+  data.tar.gz: 3b6a1a2a5773d60d0e3a16d87325a627ebf8138521bc5e4f5a99306aa1a0d818148621c985e03237b3fc7a798adef03769f63edba5c0a9a0a0be230d774ff261

data/.gitmodules

@@ -0,0 +1,12 @@
+[submodule "roles/nrser.blockinfile"]
+	path = roles/nrser.blockinfile
+	url = git@github.com:nrser/ansible-role-blockinfile
+[submodule "roles/nrser.rbenv_gem"]
+	path = roles/nrser.rbenv_gem
+	url = git@github.com:nrser/ansible-nrser.rbenv_gem.git
+[submodule "roles/qb.gitignore/files/gitignore"]
+	path = roles/qb.gitignore/files/gitignore
+	url = git@github.com:nrser/gitignore.git
+[submodule "roles/nrser.rb"]
+	path = roles/nrser.rb
+	url = git@github.com:nrser/ansible-nrser.rb.git

data/.qb-options.yml

@@ -4,3 +4,5 @@ qb.gem:
   license: MIT
 qb.project:
   dev_bin: false
+qb.install_gem:
+  rubies: global

data/bin/qb

@@ -6,6 +6,8 @@ puts "*** LOADING REPO VERSION ***\n\n"
 
 root = File.dirname(File.realpath(File.join(__FILE__, '..')))
 
+puts "source: #{ root }"
+
 Dir.chdir root do
   require 'bundler/setup'
 end

data/dev/setup.yml

@@ -51,3 +51,7 @@
       archive: []
 
   tasks:
+  - name: install gems
+    bundler:
+      chdir: "{{ dev_setup_project_root }}"
+      gem_path: ./.bundle

data/exe/qb

@@ -17,7 +17,7 @@ require 'qb'
 ROOT = QB::ROOT
 ROLES_DIR = QB::ROLES_DIR
 ROLES = Pathname.glob(ROLES_DIR + 'qb.*').map {|path| path.basename.to_s}
-DEBUG_ARGS = ['-d', '--debug']
+DEBUG_ARGS = ['-D', '--debug']
 TMP_DIR = ROOT + 'tmp'
 
 # globals
@@ -38,7 +38,8 @@ def format msg, dump = {}
 end
 
 def role? pathname
-  pathname.directory? && pathname.join('meta', 'qb.yml').file?
+  pathname.directory? &&
+  ['qb.yml', 'qb'].any? {|fn| pathname.join('meta', fn).file?}
 end
 
 def role_matches
@@ -57,7 +58,7 @@ def set_debug! args
   end
 end
 
-def parse! role_arg, var_prefix, vars, defaults, args
+def parse! role, var_prefix, vars, defaults, args
   positional = vars.select do |var|
     var['positional'] == true
   end
@@ -73,8 +74,8 @@ def parse! role_arg, var_prefix, vars, defaults, args
   options = {}
   
   opt_parser = OptionParser.new do |opts|
-    # opts.banner = "qb #{ role_arg } [OPTIONS]#{ positional_banner }"
-    opts.banner = "qb #{ role_arg } [OPTIONS] DIRECTORY"
+    # opts.banner = "qb #{ role.name } [OPTIONS]#{ positional_banner }"
+    opts.banner = "qb #{ role.name } [OPTIONS] DIRECTORY"
     
     vars.each do |var|
       arg_name = var.fetch 'name'
@@ -96,6 +97,21 @@ def parse! role_arg, var_prefix, vars, defaults, args
         ruby_type = case var['type']
         when 'string'
           String
+        when Hash
+          if var['type'].key? 'one_of'
+            klass = Class.new
+            opts.accept(klass) {|value|
+              if var['type']['one_of'].include? value
+                value
+              else
+                raise ArgumentError, "argument '#{ var['name'] }' must be " +
+                  "one of: #{ var['type']['one_of'].join(', ') }"
+              end
+            }
+            klass
+          else 
+            raise ArgumentError, "bad type: #{ var['type'].inspect }"
+          end
         else
           raise ArgumentError, "bad type: #{ var['type'].inspect }"
         end
@@ -110,14 +126,30 @@ def parse! role_arg, var_prefix, vars, defaults, args
       end
       
       # description
-      if var.key? 'description'
-        on_args << var['description'] 
+      description = if var.key? 'description'
+        var['description'] 
       else
-        on_args << "set the #{ var_name } variable"
+        "set the #{ var_name } variable"
       end
       
+      if var['type'].is_a?(Hash) && var['type'].key?('one_of')
+        lb = "\n" + "\t" * 5
+        description += " options:" + 
+          "#{ lb }#{ var['type']['one_of'].join(lb) }"
+      end
+      
+      on_args << description
+      
       if defaults.key? var_name
-        on_args << "(defaults to #{ defaults[var_name] })"
+        on_args << if var['type'] == 'boolean'
+          if defaults[var_name]
+            "default --#{ var['name'] }"
+          else
+            "default --no-#{ var['name'] }"
+          end
+        else
+          "default = #{ defaults[var_name] }"
+        end
       end
       
       debug "adding option", name: arg_name, on_args: on_args
@@ -158,9 +190,18 @@ def with_clean_env &block
   end
 end
 
+def metadata
+  if QB.gemspec.metadata
+    "metadata:\n" + QB.gemspec.metadata.map {|key, value|
+      "  #{ key }: #{ value }"
+    }.join("\n")
+  end
+end
+
 def help
   puts <<-END
 version: #{ QB::VERSION }
+#{ metadata }
 
 syntax:
 
@@ -209,12 +250,18 @@ def main args
     {}
   end
   
-  qb_meta = YAML.load((role.path + 'meta' + 'qb.yml').read) || {}
+  qb_meta = if (role.path + 'meta' + 'qb').exist?
+    YAML.load Cmds.out! (role.path + 'meta' + 'qb').realpath.to_s
+  elsif (role.path + 'meta' + 'qb.yml').exist?
+    YAML.load (role.path + 'meta' + 'qb.yml').read
+  else
+    {}
+  end
   
   vars = qb_meta['vars'] || []
   var_prefix = qb_meta['var_prefix'] || role.namespaceless
   
-  options = parse! role_arg, var_prefix, vars, defaults, args
+  options = parse! role, var_prefix, vars, defaults, args
   
   debug options: options
   
@@ -313,13 +360,13 @@ def main args
   
   Dir.chdir ROOT do
     # install requirements
-    unless (TMP_DIR + 'roles').directory?
-      with_clean_env do
-        Cmds.stream! "ANSIBLE_ROLES_PATH=<%= roles_path %> ansible-galaxy install --ignore-errors -r <%= req_path%>",
-          req_path: (ROOT + 'requirements.yml'),
-          roles_path: tmp_roles_path.to_s
-      end
-    end
+    # unless (TMP_DIR + 'roles').directory?
+    #   with_clean_env do
+    #     Cmds.stream! "ANSIBLE_ROLES_PATH=<%= roles_path %> ansible-galaxy install --ignore-errors -r <%= req_path%>",
+    #       req_path: (ROOT + 'requirements.yml'),
+    #       roles_path: tmp_roles_path.to_s
+    #   end
+    # end
     with_clean_env do
       Cmds.stream! "ANSIBLE_ROLES_PATH=<%= roles_path %> ansible-playbook <%= playbook_path %>", 
         roles_path: ansible_roles_path,

data/lib/qb/version.rb

@@ -1,3 +1,9 @@
 module QB
-  VERSION = "0.1.10"
+  GEM_NAME = 'qb'
+  
+  VERSION = "0.1.11"
+  
+  def self.gemspec
+    Gem.loaded_specs[GEM_NAME]
+  end
 end

data/qb.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'qb/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "qb"
+  spec.name          = QB::GEM_NAME
   spec.version       = QB::VERSION
   spec.authors       = ["nrser"]
   spec.email         = ["neil@ztkae.com"]
@@ -15,6 +15,20 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  
+  # get an array of submodule dirs by executing 'pwd' inside each submodule
+  gem_dir = File.expand_path(File.dirname(__FILE__)) + "/"
+  `git submodule --quiet foreach pwd`.split($\).each do |submodule_path|
+    Dir.chdir(submodule_path) do
+      submodule_relative_path = submodule_path.sub gem_dir, ""
+      # issue git ls-files in submodule's directory and
+      # prepend the submodule path to create absolute file paths
+      `git ls-files`.split($\).each do |filename|
+        spec.files << "#{submodule_relative_path}/#{filename}"
+      end
+    end
+  end
+  
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -25,4 +39,15 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency "cmds", ">= 0.0.9"
   spec.add_dependency "nrser-extras", ">= 0.0.3"
+  
+  if QB::VERSION.end_with? '.dev'
+    commit = `git rev-parse HEAD`.strip
+    
+    spec.metadata = {
+      "built" => Time.now.to_s,
+      "branch" => `git rev-parse --abbrev-ref HEAD`.strip,
+      "commit" => commit,
+      "browse" => "https://github.com/nrser/qb/tree/#{ commit }",
+    }
+  end
 end

data/roles/nrser.blockinfile/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to blockinfile role/module
+
+If you're going to contribute and make a pull request in the GitHub project,
+please consider including some tests for features/fixes
+you want to add in the PR.
+
+# Module testing infrastructure
+
+Run `bash run.sh` in tests dir.
+It copies fixtures dir to testing (working) dir,
+then for each of tests (tests/*.yml) it runs ansible-playbook twice
+(the second run is for idempotency check)
+and see difference between files in testing dir and ones in expected dir.
+
+You can add your own tests by adding the following files and dirs:
+- tests/test-the-feature.yml - A playbook to test "the feature."
+- tests/fixtures/test-the-feature/... - Put fixtures to be tested.
+- tests/expected/test-the-feature/... - Put expected results after running playbook.
+

data/roles/nrser.blockinfile/README.md

@@ -0,0 +1,262 @@
+# Ansible Role: blockinfile
+
+This role contains no tasks, but provides blockinfile module
+which might be useful when you want to maintain multi-line snippets
+in config files in /etc.
+
+Ansible Galaxy Page: [https://galaxy.ansible.com/list#/roles/1475](https://galaxy.ansible.com/list#/roles/1475)
+
+**Request for review:**
+[The pull request to ansible-modules-extras](https://github.com/ansible/ansible-modules-extras/pull/832)
+has been made to include blockinfile module
+in the official distribution of Ansible,
+which enables you to use blockinfile as a standard module without this role!
+
+If you use this module and feel it's useful,
+please leave some endorsement comments on the PR.
+I greatly appreciate if you're
+[an eligible reviewer (existing module author)](https://github.com/ansible/ansible-modules-extras/blob/devel/REVIEWERS.md)
+and could take some time to review the PR,
+otherwise if you could ask reviewers of your acquiaintance for the review.
+It needs two +1 votes from reviewers in order to be nominated for inclusion.
+
+## blockinfile Module
+
+This module will insert/update/remove a block of multi-line text
+surrounded by the marker lines.
+
+Example task:
+
+```yaml
+- blockinfile:
+    dest: /etc/network/interfaces
+    block: |
+      iface eth0 inet static
+          address 192.168.0.1
+          netmask 255.255.255.0
+```
+
+Text inserted/updated by the task in /etc/network/interfaces:
+
+```
+# BEGIN ANSIBLE MANAGED BLOCK
+iface eth0 inet static
+    address 192.168.0.1
+    netmask 255.255.255.0
+# END ANSIBLE MANAGED BLOCK
+```
+
+It uses marker lines `# {BEGIN/END} ANSIBLE MANAGED BLOCK` as default.
+You can specify alternative marker lines by `marker` option
+when you need to update files in other formats like HTML,
+or run multiple blockinfile tasks on the same file.
+
+### Options
+
+If this section doesn't show nicely in Ansible Galaxy Page,
+please refer to equivalent in
+[GitHub Page](https://github.com/yaegashi/ansible-role-blockinfile#options).
+
+> <table border=1 cellpadding=4>
+<tr>
+<th class="head">parameter</th>
+<th class="head">required</th>
+<th class="head">default</th>
+<th class="head">choices</th>
+<th class="head">comments</th>
+</tr>
+<tr>
+<td>backup<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>no</td>
+<td><ul><li>yes</li><li>no</li></ul></td>
+<td><div>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</div></td></tr>
+<tr>
+<td>block<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>The text to insert inside the marker lines. If it's missing or an empty string, the block will be removed as if <code>state</code> were specified to <code>absent</code>.</div></br>
+<div style="font-size: small;">aliases: content<div></td></tr>
+<tr>
+<td>create<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>no</td>
+<td><ul><li>yes</li><li>no</li></ul></td>
+<td><div>Create a new file if it doesn't exist.</div></td></tr>
+<tr>
+<td>dest<br/><div style="font-size: small;"></div></td>
+<td>yes</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>The file to modify.</div></br>
+<div style="font-size: small;">aliases: name, destfile<div></td></tr>
+<tr>
+<td>follow<br/><div style="font-size: small;"> (added in 1.8)</div></td>
+<td>no</td>
+<td>no</td>
+<td><ul><li>yes</li><li>no</li></ul></td>
+<td><div>This flag indicates that filesystem links, if they exist, should be followed.</div></td></tr>
+<tr>
+<td>group<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>name of the group that should own the file/directory, as would be fed to <em>chown</em></div></td></tr>
+<tr>
+<td>insertafter<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>EOF</td>
+<td><ul><li>EOF</li><li>*regex*</li></ul></td>
+<td><div>If specified, the block will be inserted after the last match of specified regular expression. A special value is available; <code>EOF</code> for inserting the block at the end of the file.  If specified regular expresion has no matches, <code>EOF</code> will be used instead.</div></td></tr>
+<tr>
+<td>insertbefore<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul><li>BOF</li><li>*regex*</li></ul></td>
+<td><div>If specified, the block will be inserted before the last match of specified regular expression. A special value is available; <code>BOF</code> for inserting the block at the beginning of the file.  If specified regular expresion has no matches, the block will be inserted at the end of the file.</div></td></tr>
+<tr>
+<td>marker<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td># {mark} ANSIBLE MANAGED BLOCK</td>
+<td><ul></ul></td>
+<td><div>The marker line template. "{mark}" will be replaced with "BEGIN" or "END".</div></td></tr>
+<tr>
+<td>mode<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>mode the file or directory should be. For those used to <em>/usr/bin/chmod</em> remember that modes are actually octal numbers (like 0644). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, <code>u+rwx</code> or <code>u=rw,g=r,o=r</code>).</div></td></tr>
+<tr>
+<td>owner<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>name of the user that should own the file/directory, as would be fed to <em>chown</em></div></td></tr>
+<tr>
+<td>selevel<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>s0</td>
+<td><ul></ul></td>
+<td><div>level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the <code>range</code>. <code>_default</code> feature works as for <em>seuser</em>.</div></td></tr>
+<tr>
+<td>serole<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>role part of SELinux file context, <code>_default</code> feature works as for <em>seuser</em>.</div></td></tr>
+<tr>
+<td>setype<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>type part of SELinux file context, <code>_default</code> feature works as for <em>seuser</em>.</div></td></tr>
+<tr>
+<td>seuser<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td></td>
+<td><ul></ul></td>
+<td><div>user part of SELinux file context. Will default to system policy, if applicable. If set to <code>_default</code>, it will use the <code>user</code> portion of the policy if available</div></td></tr>
+<tr>
+<td>state<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>present</td>
+<td><ul><li>present</li><li>absent</li></ul></td>
+<td><div>Whether the block should be there or not.</div></td></tr>
+<tr>
+<td>validate<br/><div style="font-size: small;"></div></td>
+<td>no</td>
+<td>None</td>
+<td><ul></ul></td>
+<td><div>The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the example below. The command is passed securely so shell features like expansion and pipes won't work.</div></td></tr>
+</table>
+
+### Examples
+
+```yaml
+- name: insert/update "Match User" configuation block in /etc/ssh/sshd_config
+  blockinfile:
+    dest: /etc/ssh/sshd_config
+    block: |
+      Match User ansible-agent
+      PasswordAuthentication no
+```
+
+```yaml
+- name: insert/update eth0 configuration stanza in /etc/network/interfaces
+        (it might be better to copy files into /etc/network/interfaces.d/)
+  blockinfile:
+    dest: /etc/network/interfaces
+    block: |
+      iface eth0 inet static
+          address 192.168.0.1
+          netmask 255.255.255.0
+```
+
+```yaml
+- name: insert/update HTML surrounded by custom markers after <body> line
+  blockinfile:
+    dest: /var/www/html/index.html
+    marker: "<!-- {mark} ANSIBLE MANAGED BLOCK -->"
+    insertafter: "<body>"
+    content: |
+      <h1>Welcome to {{ansible_hostname}}</h1>
+      <p>Last updated on {{ansible_date_time.iso8601}}</p>
+```
+
+```yaml
+- name: remove HTML as well as surrounding markers
+  blockinfile:
+    dest: /var/www/html/index.html
+    marker: "<!-- {mark} ANSIBLE MANAGED BLOCK -->"
+    content: ""
+```
+
+## Requirements
+
+None.
+
+## Role Variables
+
+None.
+
+## Dependencies
+
+None.
+
+## Example Playbook
+
+Complete playbook
+that makes SSH password authentication for specific user prohibited,
+then restarts sshd if needed.
+
+```yaml
+---
+- hosts: all
+  remote_user: ansible-agent
+  sudo: yes
+  roles:
+    - yaegashi.blockinfile
+  tasks:
+    - name: Prohibit SSH password authentication for $SUDO_USER
+      blockinfile:
+        dest: /etc/ssh/sshd_config
+        backup: yes
+        content: |
+          Match User {{ansible_env.SUDO_USER}}
+          PasswordAuthentication no
+      notify: Restart sshd
+  handlers:
+    - name: Restart sshd
+      service
+        name: ssh
+        state: restarted
+```
+
+## License
+
+GPLv3+
+
+## Author Information
+
+[YAEGASHI Takeshi](https://github.com/yaegashi)