oxidized 0.30.1 → 0.31.0

data/lib/oxidized/output/gitcrypt.rb

@@ -1,227 +1,229 @@
 module Oxidized
-  class GitCrypt < Output
-    using Refinements
-    class GitCryptError < OxidizedError; end
-    begin
-      require 'git'
-    rescue LoadError
-      raise OxidizedError, 'git not found: sudo gem install git'
-    end
-
-    attr_reader :commitref
+  module Output
+    class GitCrypt < Output
+      using Refinements
+      class GitCryptError < OxidizedError; end
+      begin
+        require 'git'
+      rescue LoadError
+        raise OxidizedError, 'git not found: sudo gem install git'
+      end
 
-    def initialize
-      super
-      @cfg = Oxidized.config.output.gitcrypt
-      @gitcrypt_cmd = "/usr/bin/git-crypt"
-      @gitcrypt_init = @gitcrypt_cmd + " init"
-      @gitcrypt_unlock = @gitcrypt_cmd + " unlock"
-      @gitcrypt_lock = @gitcrypt_cmd + " lock"
-      @gitcrypt_adduser = @gitcrypt_cmd + " add-gpg-user --trusted "
-    end
+      attr_reader :commitref
 
-    def setup
-      if @cfg.empty?
-        Oxidized.asetus.user.output.gitcrypt.user  = 'Oxidized'
-        Oxidized.asetus.user.output.gitcrypt.email = 'o@example.com'
-        Oxidized.asetus.user.output.gitcrypt.repo = File.join(Config::ROOT, 'oxidized.git')
-        Oxidized.asetus.save :user
-        raise NoConfig, 'no output git config, edit ~/.config/oxidized/config'
+      def initialize
+        super
+        @cfg = Oxidized.config.output.gitcrypt
+        @gitcrypt_cmd = "/usr/bin/git-crypt"
+        @gitcrypt_init = @gitcrypt_cmd + " init"
+        @gitcrypt_unlock = @gitcrypt_cmd + " unlock"
+        @gitcrypt_lock = @gitcrypt_cmd + " lock"
+        @gitcrypt_adduser = @gitcrypt_cmd + " add-gpg-user --trusted "
       end
 
-      if @cfg.repo.respond_to?(:each)
-        @cfg.repo.each do |group, repo|
-          @cfg.repo["#{group}="] = File.expand_path repo
+      def setup
+        if @cfg.empty?
+          Oxidized.asetus.user.output.gitcrypt.user  = 'Oxidized'
+          Oxidized.asetus.user.output.gitcrypt.email = 'o@example.com'
+          Oxidized.asetus.user.output.gitcrypt.repo = File.join(Config::ROOT, 'oxidized.git')
+          Oxidized.asetus.save :user
+          raise NoConfig, "no output git config, edit #{Oxidized::Config.configfile}"
+        end
+
+        if @cfg.repo.respond_to?(:each)
+          @cfg.repo.each do |group, repo|
+            @cfg.repo["#{group}="] = File.expand_path repo
+          end
+        else
+          @cfg.repo = File.expand_path @cfg.repo
         end
-      else
-        @cfg.repo = File.expand_path @cfg.repo
       end
-    end
 
-    def crypt_init(repo)
-      repo.chdir do
-        system(@gitcrypt_init)
-        @cfg.users.each do |user|
-          system("#{@gitcrypt_adduser} #{user}")
+      def crypt_init(repo)
+        repo.chdir do
+          system(@gitcrypt_init)
+          @cfg.users.each do |user|
+            system("#{@gitcrypt_adduser} #{user}")
+          end
+          File.write(".gitattributes", "* filter=git-crypt diff=git-crypt\n.gitattributes !filter !diff")
+          repo.add(".gitattributes")
+          repo.commit("Initial commit: crypt all config files")
         end
-        File.write(".gitattributes", "* filter=git-crypt diff=git-crypt\n.gitattributes !filter !diff")
-        repo.add(".gitattributes")
-        repo.commit("Initial commit: crypt all config files")
       end
-    end
 
-    def lock(repo)
-      repo.chdir do
-        system(@gitcrypt_lock)
+      def lock(repo)
+        repo.chdir do
+          system(@gitcrypt_lock)
+        end
       end
-    end
 
-    def unlock(repo)
-      repo.chdir do
-        system(@gitcrypt_unlock)
+      def unlock(repo)
+        repo.chdir do
+          system(@gitcrypt_unlock)
+        end
       end
-    end
 
-    def store(file, outputs, opt = {})
-      @msg   = opt[:msg]
-      @user  = opt[:user]  || @cfg.user
-      @email = opt[:email] || @cfg.email
-      @opt   = opt
-      @commitref = nil
-      repo = @cfg.repo
-
-      outputs.types.each do |type|
-        type_cfg = ''
-        type_repo = File.join(File.dirname(repo), type + '.git')
-        outputs.type(type).each do |output|
-          (type_cfg << output; next) unless output.name # rubocop:disable Style/Semicolon
-          type_file = file + '--' + output.name
-          if @cfg.type_as_directory?
-            type_file = type + '/' + type_file
-            type_repo = repo
+      def store(file, outputs, opt = {})
+        @msg   = opt[:msg]
+        @user  = opt[:user]  || @cfg.user
+        @email = opt[:email] || @cfg.email
+        @opt   = opt
+        @commitref = nil
+        repo = @cfg.repo
+
+        outputs.types.each do |type|
+          type_cfg = ''
+          type_repo = File.join(File.dirname(repo), type + '.git')
+          outputs.type(type).each do |output|
+            (type_cfg << output; next) unless output.name # rubocop:disable Style/Semicolon
+            type_file = file + '--' + output.name
+            if @cfg.type_as_directory?
+              type_file = type + '/' + type_file
+              type_repo = repo
+            end
+            update type_repo, type_file, output
           end
-          update type_repo, type_file, output
+          update type_repo, file, type_cfg
         end
-        update type_repo, file, type_cfg
-      end
 
-      update repo, file, outputs.to_cfg
-    end
+        update repo, file, outputs.to_cfg
+      end
 
-    def fetch(node, group)
-      repo, path = yield_repo_and_path(node, group)
-      repo = Git.open repo
-      unlock repo
-      index = repo.index
-      # Empty repo ?
-      raise 'Empty git repo' if File.exist?(index.path)
-
-      File.read path
-      lock repo
-    rescue StandardError
-      'node not found'
-    end
+      def fetch(node, group)
+        repo, path = yield_repo_and_path(node, group)
+        repo = Git.open repo
+        unlock repo
+        index = repo.index
+        # Empty repo ?
+        raise 'Empty git repo' if File.exist?(index.path)
+
+        File.read path
+        lock repo
+      rescue StandardError
+        'node not found'
+      end
 
-    # give a hash of all oid revision for the given node, and the date of the commit
-    def version(node, group)
-      repo, path = yield_repo_and_path(node, group)
-
-      repo = Git.open repo
-      unlock repo
-      walker = repo.log.path(path)
-      i = -1
-      tab = []
-      walker.each do |commit|
-        hash = {}
-        hash[:date] = commit.date.to_s
-        hash[:oid] = commit.objectish
-        hash[:author] = commit.author
-        hash[:message] = commit.message
-        tab[i += 1] = hash
+      # give a hash of all oid revision for the given node, and the date of the commit
+      def version(node, group)
+        repo, path = yield_repo_and_path(node, group)
+
+        repo = Git.open repo
+        unlock repo
+        walker = repo.log.path(path)
+        i = -1
+        tab = []
+        walker.each do |commit|
+          hash = {}
+          hash[:date] = commit.date.to_s
+          hash[:oid] = commit.objectish
+          hash[:author] = commit.author
+          hash[:message] = commit.message
+          tab[i += 1] = hash
+        end
+        walker.reset
+        tab
+      rescue StandardError
+        'node not found'
       end
-      walker.reset
-      tab
-    rescue StandardError
-      'node not found'
-    end
 
-    # give the blob of a specific revision
-    def get_version(node, group, oid)
-      repo, path = yield_repo_and_path(node, group)
-      repo = Git.open repo
-      unlock repo
-      repo.gtree(oid).files[path].contents
-    rescue StandardError
-      'version not found'
-    ensure
-      lock repo
-    end
+      # give the blob of a specific revision
+      def get_version(node, group, oid)
+        repo, path = yield_repo_and_path(node, group)
+        repo = Git.open repo
+        unlock repo
+        repo.gtree(oid).files[path].contents
+      rescue StandardError
+        'version not found'
+      ensure
+        lock repo
+      end
 
-    # give a hash with the patch of a diff between 2 revision and the stats (added and deleted lines)
-    def get_diff(node, group, oid1, oid2)
-      diff_commits = nil
-      repo, _path = yield_repo_and_path(node, group)
-      repo = Git.open repo
-      unlock repo
-      commit = repo.gcommit(oid1)
-
-      if oid2
-        commit_old = repo.gcommit(oid2)
-        diff = repo.diff(commit_old, commit)
-        stats = [diff.stats[:files][node.name][:insertions], diff.stats[:files][node.name][:deletions]]
-        diff.each do |patch|
-          if /#{node.name}\s+/ =~ patch.patch.to_s.lines.first
-            diff_commits = { patch: patch.patch.to_s, stat: stats }
-            break
+      # give a hash with the patch of a diff between 2 revision and the stats (added and deleted lines)
+      def get_diff(node, group, oid1, oid2)
+        diff_commits = nil
+        repo, _path = yield_repo_and_path(node, group)
+        repo = Git.open repo
+        unlock repo
+        commit = repo.gcommit(oid1)
+
+        if oid2
+          commit_old = repo.gcommit(oid2)
+          diff = repo.diff(commit_old, commit)
+          stats = [diff.stats[:files][node.name][:insertions], diff.stats[:files][node.name][:deletions]]
+          diff.each do |patch|
+            if /#{node.name}\s+/ =~ patch.patch.to_s.lines.first
+              diff_commits = { patch: patch.patch.to_s, stat: stats }
+              break
+            end
           end
+        else
+          stat = commit.parents[0].diff(commit).stats
+          stat = [stat[:files][node.name][:insertions], stat[:files][node.name][:deletions]]
+          patch = commit.parents[0].diff(commit).patch
+          diff_commits = { patch: patch, stat: stat }
         end
-      else
-        stat = commit.parents[0].diff(commit).stats
-        stat = [stat[:files][node.name][:insertions], stat[:files][node.name][:deletions]]
-        patch = commit.parents[0].diff(commit).patch
-        diff_commits = { patch: patch, stat: stat }
+        lock repo
+        diff_commits
+      rescue StandardError
+        'no diffs'
+      ensure
+        lock repo
       end
-      lock repo
-      diff_commits
-    rescue StandardError
-      'no diffs'
-    ensure
-      lock repo
-    end
-
-    private
 
-    def yield_repo_and_path(node, group)
-      repo, path = node.repo, node.name
+      private
 
-      path = "#{group}/#{node.name}" if group && @cfg.single_repo?
+      def yield_repo_and_path(node, group)
+        repo, path = node.repo, node.name
 
-      [repo, path]
-    end
+        path = "#{group}/#{node.name}" if group && @cfg.single_repo?
 
-    def update(repo, file, data)
-      return if data.empty?
+        [repo, path]
+      end
 
-      if @opt[:group]
-        if @cfg.single_repo?
-          file = File.join @opt[:group], file
-        else
-          repo = if repo.is_a?(::String)
-                   File.join File.dirname(repo), @opt[:group] + '.git'
-                 else
-                   repo[@opt[:group]]
-                 end
+      def update(repo, file, data)
+        return if data.empty?
+
+        if @opt[:group]
+          if @cfg.single_repo?
+            file = File.join @opt[:group], file
+          else
+            repo = if repo.is_a?(::String)
+                     File.join File.dirname(repo), @opt[:group] + '.git'
+                   else
+                     repo[@opt[:group]]
+                   end
+          end
         end
-      end
 
-      begin
-        update_repo repo, file, data, @msg, @user, @email
-      rescue Git::GitExecuteError, ArgumentError => e
-        Oxidized.logger.debug "open_error #{e} #{file}"
         begin
-          grepo = Git.init repo
-          crypt_init grepo
-        rescue StandardError => create_error
-          raise GitCryptError, "first '#{e.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
+          update_repo repo, file, data, @msg, @user, @email
+        rescue Git::GitExecuteError, ArgumentError => e
+          Oxidized.logger.debug "open_error #{e} #{file}"
+          begin
+            grepo = Git.init repo
+            crypt_init grepo
+          rescue StandardError => create_error
+            raise GitCryptError, "first '#{e.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
+          end
+          retry
         end
-        retry
       end
-    end
 
-    def update_repo(repo, file, data, msg, user, email)
-      grepo = Git.open repo
-      grepo.config('user.name', user)
-      grepo.config('user.email', email)
-      grepo.chdir do
-        unlock grepo
-        File.write(file, data)
-        grepo.add(file)
-        if grepo.status[file].nil? || !grepo.status[file].type.nil?
-          grepo.commit(msg)
-          @commitref = grepo.log(1).first.objectish
-          true
+      def update_repo(repo, file, data, msg, user, email)
+        grepo = Git.open repo
+        grepo.config('user.name', user)
+        grepo.config('user.email', email)
+        grepo.chdir do
+          unlock grepo
+          File.write(file, data)
+          grepo.add(file)
+          if grepo.status[file].nil? || !grepo.status[file].type.nil?
+            grepo.commit(msg)
+            @commitref = grepo.log(1).first.objectish
+            true
+          end
+          lock grepo
         end
-        lock grepo
       end
     end
   end

data/lib/oxidized/output/http.rb

@@ -1,61 +1,63 @@
 module Oxidized
-  class Http < Output
-    attr_reader :commitref
+  module Output
+    class Http < Output
+      attr_reader :commitref
 
-    def initialize
-      super
-      @cfg = Oxidized.config.output.http
-    end
+      def initialize
+        super
+        @cfg = Oxidized.config.output.http
+      end
 
-    def setup
-      return unless @cfg.empty?
+      def setup
+        return unless @cfg.empty?
 
-      CFGS.user.output.http.user = 'Oxidized'
-      CFGS.user.output.http.pasword = 'secret'
-      CFGS.user.output.http.url = 'http://localhost/web-api/oxidized'
-      CFGS.save :user
-      raise NoConfig, 'no output http config, edit ~/.config/oxidized/config'
-    end
+        Oxidized.asetus.user.output.http.user = 'Oxidized'
+        Oxidized.asetus.user.output.http.pasword = 'secret'
+        Oxidized.asetus.user.output.http.url = 'http://localhost/web-api/oxidized'
+        Oxidized.asetus.save :user
+        raise NoConfig, "no output http config, edit #{Oxidized::Config.configfile}"
+      end
 
-    require "net/http"
-    require "uri"
-    require "json"
-
-    def store(node, outputs, opt = {})
-      @commitref = nil
-      uri = URI.parse @cfg.url
-      http = Net::HTTP.new uri.host, uri.port
-      # http.use_ssl = true if uri.scheme = 'https'
-      req = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
-      req.basic_auth @cfg.user, @cfg.password
-      req.body = generate_json(node, outputs, opt)
-      response = http.request req
-
-      case response.code.to_i
-      when 200 || 201
-        Oxidized.logger.info "Configuration http backup complete for #{node}"
-        p [:success]
-      when (400..499)
-        Oxidized.logger.info "Configuration http backup for #{node} failed status: #{response.body}"
-        p [:bad_request]
-      when (500..599)
-        p [:server_problems]
-        Oxidized.logger.info "Configuration http backup for #{node} failed status: #{response.body}"
+      require "net/http"
+      require "uri"
+      require "json"
+
+      def store(node, outputs, opt = {})
+        @commitref = nil
+        uri = URI.parse @cfg.url
+        http = Net::HTTP.new uri.host, uri.port
+        # http.use_ssl = true if uri.scheme = 'https'
+        req = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
+        req.basic_auth @cfg.user, @cfg.password
+        req.body = generate_json(node, outputs, opt)
+        response = http.request req
+
+        case response.code.to_i
+        when 200 || 201
+          Oxidized.logger.info "Configuration http backup complete for #{node}"
+          p [:success]
+        when (400..499)
+          Oxidized.logger.info "Configuration http backup for #{node} failed status: #{response.body}"
+          p [:bad_request]
+        when (500..599)
+          p [:server_problems]
+          Oxidized.logger.info "Configuration http backup for #{node} failed status: #{response.body}"
+        end
       end
-    end
 
-    private
-
-    def generate_json(node, outputs, opt)
-      JSON.pretty_generate(
-        'msg'    => opt[:msg],
-        'user'   => opt[:user],
-        'email'  => opt[:email],
-        'group'  => opt[:group],
-        'node'   => node,
-        'config' => outputs.to_cfg
-        # actually we need to also iterate outputs, for other types like in gitlab. But most people don't use 'type' functionality.
-      )
+      private
+
+      def generate_json(node, outputs, opt)
+        JSON.pretty_generate(
+          'msg'    => opt[:msg],
+          'user'   => opt[:user],
+          'email'  => opt[:email],
+          'group'  => opt[:group],
+          'node'   => node,
+          'config' => outputs.to_cfg
+          # actually we need to also iterate outputs, for other types like in gitlab. But most people don't use 'type' functionality.
+        )
+      end
     end
   end
 end

data/lib/oxidized/output/output.rb

@@ -1,9 +1,11 @@
 module Oxidized
-  class Output
-    class NoConfig < OxidizedError; end
+  module Output
+    class Output
+      class NoConfig < OxidizedError; end
 
-    def cfg_to_str(cfg)
-      cfg.select { |h| h[:type] == 'cfg' }.map { |h| h[:data] }.join
+      def cfg_to_str(cfg)
+        cfg.select { |h| h[:type] == 'cfg' }.map { |h| h[:data] }.join
+      end
     end
   end
 end

data/lib/oxidized/source/csv.rb

@@ -1,60 +1,55 @@
 module Oxidized
-  class CSV < Source
-    def initialize
-      @cfg = Oxidized.config.source.csv
-      super
-    end
-
-    def setup
-      if @cfg.empty?
-        Oxidized.asetus.user.source.csv.file      = File.join(Config::ROOT, 'router.db')
-        Oxidized.asetus.user.source.csv.delimiter = /:/
-        Oxidized.asetus.user.source.csv.map.name  = 0
-        Oxidized.asetus.user.source.csv.map.model = 1
-        Oxidized.asetus.user.source.csv.gpg       = false
-        Oxidized.asetus.save :user
-        raise NoConfig, 'no source csv config, edit ~/.config/oxidized/config'
+  module Source
+    class CSV < Source
+      def initialize
+        @cfg = Oxidized.config.source.csv
+        super
       end
-      require 'gpgme' if @cfg.gpg?
-    end
-
-    def load(_node_want = nil)
-      nodes = []
-      open_file.each_line do |line|
-        next if line =~ /^\s*#/
-
-        data = line.chomp.split(@cfg.delimiter, -1)
-        next if data.empty?
 
-        # map node parameters
-        keys = {}
-        @cfg.map.each do |key, position|
-          keys[key.to_sym] = node_var_interpolate data[position]
+      def setup
+        if @cfg.empty?
+          Oxidized.asetus.user.source.csv.file      = File.join(Config::ROOT, 'router.db')
+          Oxidized.asetus.user.source.csv.delimiter = /:/
+          Oxidized.asetus.user.source.csv.map.name  = 0
+          Oxidized.asetus.user.source.csv.map.model = 1
+          Oxidized.asetus.user.source.csv.gpg       = false
+          Oxidized.asetus.save :user
+          raise NoConfig, "no source csv config, edit #{Oxidized::Config.configfile}"
         end
-        keys[:model] = map_model keys[:model] if keys.has_key? :model
-        keys[:group] = map_group keys[:group] if keys.has_key? :group
+        require 'gpgme' if @cfg.gpg?
 
-        # map node specific vars
-        vars = {}
-        @cfg.vars_map.each do |key, position|
-          vars[key.to_sym] = node_var_interpolate data[position]
-        end
-        keys[:vars] = vars unless vars.empty?
+        # map.name is mandatory
+        return if @cfg.map.has_key?('name')
 
-        nodes << keys
+        raise InvalidConfig, "map/name is a mandatory source attribute, edit #{Oxidized::Config.configfile}"
       end
-      nodes
-    end
 
-    private
-
-    def open_file
-      file = File.expand_path(@cfg.file)
-      if @cfg.gpg?
-        crypto = GPGME::Crypto.new password: @cfg.gpg_password
-        crypto.decrypt(File.open(file)).to_s
-      else
-        File.open(file)
+      def load(_node_want = nil)
+        nodes = []
+        open_file.each_line do |line|
+          next if line =~ /^\s*#/
+
+          data = line.chomp.split(@cfg.delimiter, -1)
+          next if data.empty?
+
+          # map node parameters
+          keys = {}
+          @cfg.map.each do |key, position|
+            keys[key.to_sym] = node_var_interpolate data[position]
+          end
+          keys[:model] = map_model keys[:model] if keys.has_key? :model
+          keys[:group] = map_group keys[:group] if keys.has_key? :group
+
+          # map node specific vars
+          vars = {}
+          @cfg.vars_map.each do |key, position|
+            vars[key.to_sym] = node_var_interpolate data[position]
+          end
+          keys[:vars] = vars unless vars.empty?
+
+          nodes << keys
+        end
+        nodes
       end
     end
   end