ansible-role 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48e3658dd970690e8ce5b234e26952eb65e27a4f
-  data.tar.gz: bd1f9cd75e037ff472e35bef3f3f0238f65e2b9f
+  metadata.gz: be87bffbde98bdedefd9484f1eeab58abbfd7741
+  data.tar.gz: d1473384723811a1ffa6678b9418075129df465d
 SHA512:
-  metadata.gz: b045b4d110bae1efd69b31a44378e4c63bc0277676b9069b1ce90da1819de16099d15e5a07855820ff0059021b67e9dace36d63415864195a9c0e7c3791af633
-  data.tar.gz: 5c5e6217a12f8b3785315203949d62dbdfec635941ddb4df052d89c90fe0671e7a0dbd9f060b06c25624f55efeb0023243306b53a4eb7f344cba4b33bda92c3a
+  metadata.gz: 9e4d9cef73c5fb61212aa872ac41f07d113c3ce5de33f8720b5a67094e7a6906d7571e094c36a29d6580c56f726136ff218555f831e9a148d5f53bb6f1b108a4
+  data.tar.gz: 6f44911d8912c80744a8add693afe2137b94dfa0a5e6af6a4095913e763c590521e6e10c3d092259e540b34ee34d7de433197ee2411405f7c56a8333a10c9944

data/README.md

@@ -4,11 +4,10 @@
 [![GitHub Tags](https://img.shields.io/github/tag/weareinteractive/gem-ansible-role.svg)](https://github.com/weareinteractive/gem-ansible-role)
 [![GitHub Stars](https://img.shields.io/github/stars/weareinteractive/gem-ansible-role.svg)](https://github.com/weareinteractive/gem-ansible-role)
 
-
-> Ansible role command line tool for.
+> Small commandline tool to help with ansible roles.
 >
-> * Initialize a new Ansible role
-> * Re-Generating README.md
+> * `init`: Initialize new ansible roles
+> * `docgen`: Re-Generate README.md
 
 ## Installation
 
@@ -28,12 +27,12 @@ Commands:
 
 ### Init
 
-`ansible-role init` generates a role skeleton including:
+Initialize a new role including:
 
 * [`Travis`](https://travis-ci.org): for testing
-* [`Vagrant`](http://www.vagrantup.com): for local testing
-* [`clog-cli`](https://github.com/clog-tool/clog-cli): for CHANGELOG generation
-* [`.editorconfig`](http://editorconfig.org/): for consistent code
+* [`Vagrant`](https://www.vagrantup.com/): for local testing
+* [`clog-cli`](https://github.com/clog-tool/clog-cli): for generating CHANGELOG
+* [`.editorconfig`](http://editorconfig.org/): for consistent coding stlye
 
 ```bash
 $ mkdir my-role
@@ -48,13 +47,13 @@ To generate your role, please give me some info about:
 
 • Role
   Name [my-role]: my-role
-  Description [Best role ever!]: My best role ever!
-  Category [development]: system
+  Description [Best role ever!]: My best role ever
+  Category [development]: demo
   Min ansible version [2.0]: 2.0
 
 • GitHub
   User/Organization [franklin]: weareinteractive
-  Repository [barfoo]: ansible-my-role
+  Repository [my-role]: ansible-my-role
 
        exist
       create  .clog.toml
@@ -65,6 +64,7 @@ To generate your role, please give me some info about:
       create  LICENSE
       create  Vagrantfile
       create  defaults/main.yml
+      create  files
       create  handlers/main.yml
       create  meta/main.yml
       create  meta/readme.yml
@@ -75,21 +75,18 @@ To generate your role, please give me some info about:
       create  tasks/service.yml
       create  templates/etc/my-role.conf.j2
       create  tests/main.yml
+      create  tests/run.sh
       create  vars/main.yml
       create  README.md
 ```
 
-### Docgen
-
-`ansible-role docgen` generates a `README.md` file frrom `meta/readme.yml` and your role files:
+See [weareinteractive.unison](https://github.com/weareinteractive/ansible-unison) for example.
 
-```bash
-$ cd my-role
-$ ansible-role docgen
+### Docgen
 
-```
+`docgen` reads meta data from `meta/main.yml` and a `meta/readme.yml` as well as code from your role files.
 
-You can configure the generated README through these variables:
+The `meta/readme.yml` might look like:
 
 ```yaml
 ---
@@ -102,17 +99,34 @@ badges: |
   [![GitHub Tags](https://img.shields.io/github/tag/weareinteractive/ansible-my-role.svg)](https://github.com/weareinteractive/ansible-my-role)
   [![GitHub Stars](https://img.shields.io/github/stars/weareinteractive/ansible-my-role.svg)](https://github.com/weareinteractive/ansible-my-role)
 description: |
-  > * installs foo
-  > * configures foo
+  > * installs my-role
+  > * configures my-role
 after_dependencies: |
-  * foo dependency
-  * bar dependency
+  * dependency a
+  * dependency b
 after_handlers: |
-  ## Rules
+  ## A new section after the handler section
+
+  Lorem ipsum dolor sit atem ...
+after_usage: |
+  ## A new section after the usage section
 
-  Some other important section...
+  Lorem ipsum dolor sit atem ...
 ```
 
+To re-generate the `README.md` file run:
+
+```bash
+$ mkdir my-role
+$ cd my-role
+$ ansble-docgen
+conflict  README.md
+Overwrite /path/to/my-role/README.md? (enter "h" for help) [Ynaqdh] y
+   force  README.md
+```
+
+See [weareinteractive.unison](https://github.com/weareinteractive/ansible-unison) for example.
+
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.
 

data/lib/ansible/role/cli.rb

@@ -3,6 +3,7 @@ require "git"
 require "thor"
 require "yaml"
 require "ostruct"
+require "fileutils"
 
 module Ansible
   module Role
@@ -51,6 +52,9 @@ module Ansible
         # render templates
         directory  "templates/ansible/role/init", Dir.getwd
 
+        # set mode
+        FileUtils.chmod("a+x", "tests/run.sh")
+
         # generate docs
         docgen
 

data/lib/ansible/role/version.rb

@@ -1,5 +1,5 @@
 module Ansible
   module Role
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/templates/ansible/role/docgen/README.md.tt

@@ -55,6 +55,7 @@ This is an example playbook:
 <%= @data[:files][:tests][:main] %>
 ```
 
+<% if @data[:meta][:readme]["after_usage"] %><%= @data[:meta][:readme]["after_usage"] %><% end %>
 ## Testing
 
 ```shell

data/templates/ansible/role/init/.travis.yml.tt

@@ -2,38 +2,15 @@
 language: python
 python: "2.7"
 
-# Use the new container infrastructure
-sudo: false
+sudo: required
 
-# Install ansible
-addons:
-  apt:
-    packages:
-    - python-pip
-
-install:
-  # Install ansible
-  - pip install ansible
-
-  # Check ansible version
-  - ansible --version
-
-  # Create inventory file
-  - printf 'localhost' > tests/inventory
-
-  # Create ansible.cfg with correct roles_path
-  - printf '[defaults]\nroles_path=../' > ansible.cfg
-
-  # Create role name symlink
-  - ln -s ./ ../<%= @data[:role_name] %>
+before_install:
+  - docker pull franklinkim/ansible:ubuntu-trusty
+  - docker pull franklinkim/ansible:ubuntu-precise
 
 script:
-  # Basic role syntax check
-  - ansible-playbook -i tests/inventory tests/main.yml --syntax-check
-  # TODO run ansible lint
-  # - ansible-lint -L tests/inventory
-  # Run test playbooke
-  - ansible-playbook -i tests/inventory tests/main.yml
+  - docker run -v $(pwd):/opt/ansible franklinkim/ansible:ubuntu-trusty tests/run.sh
+  - docker run -v $(pwd):/opt/ansible franklinkim/ansible:ubuntu-precise tests/run.sh
 
 notifications:
   webhooks: https://galaxy.ansible.com/api/v1/notifications/

data/templates/ansible/role/init/Vagrantfile

@@ -17,7 +17,7 @@ Vagrant.configure("2") do |config|
   # information on available options.
   config.vm.provision "ansible" do |ansible|
     ansible.playbook = "tests/main.yml"
-    ansible.verbose = 'vv'
+    ansible.verbose = 'vvvv'
     ansible.sudo = true
   end
 end

data/templates/ansible/role/init/defaults/main.yml.tt

@@ -1,5 +1,4 @@
 ---
-
 # package name (version)
 <%= @data[:var_name] %>_package: <%= @data[:name] %>
 # service name

data/templates/ansible/role/init/handlers/main.yml.tt

@@ -1,5 +1,4 @@
 ---
-
 - name: restart <%= @data[:name] %>
   service:
     name: "{{ <%= @data[:var_name] %>_service_name }}"

data/templates/ansible/role/init/meta/main.yml.tt

@@ -1,112 +1,141 @@
 ---
-
 galaxy_info:
   author: <%= @data[:author] %>
   company: <%= @data[:company] %>
   description: <%= @data[:description] %>
   min_ansible_version: <%= @data[:min_ansible_version] %>
   license: MIT
+  # Optionally specify the branch Galaxy will use when accessing the GitHub
+  # repo for this role. During role install, if no tags are available,
+  # Galaxy will use this branch. During import Galaxy will access files on
+  # this branch. If travis integration is cofigured, only notification for this
+  # branch will be accepted. Otherwise, in all cases, the repo's default branch
+  # (usually master) will be used.
+  github_branch: master
   #
   # Below are all platforms currently available. Just uncomment
   # the ones that apply to your role. If you don't see your
   # platform on this list, let us know and we'll get it added!
   #
   platforms:
-  #  - name: EL
-  #    versions:
-  #      - all
-  #      - 5
-  #      - 6
-  #  - name: GenericUNIX
-  #    versions:
-  #      - all
-  #      - any
-  #  - name: Fedora
-  #    versions:
-  #      - all
-  #      - 16
-  #      - 17
-  #      - 18
-  #      - 19
-  #      - 20
-  #  - name: opensuse
-  #    versions:
-  #      - all
-  #      - 12.1
-  #      - 12.2
-  #      - 12.3
-  #      - 13.1
-  #      - 13.2
-  #  - name: GenericBSD
-  #    versions:
-  #      - all
-  #      - any
-  #  - name: FreeBSD
-  #    versions:
-  #      - all
-  #      - 8.0
-  #      - 8.1
-  #      - 8.2
-  #      - 8.3
-  #      - 8.4
-  #      - 9.0
-  #      - 9.1
-  #      - 9.1
-  #      - 9.2
-  #  - name: Ubuntu
-  #    versions:
-  #      - all
-  #      - lucid
-  #      - maverick
-  #      - natty
-  #      - oneiric
-  #      - precise
-  #      - quantal
-  #      - raring
-  #      - saucy
-  #      - trusty
-  #  - name: SLES
-  #    versions:
-  #      - all
-  #      - 10SP3
-  #      - 10SP4
-  #      - 11
-  #      - 11SP1
-  #      - 11SP2
-  #      - 11SP3
-  #  - name: GenericLinux
-  #    versions:
-  #      - all
-  #      - any
-  #  - name: Debian
-  #    versions:
-  #      - all
-  #      - etch
-  #      - lenny
-  #      - squeeze
-  #      - wheezy
+  #- name: EL
+  #  versions:
+  #  - all
+  #  - 5
+  #  - 6
+  #  - 7
+  #- name: GenericUNIX
+  #  versions:
+  #  - all
+  #  - any
+  #- name: Solaris
+  #  versions:
+  #  - all
+  #  - 10
+  #  - 11.0
+  #  - 11.1
+  #  - 11.2
+  #  - 11.3
+  #- name: Fedora
+  #  versions:
+  #  - all
+  #  - 16
+  #  - 17
+  #  - 18
+  #  - 19
+  #  - 20
+  #  - 21
+  #  - 22
+  #  - 23
+  #- name: Windows
+  #  versions:
+  #  - all
+  #  - 2012R2
+  #- name: SmartOS
+  #  versions:
+  #  - all
+  #  - any
+  #- name: opensuse
+  #  versions:
+  #  - all
+  #  - 12.1
+  #  - 12.2
+  #  - 12.3
+  #  - 13.1
+  #  - 13.2
+  #- name: Amazon
+  #  versions:
+  #  - all
+  #  - 2013.03
+  #  - 2013.09
+  #- name: GenericBSD
+  #  versions:
+  #  - all
+  #  - any
+  #- name: FreeBSD
+  #  versions:
+  #  - all
+  #  - 10.0
+  #  - 10.1
+  #  - 10.2
+  #  - 8.0
+  #  - 8.1
+  #  - 8.2
+  #  - 8.3
+  #  - 8.4
+  #  - 9.0
+  #  - 9.1
+  #  - 9.1
+  #  - 9.2
+  #  - 9.3
+  #- name: Ubuntu
+  #  versions:
+  #  - all
+  #  - lucid
+  #  - maverick
+  #  - natty
+  #  - oneiric
+  #  - precise
+  #  - quantal
+  #  - raring
+  #  - saucy
+  #  - trusty
+  #  - utopic
+  #  - vivid
+  #  - wily
+  #- name: SLES
+  #  versions:
+  #  - all
+  #  - 10SP3
+  #  - 10SP4
+  #  - 11
+  #  - 11SP1
+  #  - 11SP2
+  #  - 11SP3
+  #- name: GenericLinux
+  #  versions:
+  #  - all
+  #  - any
+  #- name: Debian
+  #  versions:
+  #  - all
+  #  - etch
+  #  - jessie
+  #  - lenny
+  #  - squeeze
+  #  - wheezy  categories:
   #
-  # The number of tags imported by Galaxy is limited to 20,
-  # and tag values containing non-alphanumeric characters will be ignored.
-  # Tag values containing a : will be split into multiple tags.
-  # The tag cloud:ec2, for example, will become two tags: cloud and ec2.
+  # List tags for your role here, one per line. A tag is
+  # a keyword that describes and categorizes the role.
+  # Users find roles by searching for tags. Be sure to
+  # remove the '[]' above if you add tags to this list.
   #
+  # NOTE: A tag is limited to a single word comprised of
+  # alphanumeric characters. Maximum 20 tags per role.
   galaxy_tags:
-  #  - cloud
-  #  - ec2
-  #  - gce
-  #  - rax
-  #  - database
-  #  - nosql
-  #  - sql
-  #  - development
-  #  - monitoring
-  #  - networking
-  #  - packaging
-  #  - system
-  #  - web
+    - <%= @data[:category] %>
+# List your role dependencies here, one per line. Only
+# dependencies available via galaxy should be listed here.
+# Be sure to remove the '[]' above if you add dependencies
+# to this list.
 dependencies: []
-  # List your role dependencies here, one per line. Only
-  # dependencies available via galaxy should be listed here.
-  # Be sure to remove the '[]' above if you add dependencies
-  # to this list.

data/templates/ansible/role/init/meta/readme.yml.tt

@@ -1,5 +1,4 @@
 ---
-
 galaxy_name: <%= @data[:role_name] %>
 github_user: <%= @data[:github_user] %>
 github_name: <%= @data[:github_name] %>
@@ -14,8 +13,13 @@ description: |
   > * manages <%= @data[:name] %>
   > * configures service
 after_dependencies: |
-  * foo dependency
+  * dependency a
+  * dependency b
 after_handlers: |
-  ## Another Section
+  ## A new section after the handler section
+
+  Lorem ipsum dolor sit atem ...
+after_usage: |
+  ## A new section after the usage section
 
   Lorem ipsum dolor sit atem ...

data/templates/ansible/role/init/tests/main.yml.tt

@@ -1,5 +1,4 @@
 ---
-
 - hosts: all
   roles:
     - <%= @data[:role_name] %>

data/templates/ansible/role/init/tests/run.sh.tt

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# define variables
+ROLE_NAME=<%= @data[:role_name] %>
+
+# create role symnlink
+ln -s $(pwd) /usr/share/ansible/roles/$ROLE_NAME
+
+# echo 'installing dependencies'
+# apt-get update
+# apt-get install -qq ...
+
+echo 'checking version'
+ansible --version
+
+echo 'checking syntax'
+ansible-playbook -vvvv -i 'localhost,' -c local $(pwd)/tests/main.yml --syntax-check
+
+echo 'running playbook'
+ansible-playbook -vvvv -i 'localhost,' -c local $(pwd)/tests/main.yml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible-role
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - franklin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -109,6 +109,7 @@ files:
 - templates/ansible/role/init/tasks/service.yml.tt
 - templates/ansible/role/init/templates/etc/%name%.conf.j2
 - templates/ansible/role/init/tests/main.yml.tt
+- templates/ansible/role/init/tests/run.sh.tt
 - templates/ansible/role/init/vars/main.yml
 homepage: https://github.com/weareinteractive/gem-ansible-role
 licenses: