ansible_make_role 0.7.1 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ff2c2883c8a8b4d51a218cd24759b9c30800cf3026da0baf6810ff7b277e46
-  data.tar.gz: af5a5ff7ba52f8738d90ae5933c98e31d315596eced5ad283611444867bc2708
+  metadata.gz: 733a900c1e4713d569c5a7c21e99d5bcff43e771579cf3e720dd15acbdc11da6
+  data.tar.gz: 98a2b98de83000661a3951dabd2bee6072e1eabc6a4ec95e861e6296c060dac8
 SHA512:
-  metadata.gz: ef8c02faa05b9151e13d431a9d85ab96460a19cb2b898bc46f022a860cf57a7d82e83b7dc7974118cbb9364d7d5ecad09ffb2a142abdc6c998373435f72e0bac
-  data.tar.gz: 167cf5397c44fb3d961fb6a63ea0242956dcd7542d92af86f1d6c97449a8a0454c4fe62fc3a087a88bec529f2fedf02d2eec8bc6cd950d028aafcf7b9911fc2d
+  metadata.gz: 9ad554b57fe864dc11678ba72deed77be3de0dae7ae6b2c699b67c0526c151f8b96fd622ea2e465be7b940eb9ea2dc938cbeec7f6168e1d57fe65b599ea7094f
+  data.tar.gz: ee02dca7324c5a4b5dd62ed45cd0a2433e7ff2a55421f9e401365ba267cc3b0c504c2e582785b11b58d7961be3d5ccae7145d2feba2cfdf85c19d35ba0b7c4df

data/README.md

@@ -1,19 +1,21 @@
 # ansible-make-role
 
-Pre-compiler that turns `make.yml` files into Ansible roles
+Pre-compiler that turns single-file `role.yml` files into Ansible roles The
+`role.yml` file combines the Ansible `main.yml` where each `main.yml` file is
+represented by a section (`defaults:`, `vars:`, `tasks:` etc.)
 
 ## Usage
 
 ```shell
-    ansible-make-role -f|--force -v|--verbose --version DIR...
+    ansible-make-role -c|--clean -f|--force -g|--git -r|--roles=DIR -v|--verbose --version DIR...
 ```
 
-`ansible-make-role` expects a `make.yml` file in each of the given directories
-and generate a Ansible role from each of them. The generated files will reside
-in subdirectories of the directory of the `make.yml` file but it can be
-overridden by the --target-dir option. `ansible-make-role` only generates
-out-of-date files unless the --force option is used. Use the `--verbose` option
-to get information about the process
+`ansible-make-role` expects a `role.yml` file in each of the given directories
+and generates an Ansible role in it. Existing `main.yml` files will be
+overwritten or removed but other files won't be touched
+
+`ansible-make-role` only generates up-to-date files unless the --force option
+is used
 
 ## Description
 
@@ -53,10 +55,18 @@ handlers: # Goes to handlers/main.yml"
 
 ## Options
 
+`-c, --clean`
+        Clean the project by removing autogenerated files
 
 `-f, --force`
         Re-generate all files even if not needed
 
+`-g, --git`
+        Also handle per-role .gitignore files. Note that the .gitignore file will be overwritten
+
+`-r, --roles=DIR`
+        Use DIR instead of default `./roles`
+
 `-v, --verbose`
         Report progress
 

data/TODO

@@ -0,0 +1,19 @@
+
+o Add a "warning: auto-generated" header to all generated files
+o Checksum of files?
+o Warn before overwrite if checksum doesn't match
+o Write comments "connected" to a section in the section file:
+
+  # Goes to meta/main.yml
+
+  # Goes to defaults/main.yml
+  #
+  defaults:
+    # Goes to defaults/main.yml
+    
+
++ Only copy templates/files if needed. What to do with directories?
+o Remove orphaned files
+
+- (Sym-)link files, templates, and directories?
+- Replace ansible-make-role with an option: "-m - Make a single directory with a 'make.yml' file"

data/ansible_make_role.gemspec

@@ -11,11 +11,10 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Make Ansible role from make.yml file}
   spec.description   = %q{
-                          Instead of having an Ansible role per-directory
-                          main.yml file, ansible-make-role processes a make.yml
-                          file in the role directory and generates the main.yml
-                          files from that. In make.yml each main.yml definition
-                          is contained in a per-file section: 'defaults',
+                          ansible-make-role process a single-file role
+                          definition file and generate an Ansible role from it.
+                          The role is defined in the role.yml file and contain
+                          a section for each Ansible main.yml file: 'defaults',
                           'vars', 'tasks', and 'handlers'. Definitions outside
                           of those sections (notably 'dependencies') are going
                           to the meta/main.yml file
@@ -40,8 +39,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "shellopts", "0.9.3"
+  spec.add_dependency "indented_io"
 end

data/exe/ansible-make-role

@@ -3,21 +3,72 @@
 require 'ansible_make_role.rb'
 require "shellopts"
 
-USAGE = "f,force v,verbose version -- DIRECTORY..."
+USAGE = "c,clean f,force g,git +r,roles=DIR v,verbose version -- DIRECTORY..."
 
+DEFAULT_ROLES_DIR = "./roles"
+
+clean = false
 force = false
+git = false
+roles_dirs = [] # A roles (plural) directory containing role (singular) directories
 verbose = false
 
 args = ShellOpts.process(USAGE, ARGV) { |opt, arg|
   case opt
+    when '-c', '--clean'; clean = true
     when '-f', '--force'; force = true
+    when '-g', '--git'; git = true
+    when '-r', '--roles'
+      File.directory?(arg) or ShellOpts::error "Not a directory: #{arg}"
+      roles_dirs << arg
     when '-v', '--verbose'; verbose = true
     when '--version'; puts "ansible-make-role #{AnsibleMakeRole::VERSION}"; exit
   end
 }
-args.size > 0 or args << "."
 
-for source in args
-  File.directory?(source) or ShellOpts.error "Not a directory: #{source.inspect}"
-  AnsibleMakeRole.make(source, verbose: verbose, force: force)
+AnsibleMakeRole.force = force
+AnsibleMakeRole.git = git
+if verbose
+  def verb(*msgs) print(msgs.join, "\n") end
+else
+  def verb(*_) end
+end
+
+if args.empty? && roles_dirs.empty? 
+  if File.directory?(DEFAULT_ROLES_DIR)
+    roles_dirs << DEFAULT_ROLES_DIR
+  else
+    ShellOpts::error "No role_dirs given"
+  end
+end
+
+role_dirs = args
+for roles_dir in roles_dirs
+  role_dirs += Dir["#{roles_dir}/*"].select { |d| File.directory?(d) }
+end
+
+if role_dirs.empty?
+  $stderr.puts "#{PROGRAM}: No role_dirs found"
+  exit 0
+end
+
+begin
+  for role_dir in role_dirs
+    if clean
+      if AnsibleMakeRole.clean(role_dir)
+        verb("Cleaned #{role_dir}")
+      else
+        verb("Skipped #{role_dir} - already clean")
+      end
+    else
+      if AnsibleMakeRole.make(role_dir)
+        verb("Updated #{role_dir}")
+      else
+        verb("Skipped #{role_dir} - up to date")
+      end
+    end
+  end
+rescue AnsibleMakeRole::Error => ex
+  ShellOpts::fail(ex.message)
 end
+  

data/lib/ansible_make_role.rb

@@ -1,29 +1,74 @@
 require "ansible_make_role/version"
 
-require "shellopts" 
-
 require "fileutils"
 
 module AnsibleMakeRole
-  def self.make(source_dir, verbose: false, force: false)
-    source = "#{source_dir}/make.yml"
-    target_dir = source_dir
-    # TODO: Doesn't belong at this level - catch exceptions in exe instead
-    File.file?(source) or ShellOpts::error "Can't read file #{source.inspect}"
-    File.directory?(target_dir) or ShellOpts::error "Can't find directory #{target_dir}"
-
-    meta_yml = "#{target_dir}/meta/main.yml"
-    if force || !File.exist?(meta_yml) || File.mtime(source) > File.mtime(meta_yml)
-      compile_role(source, target_dir, verbose: verbose)
-    else
-      puts "#{target_dir} is up to date" if verbose
-    end
+  ROLE_FILE_NAME = "role.yml"
+
+  DEFAULT_FORCE_FLAG = false
+  DEFAULT_GIT_FLAG = false
+
+  class Error < StandardError; end
+
+  @force = DEFAULT_FORCE_FLAG
+  def self.force() @force end
+  def self.force=(value) @force = value end
+
+  @git = DEFAULT_GIT_FLAG
+  def self.git() @git end
+  def self.git=(value) @git = value end
+
+  def self.make(role_dir)
+    wrap_system_call_error {
+      role_file = "#{role_dir}/#{ROLE_FILE_NAME}"
+      meta_file = "#{role_dir}/meta/main.yml"
+      if force || !File.exist?(meta_file) || File.mtime(role_file) > File.mtime(meta_file)
+        files = compile_role(role_file, role_dir)
+        if git
+          git_file = "#{role_dir}/.gitignore"
+          FileUtils.rm_f(git_file)
+          if !files.empty?
+            lines = files.map { |f| "./" + f.split("/")[-2..-1].join("/") + "\n" }.join
+            IO.write(git_file, lines)
+          end
+        end
+        true
+      end
+    }
+  end
+
+  def self.clean(role_dir)
+    changed = false
+    wrap_system_call_error {
+      File.exists?("#{role_dir}/#{ROLE_FILE_NAME}") or raise Error "Not a role directory: #{role_dir}"
+      for file in Dir["#{role_dir}/*/main.yml"]
+        FileUtils.rm(file)
+        dir = File.dirname(file)
+        FileUtils.rmdir(dir) if File.empty?(dir)
+        changed = true
+      end
+      git_file = "#{role_dir}/.gitignore"
+      if git && File.exist?(git_file)
+        FileUtils.rm(git_file)
+        changed = true
+      end
+    }
+    return changed
   end
 
 private
-  # source is a file, target is a directory. Target can be nil and defaults to
-  # dirname of source
-  def self.compile_role(source, target, verbose: false)
+  # Turn a SystemCallError into a AnsibleMakeRole::Error exception and remove
+  # Ruby reference from message (eg. "@ rb_sysopen")
+  def self.wrap_system_call_error(&block)
+    begin
+      yield
+    rescue SystemCallError => ex
+      raise Error.new(ex.message.sub(/ @ \w+/, ""))
+    end
+  end
+
+  # source is a single-file role and target is the role directory. Returns list generated files
+  def self.compile_role(source, target)
     meta = []
     sections = {
       "defaults" => [],
@@ -33,7 +78,6 @@ private
     }
     current_section = meta
 
-    puts "Parsing #{source}" if verbose
     File.readlines(source).each { |line|
       line.chomp!
       next if line =~ /^---\s*$/
@@ -50,18 +94,21 @@ private
       end
     }
 
+    generated_files = []
     (sections.to_a + [["meta", meta]]).each { |section, lines|
       next if lines.empty? && section != "meta"
+      next if lines.all? { |l| l =~ /^\s*$/ }
       dir = "#{target}/#{section}"
       file = "#{dir}/main.yml"
+      generated_files << file
 
-      puts "Create #{file}" if verbose
       FileUtils.mkdir_p(dir)
-      File.open("#{dir}/main.yml", "w") { |f|
+      File.open(file, "w") { |f|
         f.puts "---" if section != "meta"
         unindent(lines).each { |l| f.puts l }
       }
     }
+    generated_files
   end
 
   # Unindent lines by the indentation of the first non-comment and non-blank
@@ -74,3 +121,6 @@ private
     lines.map { |l| l.sub(/^#{prefix}/, "") }
   end  
 end
+
+
+

data/lib/ansible_make_role/version.rb

@@ -1,3 +1,3 @@
 module AnsibleMakeRole
-  VERSION = "0.7.1"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible_make_role
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.4
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +66,27 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.9.3
-description: "\n                          Instead of having an Ansible role per-directory\n
-  \                         main.yml file, ansible-make-role processes a make.yml\n
-  \                         file in the role directory and generates the main.yml\n
-  \                         files from that. In make.yml each main.yml definition\n
-  \                         is contained in a per-file section: 'defaults',\n                          'vars',
-  'tasks', and 'handlers'. Definitions outside\n                          of those
-  sections (notably 'dependencies') are going\n                          to the meta/main.yml
-  file\n                       "
+- !ruby/object:Gem::Dependency
+  name: indented_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n                          ansible-make-role process a single-file
+  role\n                          definition file and generate an Ansible role from
+  it.\n                          The role is defined in the role.yml file and contain\n
+  \                         a section for each Ansible main.yml file: 'defaults',\n
+  \                         'vars', 'tasks', and 'handlers'. Definitions outside\n
+  \                         of those sections (notably 'dependencies') are going\n
+  \                         to the meta/main.yml file\n                       "
 email:
 - claus.l.rasmussen@gmail.com
 executables:
@@ -88,6 +101,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- TODO
 - ansible_make_role.gemspec
 - bin/console
 - bin/setup