cupper 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3c9044f099f9507069454620cf7aae32285dcd3
-  data.tar.gz: 99a8cf640b7a66eb12f235aa95e8997f61f47f8a
+  metadata.gz: db74b52ddda16fe1e73d2e89e891452ef7bada67
+  data.tar.gz: 725d29c9e8aa93842a26d0e0ee0b67f325e9fa7b
 SHA512:
-  metadata.gz: bfb771781dee62c1c911a9fca95675345a1d29b53f4066a5dc7f95a92b8636ff652ed6704186ec29ae49bb46d506b04cd53f455ae2cb33dd9bf3d67ee4c90657
-  data.tar.gz: ae7534f3f2018676e5a22c161463d364319b17a7808ef00e33917d466ebaf107e50ea864bddc1e0006caaee20a85cd3e74db1c189ed0e76a8e3a9f0a61bf9ea3
+  metadata.gz: 919f337af1d06ab30b6ddcecb6bcd75dccf96e2863d12766795e79a0139bf5659773b18e1f4b2a36fe256f398770ad2fcbfbd37db4840d6e5e44789501a6dbc0
+  data.tar.gz: 29a8b4dc77e18b0bb74afd76c3751de73f377b67040c6dc534e3495087344ddd3074cde6b9ba570bc5f1bf8a186c2d36ef465d999e569a74e46390aed67329af

data/README.md

@@ -1,8 +1,27 @@
 # Cupper
 
-[![Join the chat at https://gitter.im/cupper-reverse-recipe/cupper](https://badges.gitter.im/cupper-reverse-recipe/cupper.svg)](https://gitter.im/cupper-reverse-recipe/cupper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 
+[![Join the chat at https://gitter.im/cupper-reverse-recipe/cupper](https://badges.gitter.im/cupper-reverse-recipe/cupper.svg)](https://gitter.im/cupper-reverse-recipe/cupper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Coverage Status](https://coveralls.io/repos/github/cupper-reverse-recipe/cupper/badge.svg?branch=master)](https://coveralls.io/github/cupper-reverse-recipe/cupper?branch=master)
 
+Taste your environment and creates a cookbook for it!
+Cupper is a command line tool that runs in some environment (see supoorted
+platforms below) and creates a cookbook based on it. It will collect
+information about the package installed, file configuration, groups, users,
+links, links and services. Once you have this cookbook, you can change
+according to your needs, or just runs it in another environment.
+
+## Support Platform
+
+Currently, Cupper support the platforms listed below. It means that we
+tested on this specific platforms and versions, but may work on others
+version. Let us know :)
+
+| Debian       | Arch            |
+| :----------: | :-------------: |
+| Jessie 8.6   | (Coming soon)   |
+| Jessie 8.2   |        .        |
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,16 +34,70 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install cupper
 
 ## Usage
 
+Cupper is a command line tool. All commands are available through bash/shell
+terminal.
+First create a Cupper project with the following command:
+
+```
+$ cupper create <project_name>
+```
+
+This will create a directory within a given name. The structure of the
+Cupper project contains:
+
+```
+.project
+  |
+  |- cookbooks/
+  |- Cupperfile
+  |- .sensibles
+```
+- **cookbook**: the recipe that are generated is stored in this directory
+- **Cupperfile**: configuration file that allows you to customize some items
+inside the cookbook
+- **.sensibles**: specifies all files that are not suppose to be collected
+(patten witha a regex is given)
+
+Inside the project directory you can run the command:
+```
+$ cupper generate
+```
+This will generate a cookbook based on the configurations on the machine
+and store in `cookbooks/` directory.
+
 
 ## Development
 
+This is a common gem, so doesn't needs a bunch of configuration on your
+environment to develop something. Just use a ruby environment with rbenv
+or RVM (ruby 2.2.0 or higher).
+
+### Ohai
+
+We use [Ohai](https://github.com/chef/ohai) gem to extract the information
+about the environment. We created our Ohai plugins, it's code made in ruby,
+so nothing unusual. Check the official
+[doc](https://docs.chef.io/ohai.html) of Ohai for more knowledge about it.
 
 ## Contributing
 
+Any contribution are welcome :)
+Steps:
+- Make a fork
+- Clone the repository
+- Bundle!
+- Make a change
+- Send a Pull Request
+
+## Found any bug? Open a issue
 
+Just go to the
+[issue](https://github.com/cupper-reverse-recipe/cupper/issues) page and
+report the problem. Use a lablel to make it easier to identify if it's
+a bug or a suggestion.

data/cupper.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'thor', '~> 0.19.1'
   spec.add_runtime_dependency 'ohai', '~> 8.15', '>= 8.15.1'
+  spec.add_runtime_dependency 'colorize', '0.8.1'
+  spec.add_runtime_dependency 'i18n', '0.7.0'
 end

data/lib/cupper.rb

@@ -5,13 +5,19 @@ require 'cupper/ohai_plugins'
 require 'cupper/collect'
 require 'cupper/cookbook'
 require 'cupper/entity'
+require 'cupper/config/config'
+require 'cupper/cupperfile'
+require 'cupper/environment'
+require 'cupper/errors'
+
 
 
 module Cupper
-  CUPPER_ROOT       = File.expand_path(File.dirname(__FILE__))
-  OHAI_PLUGINS_PATH = CUPPER_ROOT + '/cupper/plugins/ohai'
+  CUPPER_ROOT         = File.expand_path(File.dirname(__FILE__))
+  OHAI_PLUGINS_PATH   = CUPPER_ROOT + '/cupper/plugins/ohai'
   CUPPER_PLUGINS_PATH = CUPPER_ROOT + '/cupper/plugins/cupper'
-  TEMPLATE_PATH     = CUPPER_ROOT + '/cupper/templates'
+  TEMPLATE_PATH       = CUPPER_ROOT + '/cupper/templates'
+  ENVIRONMENT = Environment.new
 
   # REVIEW: maybe there is a better way and place to load all plugins
   # Loading all cupper plugins

data/lib/cupper/cli.rb

@@ -7,6 +7,7 @@ require 'thor'
 require 'cupper/project'
 require 'cupper/cookbook'
 require 'cupper/ohai_plugins'
+require 'cupper/environment'
 
 module Cupper
   class Cli < Thor
@@ -30,7 +31,12 @@ module Cupper
     desc 'generate', 'Extract configuration and create a cookbook'
     method_option :verbose, :aliases => '-v', :desc => 'Enable output log'
     def generate
-      puts "Generating the Cookbook"
+      puts "Generating the Cookbook..."
+
+      puts "Setting up the environment"
+      Cupper::ENVIRONMENT.check_env(Errors::NoEnvironmentError, Cupper::ENVIRONMENT.root_path)
+      Cupper::ENVIRONMENT.cupperfile
+
       cookbook = Cookbook.new
       if options.verbose?
         puts "Verbose mode enabled"

data/lib/cupper/config/config.rb

@@ -0,0 +1,60 @@
+require "pathname"
+require "cupper/errors"
+require 'colorize'
+
+
+module Cupper
+  module Config
+    extend self
+
+    def parameter(*names)
+      names.each do |name|
+        attr_accessor name
+
+        # For each given symbol we generate accessor method that sets option's
+        # value being called with an argument, or returns option's current value
+        # when called without arguments
+        define_method name do |*values|
+          value = values.first
+          value ? self.send("#{name}=", value) : instance_variable_get("@#{name}")
+        end
+      end
+    end
+
+    def self.configure
+      self.config do
+        parameter :native_configured
+        parameter :sensible_files
+        parameter :allow_downgrade
+        parameter :sourceless_packages
+        parameter :package_version
+
+        native_configured true
+      end
+      # TODO: raise stuff if mandatory stuff is not defined in cupperfile
+    end
+
+    def config(&block)
+      instance_eval &block
+    end
+
+    def load(cupperfile)
+      Kernel.load cupperfile
+      result = Cupper::Config
+
+      puts "Configuration loaded successfully, finalizing and returning"
+      return result
+    end
+
+    def self.all_sensibles
+      sensibles = Array.new
+      unless sensible_files
+        env = Cupper::ENVIRONMENT
+        File.open("#{env.root_path}/.sensibles").each do |line|
+          sensibles.push line.chomp unless line.strip.chomp.match /^#.*/ or line.chomp.empty?
+        end
+      end
+      sensibles
+    end
+  end
+end

data/lib/cupper/cookbook.rb

@@ -6,7 +6,7 @@ module Cupper
   class Cookbook
     # TODO: Read config file to tell the project path and configs
     def initialize(cookbookname='default')
-      @cookbook_path    = "#{Dir.getwd}/#{cookbookname}"
+      @cookbook_path    = "#{Dir.getwd}/cookbooks/#{cookbookname}"
       @cookbook_files_path = "#{@cookbook_path}/files"
       @cookbook_recipes_path = "#{@cookbook_path}/recipes"
       @recipe_deps = [ # TODO this is hard code to reflect all_recipes. Refactor this later

data/lib/cupper/cupperfile.rb

@@ -1,22 +1,44 @@
 module Cupper
   class Cupperfile
 
-    def initialize(loader, keys)
-      @keys   = keys
-      @loader = loader
-      @config, _ = loader.load(keys)
+    def initialize(key)
+      @key   = key
+      @config, _ = Cupper::Config.load(key)
     end
 
-    protected
+    def machine_being_read(name, env)
+      # Load the configuration for the machine
+      results = cupper_config(name, env)
+      config          = results[:config]
 
-    def find_cupperfile(search_path)
-      ["Cupperfile", "cupperfile"].each do |cupperfile|
-        current_path = search_path.join(cupperfile)
-        return current_path if current_path.file?
-      end
+      # Create the machine and cache it for future calls. This will also
+      # return the machine from this method.
+      return new_machine(name, config, env) 
+    end
 
-      nil
+    def new_machine(name, config, env)
+      machine = Attribute.new
+      class << machine
+        attr_accessor :name
+        attr_accessor :config
+        attr_accessor :env
+      end
+      machine.name = name
+      machine.config = config
+      machine.env = env
+      machine
     end
 
+    def cupper_config(name, env)
+      cupperfile = env.find_cupperfile(env.root_path)
+      if cupperfile
+        config = Cupper::Config.load(cupperfile)
+      end
+
+      return {
+        config: config,
+        # TODO: add other meaningfull returns
+      }
+    end
   end
 end

data/lib/cupper/entity.rb

@@ -35,7 +35,7 @@ module Cupper
     end
 
     def render_template
-      ERB.new(@template).result(binding)
+      ERB.new(@template, 0, '-').result(binding)
     end
 
     # Treats entity as a file or as a dir

data/lib/cupper/environment.rb

@@ -1,7 +1,8 @@
+require 'colorize'
 require "pathname"
 require "cupper/cupperfile"
 require "cupper/version"
-require 'colorize'
+require "cupper/errors"
 
 module Cupper
   class Environment
@@ -33,6 +34,7 @@ module Cupper
         raise ex if !root_path 
       rescue ex => ex
         puts "#{ex.message}".red
+        exit
       end
     end
 
@@ -101,20 +103,6 @@ module Cupper
       "#<#{self.class}: #{@cwd}>".encode('external')
     end
 
-    def config_loader
-      return @config_loader if @config_loader
-
-      root_cupperfile = nil
-      if root_path
-        root_cupperfile = find_cupperfile(root_path, @cupperfile_name)
-      end
-
-      @config_loader = Config::Loader.new(
-        Config::VERSIONS, Config::VERSIONS_ORDER)
-      @config_loader.set(:root, root_cupperfile) if root_cupperfile
-      @config_loader
-    end
-
     def environment(cupperfile, **opts)
       path = File.expand_path(cupperfile, root_path)
       file = File.basename(path)
@@ -160,11 +148,11 @@ module Cupper
     end
 
     def cupperfile
-      @cupperfile ||= cupperfile.new(config_loader, [:home, :root])
+      @cupperfile ||= Cupper::Cupperfile.new(find_cupperfile(@root_path))
     end
 
     def find_cupperfile(search_path, filenames=nil)
-      filenames ||= ["cupperfile", "cupperfile"]
+      filenames ||= ["Cupperfile", "cupperfile"]
       filenames.each do |cupperfile|
         current_path = search_path.join(cupperfile)
         return current_path if current_path.file?

data/lib/cupper/errors.rb

@@ -75,10 +75,18 @@ module Cupper
       error_key(:no_env)
     end
 
+    class CupperfileSyntaxError < CupperError
+      error_key(:cupperfile_syntax_error)
+    end
+
     class LocalDataDirectoryNotAccessible < CupperError
       error_key(:local_data_dir_not_accessible)
     end
 
+    class CupperfileLoadError < CupperError
+      error_key(:cupperfile_load_error)
+    end
+
   end
 
 end

data/lib/cupper/project.rb

@@ -22,7 +22,12 @@ module Cupper
         'cookbooks'
       ]
       @files = [
-        'CupperFile'
+        'Cupperfile',
+      ]
+      # TODO: this should not be separated from the others
+      #   files. Try to get them together.
+      @hidden = [
+        'sensibles'
       ]
     end
 
@@ -35,6 +40,10 @@ module Cupper
         Structure.new(dir, "#{@dir}/#{@name}", nil, Entity::DIR).create
         Structure.new(file, "#{@dir}/#{@name}", file).create
       end
+
+      @hidden.each do |file|
+        Structure.new(".#{file}", "#{@dir}/#{@name}", file).create
+      end
     end
   end
 end

data/lib/cupper/recipe.rb

@@ -34,10 +34,6 @@ module Cupper
       (file[1]['type'].split.first(2).join(' ').match('symbolic link'))
     end
 
-    def dir_type?(file)
-      file[1]['type'].match('directory')
-    end
-
     def text_type?(file)
       file[1]['type'].match('text') or file[1]['type'].match('ASCII')
     end
@@ -144,7 +140,7 @@ module Cupper
     def expand_files(files)
       att = Array.new
       files.each do |attr|
-        if text_type?(attr) and (!(attr[1]['related'].nil?) or attr[0].include? "/etc/apt/sources.list")
+        if valid_cookbook_file?(attr)
           path = attr[0]
           source = attr[0]
           group = attr[1]['group']
@@ -162,6 +158,17 @@ module Cupper
       att
     end
 
+    def valid_cookbook_file?(attr)
+      (text_type?(attr) and
+      !sensible_files?(attr) and
+      (!(attr[1]['related'].nil?) or
+      attr[0].include? "/etc/apt/sources.list"))
+    end
+
+    def sensible_files?(attr)
+      !!(Config.all_sensibles.find { |file| attr[0].match Regexp.new("^#{file}$") })
+    end
+
     # Every attribute object is created dynamic
     def new_package(name, version)
       package = Attribute.new

data/lib/cupper/templates/Cupperfile.erb

@@ -0,0 +1,43 @@
+# # -*- mode: ruby -*-
+# # # vi: set ft=ruby :
+#
+# The Cupperfile defines rules to be follow when the
+# recipe is being generated.
+#
+
+Cupper::Config.config do
+  Cupper::Config.configure
+
+  # The files considered sensible are the ones with
+  #   critical information on it. For example, a file
+  #   that has a pem key or a certificate, can`t be
+  #   treaded as a normal file.
+  # Specify the files, or extensions in the '.sensibles'
+  #   on the root of the Cupper project.
+  #
+  # Set this variable to true if you want to ignore
+  #   the .sensibles and copy all the files to the cookbook
+  sensible_files false
+
+  # The packages extracted from the target environment may
+  #   have a older version. If you want to create a recipe
+  #   that allows a downgrade flag to the package manager,
+  #   set this variable to true
+  allow_downgrade false
+
+  # Some packages on the environment may not have a source
+  #   repository related to. This packages will not appear
+  #   in the cookbook, because the package was installed
+  #   using other methods other than the default.
+  #
+  # Setting this variable to true will extract the packages
+  #   without a source repository. Please check the repositories
+  #   on the machine that the cookbook will run before running
+  #   the cookbook.
+  sourceless_packages false
+
+  # The packages are extracted with the version instaled in the
+  #   machine. You may want to not specify the version on the
+  #   recipe. If so, set the variable to false.
+  package_version true
+end

data/lib/cupper/templates/_package.erb

@@ -5,6 +5,7 @@
 #
 <% for @cb in @sources_list %>
 cookbook_file '<%= @cb.path %>' do
+  source '<%= @cb.source %>'
   owner '<%= @cb.owner %>'
   group '<%= @cb.group %>'
   mode '<%=  @cb.mode %>'
@@ -13,7 +14,9 @@ end
 
 <% for @package in @packages %>
 package '<%= @package.name %>' do
+  <% if Cupper::Config.package_version -%>
   version '<%= @package.version %>'
+  <% end -%>
   action :install
 end
 <% end %>

data/lib/cupper/templates/sensibles.erb

@@ -0,0 +1,5 @@
+# List all the files that you want to ignore when
+#   extracting
+*.pem
+*.crt
+

data/lib/cupper/version.rb

@@ -1,3 +1,3 @@
 module Cupper
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/templates/locales/en.yml

@@ -15,3 +15,10 @@ en:
         state is not accessible. The directory specified as the local data
         directory must be both readable and writable for the user that is
         running cupper.
+      cupperfile_syntax_error: |-
+        There is a syntax error in the following cupperfile. The syntax error 
+        message is reproduced below for convenience.
+      cupperfile_load_error: |-
+        There was an error loading a Cupperfile. The file being loaded
+        and the error message are shown below. This is usually caused by
+        a syntax error.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cupper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Paulo Tada
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 8.15.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Taste your system and create a recipe
 email:
 - paulohtfs@gmail.com
@@ -108,6 +136,7 @@ files:
 - lib/cupper.rb
 - lib/cupper/cli.rb
 - lib/cupper/collect.rb
+- lib/cupper/config/config.rb
 - lib/cupper/cookbook.rb
 - lib/cupper/cookbook_file.rb
 - lib/cupper/cupperfile.rb
@@ -127,7 +156,7 @@ files:
 - lib/cupper/plugins/ohai/services.rb
 - lib/cupper/project.rb
 - lib/cupper/recipe.rb
-- lib/cupper/templates/CupperFile.erb
+- lib/cupper/templates/Cupperfile.erb
 - lib/cupper/templates/_cookbook_file.erb
 - lib/cupper/templates/_groups.erb
 - lib/cupper/templates/_links.erb
@@ -137,6 +166,7 @@ files:
 - lib/cupper/templates/_users.erb
 - lib/cupper/templates/cookbook_file.erb
 - lib/cupper/templates/recipe.erb
+- lib/cupper/templates/sensibles.erb
 - lib/cupper/version.rb
 - templates/locales/en.yml
 homepage: https://github.com/cupper-reverse-recipe/cupper

data/lib/cupper/templates/CupperFile.erb

@@ -1 +0,0 @@
-# Cupper config file