From f2da63369fcb754e3715091cc4fd2f93db42106e Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Tue, 27 Oct 2015 14:49:52 -0400 Subject: better test framework, more specs and Travis CI --- spec/node_spec.rb | 44 ++++++++++++++++++++++++++++++++++++++++++++ spec/nodes_spec.rb | 35 +++++++++++++++++++++++------------ spec/spec_helper.rb | 14 ++++++++++++++ 3 files changed, 81 insertions(+), 12 deletions(-) create mode 100644 spec/node_spec.rb create mode 100644 spec/spec_helper.rb (limited to 'spec') diff --git a/spec/node_spec.rb b/spec/node_spec.rb new file mode 100644 index 0000000..c568463 --- /dev/null +++ b/spec/node_spec.rb @@ -0,0 +1,44 @@ +require 'spec_helper' + +describe Oxidized::Node do + before(:each) do + Oxidized.stubs(:asetus).returns(Asetus.new) + + Oxidized::Node.any_instance.stubs(:resolve_output) + @node = Oxidized::Node.new(name: 'example.com', + input: 'ssh', + output: 'git', + model: 'junos', + username: 'alma', + password: 'armud', + prompt: 'test_prompt') + + end + + describe '#new' do + it 'should resolve input' do + @node.input[0].to_s.split('::')[1].must_equal 'SSH' + end + it 'should resolve model' do + @node.model.class.must_equal JunOS + end + it 'should resolve username' do + @node.auth[:username].must_equal 'alma' + end + it 'should resolve password' do + @node.auth[:password].must_equal 'armud' + end + it 'should require prompt' do + @node.prompt.must_equal 'test_prompt' + end + end + + describe '#run' do + it 'should fetch the configuration' do + stub_oxidized_ssh + + status, _ = @node.run + status.must_equal :success + end + end +end diff --git a/spec/nodes_spec.rb b/spec/nodes_spec.rb index 80ed300..5f2ef95 100644 --- a/spec/nodes_spec.rb +++ b/spec/nodes_spec.rb @@ -1,33 +1,44 @@ -require 'oxidized' -Oxidized.mgr = Oxidized::Manager.new +require 'spec_helper' describe Oxidized::Nodes do before(:each) do + Resolv.any_instance.stubs(:getaddress) + Oxidized.stubs(:asetus).returns(Asetus.new) + opts = { + input: 'ssh', + output: 'git', + model: 'junos', + username: 'alma', + password: 'armud', + prompt: 'test_prompt' + } + + Oxidized::Node.any_instance.stubs(:resolve_output) @nodes_org = %w(ltt-pe1.hel kes2-rr1.tku tor-peer1.oul - hal-p2.tre sav-gr1-sw1.kuo psl-sec-pe1.hel).map { |e| Oxidized::Node.new(:name=>e) } - @nodes = Oxidized::Nodes.new @nodes_org.dup + hal-p2.tre sav-gr1-sw1.kuo psl-sec-pe1.hel).map { |e| Oxidized::Node.new(opts.merge(name: e)) } + @node = @nodes_org.delete_at(0) + @nodes = Oxidized::Nodes.new(nodes: @nodes_org.dup) end describe '#put' do it 'adds node to top of queue' do - node = Oxidized::Node.new(:name=>'kst-p1.sto') - @nodes.put node - expect(@nodes).to eq [node] + @nodes_org + @nodes.put @node + @nodes.must_equal [@node] + @nodes_org end end describe '#get' do it 'returns node from top of queue' do - expect(@nodes.get).to eq @nodes_org.first + @nodes.get.must_equal @nodes_org.first end it 'moves node from top to bottom' do @nodes.get - expect(@nodes).to end_with [@nodes_org.first] + @nodes.last.must_equal @nodes_org.first end it 'does not change node count' do before = @nodes.size @nodes.get - expect(before).to eq @nodes.size + before.must_equal @nodes.size end end @@ -35,12 +46,12 @@ describe Oxidized::Nodes do it 'moves node to top of queue' do node = @nodes[3] @nodes.next node.name - expect(@nodes).to start_with [node] + @nodes.first.must_equal node end it 'does not change node count' do before = @nodes.size @nodes.next @nodes[3].name - expect(before).to eq @nodes.size + before.must_equal @nodes.size end end end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..28eb9d4 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require 'minitest/autorun' +require 'mocha/mini_test' +require 'oxidized' + +Oxidized.mgr = Oxidized::Manager.new + +def stub_oxidized_ssh + Oxidized::SSH.any_instance.stubs(:connect).returns(true) + Oxidized::SSH.any_instance.stubs(:node).returns(@node) + Oxidized::SSH.any_instance.expects(:cmd).at_least(1).returns("this is a command output\nModel: mx960") + Oxidized::SSH.any_instance.stubs(:connect_cli).returns(true) + Oxidized::SSH.any_instance.stubs(:disconnect).returns(true) + Oxidized::SSH.any_instance.stubs(:disconnect_cli).returns(true) +end -- cgit v1.2.3 From 817f33a2a1e8f78720f5e73a10ee45384e886ae9 Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Fri, 13 Nov 2015 16:31:02 -0500 Subject: githubrepo hook spec --- lib/oxidized/hook/githubrepo.rb | 2 +- spec/githubrepo_spec.rb | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 spec/githubrepo_spec.rb (limited to 'spec') diff --git a/lib/oxidized/hook/githubrepo.rb b/lib/oxidized/hook/githubrepo.rb index a17d6b9..85adaab 100644 --- a/lib/oxidized/hook/githubrepo.rb +++ b/lib/oxidized/hook/githubrepo.rb @@ -5,7 +5,7 @@ class GithubRepo < Oxidized::Hook def run_hook(ctx) credentials = Rugged::Credentials::SshKeyFromAgent.new(username: 'git') - repo = Rugged::Repository.new(Oxidized::CFG.output.git.repo) + repo = Rugged::Repository.new(Oxidized.config.output.git.repo) log "Pushing local repository(#{repo.path})..." remote = repo.remotes['origin'] || repo.remotes.create('origin', cfg.remote_repo) log "to remote: #{remote.url}" diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb new file mode 100644 index 0000000..c98244d --- /dev/null +++ b/spec/githubrepo_spec.rb @@ -0,0 +1,25 @@ +require 'spec_helper' +require 'rugged' +require 'oxidized/hook/githubrepo' + +describe Oxidized::Node do + before(:each) do + asetus = Asetus.new + asetus.cfg.output.git.repo = 'foo.git' + Oxidized.stubs(:asetus).returns(asetus) + repo = mock() + remote = mock() + remote.expects(:url).returns('github.com/foo.git') + remote.expects(:push).returns(true) + repo.expects(:remotes).returns({'origin' => remote}) + repo.expects(:path).returns('foo.git') + Rugged::Repository.expects(:new).with('foo.git').returns(repo) + end + + describe "#run_hook" do + it "will push to the remote repository" do + gr = GithubRepo.new + gr.run_hook(nil).must_equal true + end + end +end -- cgit v1.2.3 From 71f38cc19411c482c3cd932976a5183e089226eb Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Fri, 4 Dec 2015 00:27:55 -0500 Subject: fix the spec --- spec/githubrepo_spec.rb | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'spec') diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index c98244d..a193cd6 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -6,6 +6,10 @@ describe Oxidized::Node do before(:each) do asetus = Asetus.new asetus.cfg.output.git.repo = 'foo.git' + asetus.cfg.hooks.github_repo_hook.remote_repo = 'https://github.com/blah/blah.git' + asetus.cfg.hooks.github_repo_hook.username = 'username' + asetus.cfg.hooks.github_repo_hook.password = 'password' + GithubRepo.any_instance.stubs(:cfg).returns(asetus.cfg.hooks.github_repo_hook) Oxidized.stubs(:asetus).returns(asetus) repo = mock() remote = mock() -- cgit v1.2.3 From 68dd88766604145a8c8d16b22a68a9850ce92564 Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Mon, 7 Dec 2015 15:27:42 -0500 Subject: fix test --- spec/githubrepo_spec.rb | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'spec') diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index a193cd6..9b509e4 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -17,6 +17,10 @@ describe Oxidized::Node do remote.expects(:push).returns(true) repo.expects(:remotes).returns({'origin' => remote}) repo.expects(:path).returns('foo.git') + repo_head = mock() + repo_head.expects(:name).returns('origin/master') + repo.expects(:head).returns(repo_head) + repo.expects(:branches).returns({}) Rugged::Repository.expects(:new).with('foo.git').returns(repo) end -- cgit v1.2.3 From b6a9c3ae528de0b577ff3f7c601b4ca5b641185d Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Tue, 8 Dec 2015 18:43:18 -0500 Subject: fix spec --- spec/githubrepo_spec.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'spec') diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index 9b509e4..07296f3 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -18,8 +18,9 @@ describe Oxidized::Node do repo.expects(:remotes).returns({'origin' => remote}) repo.expects(:path).returns('foo.git') repo_head = mock() - repo_head.expects(:name).returns('origin/master') - repo.expects(:head).returns(repo_head) + repo_head.expects(:name).twice.returns('origin/master') + repo.expects(:head).twice.returns(repo_head) + repo.expects(:fetch).returns(true) repo.expects(:branches).returns({}) Rugged::Repository.expects(:new).with('foo.git').returns(repo) end -- cgit v1.2.3 From fa3b93c5046f23ebbb2e82ac4944357683f8c5d8 Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Wed, 9 Dec 2015 22:53:16 -0500 Subject: let user configure which auth method to use --- lib/oxidized/hook/githubrepo.rb | 18 ++++++++++++--- spec/githubrepo_spec.rb | 50 ++++++++++++++++++++++++++++------------- 2 files changed, 50 insertions(+), 18 deletions(-) (limited to 'spec') diff --git a/lib/oxidized/hook/githubrepo.rb b/lib/oxidized/hook/githubrepo.rb index 25b2cd0..22ee8ea 100644 --- a/lib/oxidized/hook/githubrepo.rb +++ b/lib/oxidized/hook/githubrepo.rb @@ -4,18 +4,17 @@ class GithubRepo < Oxidized::Hook end def run_hook(ctx) - credentials = Rugged::Credentials::UserPassword.new(username: cfg.username, password: cfg.password) repo = Rugged::Repository.new(Oxidized.config.output.git.repo) log "Pushing local repository(#{repo.path})..." remote = repo.remotes['origin'] || repo.remotes.create('origin', cfg.remote_repo) log "to remote: #{remote.url}" - fetch_and_merge_remote(repo, credentials) + fetch_and_merge_remote(repo) remote.push([repo.head.name], credentials: credentials) end - def fetch_and_merge_remote(repo, credentials) + def fetch_and_merge_remote(repo) repo.fetch('origin', [repo.head.name], credentials: credentials) their_branch = repo.branches["origin/master"] or return @@ -31,4 +30,17 @@ class GithubRepo < Oxidized::Hook update_ref: "HEAD" }) end + + private + + def credentials + @credentials ||= if cfg.has_key?('username') && cfg.has_key?('password') + log "Using https auth", :debug + Rugged::Credentials::UserPassword.new(username: cfg.username, password: cfg.password) + else + log "Using ssh auth", :debug + Rugged::Credentials::SshKeyFromAgent.new(username: 'git') + end + end + end diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index 07296f3..a3b4953 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -4,30 +4,50 @@ require 'oxidized/hook/githubrepo' describe Oxidized::Node do before(:each) do - asetus = Asetus.new - asetus.cfg.output.git.repo = 'foo.git' - asetus.cfg.hooks.github_repo_hook.remote_repo = 'https://github.com/blah/blah.git' - asetus.cfg.hooks.github_repo_hook.username = 'username' - asetus.cfg.hooks.github_repo_hook.password = 'password' - GithubRepo.any_instance.stubs(:cfg).returns(asetus.cfg.hooks.github_repo_hook) - Oxidized.stubs(:asetus).returns(asetus) - repo = mock() + Oxidized.asetus = Asetus.new + Oxidized.config.output.git.repo = 'foo.git' + + @credentials = mock() + remote = mock() - remote.expects(:url).returns('github.com/foo.git') - remote.expects(:push).returns(true) - repo.expects(:remotes).returns({'origin' => remote}) - repo.expects(:path).returns('foo.git') + remote.expects(:url).returns('https://github.com/username/foo.git') + remote.expects(:push).with(['refs/heads/master'], credentials: @credentials).returns(true) + repo_head = mock() - repo_head.expects(:name).twice.returns('origin/master') + repo_head.expects(:name).twice.returns('refs/heads/master') + + repo = mock() + repo.expects(:path).returns('foo.git') + repo.expects(:remotes).returns({'origin' => remote}) repo.expects(:head).twice.returns(repo_head) - repo.expects(:fetch).returns(true) + repo.expects(:fetch).with('origin', ['refs/heads/master'], credentials: @credentials).returns(true) repo.expects(:branches).returns({}) + Rugged::Repository.expects(:new).with('foo.git').returns(repo) end describe "#run_hook" do - it "will push to the remote repository" do + it "will push to the remote repository using https" do + Oxidized.config.hooks.github_repo_hook.remote_repo = 'https://github.com/username/foo.git' + Oxidized.config.hooks.github_repo_hook.username = 'username' + Oxidized.config.hooks.github_repo_hook.password = 'password' + + Rugged::Credentials::UserPassword.expects(:new).with(username: 'username', password: 'password').returns(@credentials) + + gr = GithubRepo.new + gr.cfg = Oxidized.config.hooks.github_repo_hook + + gr.run_hook(nil).must_equal true + end + + it "will push to the remote repository using ssh" do + Oxidized.config.hooks.github_repo_hook.remote_repo = 'git@github.com:username/foo.git' + + Rugged::Credentials::SshKeyFromAgent.expects(:new).with(username: 'git').returns(@credentials) + gr = GithubRepo.new + gr.cfg = Oxidized.config.hooks.github_repo_hook + gr.run_hook(nil).must_equal true end end -- cgit v1.2.3 From 1c4f886e883f947b649613a21955929fa6d7e94c Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Wed, 9 Dec 2015 23:43:32 -0500 Subject: refactor and fix bugs introduced with new changes --- README.md | 2 +- bin/oxidized | 2 +- lib/oxidized.rb | 34 +++++++++++++++++++++++++++++++++- lib/oxidized/cli.rb | 12 +++++++----- lib/oxidized/config.rb | 9 +++++---- lib/oxidized/core.rb | 12 ++---------- lib/oxidized/hook.rb | 6 +++--- lib/oxidized/input/ftp.rb | 2 +- lib/oxidized/input/ssh.rb | 2 +- lib/oxidized/input/telnet.rb | 2 +- lib/oxidized/log.rb | 15 --------------- lib/oxidized/node.rb | 4 ++-- lib/oxidized/nodes.rb | 22 +++++++++++----------- lib/oxidized/worker.rb | 8 ++++---- spec/githubrepo_spec.rb | 1 + 15 files changed, 73 insertions(+), 60 deletions(-) delete mode 100644 lib/oxidized/log.rb (limited to 'spec') diff --git a/README.md b/README.md index aea4326..3b7083f 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ Oxidized supports ```CSV```, ```SQLite``` and ```HTTP``` as source backends. The Possible outputs are either ```file``` or ```git```. The file backend takes a destination directory as argument and will keep a file per device, with most recent running version of a device. The GIT backend (recommended) will initialize an empty GIT repository in the specified path and create a new commit on every configuration change. Take a look at the [Cookbook](#cookbook) for more details. -Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if Syslog::Logger exists (>=2.0) and syslog is used instead. +Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog`(requires Ruby >= 2.0) is set to `true`. First create the directory where the CSV ```output``` is going to store device configs and start Oxidized once. ``` diff --git a/bin/oxidized b/bin/oxidized index e5d9bec..2695a52 100755 --- a/bin/oxidized +++ b/bin/oxidized @@ -9,5 +9,5 @@ begin Oxidized::CLI.new.run rescue => error warn "#{error}" - raise if Oxidized::CFG.debug + raise if Oxidized.config.debug end diff --git a/lib/oxidized.rb b/lib/oxidized.rb index df30602..e92224a 100644 --- a/lib/oxidized.rb +++ b/lib/oxidized.rb @@ -1,6 +1,15 @@ module Oxidized class OxidizedError < StandardError; end - Directory = File.expand_path File.join File.dirname(__FILE__), '../' + + Directory = File.expand_path(File.join(File.dirname(__FILE__), '../')) + + require 'oxidized/string' + require 'oxidized/config' + require 'oxidized/config/vars' + require 'oxidized/worker' + require 'oxidized/nodes' + require 'oxidized/manager' + require 'oxidized/hook' require 'oxidized/core' def self.asetus @@ -14,4 +23,27 @@ module Oxidized def self.config asetus.cfg end + + def self.logger + @@logger + end + + def self.logger=(val) + @@logger = val + end + + def self.setup_logger + self.logger = if config.has_key?('use_syslog') && config.use_syslog + require 'syslog/logger' + Syslog::Logger.new('oxidized') + else + require 'logger' + if config.has_key?('log') + Logger.new(config.log) + else + Logger.new(STDERR) + end + end + logger.level = Logger::INFO unless config.debug + end end diff --git a/lib/oxidized/cli.rb b/lib/oxidized/cli.rb index fd766e3..15d20c5 100644 --- a/lib/oxidized/cli.rb +++ b/lib/oxidized/cli.rb @@ -1,13 +1,14 @@ module Oxidized class CLI - require 'oxidized' require 'slop' + require 'oxidized' def run check_pid Process.daemon if @opts[:daemonize] write_pid begin + Oxidized.logger.info "Oxidized starting, running as pid #{$$}" Oxidized.new rescue => error crash error @@ -18,15 +19,16 @@ module Oxidized private def initialize - Log.info "Oxidized starting, running as pid #{$$} by #{ENV['USER']}" _args, @opts = parse_opts - Oxidized.config.debug = true if @opts[:debug] + + Config.load(@opts) + Oxidized.setup_logger + @pidfile = File.expand_path("pid") - Log.debug "pidfile: #{@pidfile}" end def crash error - Log.fatal "Oxidized crashed, crashfile written in #{Config::Crash}" + Oxidized.logger.fatal "Oxidized crashed, crashfile written in #{Config::Crash}" open Config::Crash, 'w' do |file| file.puts '-' * 50 file.puts Time.now.utc diff --git a/lib/oxidized/config.rb b/lib/oxidized/config.rb index 36c1a8f..c850059 100644 --- a/lib/oxidized/config.rb +++ b/lib/oxidized/config.rb @@ -12,7 +12,7 @@ module Oxidized HookDir = File.join Directory, %w(lib oxidized hook) Sleep = 1 - def self.load + def self.load(cmd_opts={}) asetus = Asetus.new(name: 'oxidized', load: false, key_to_s: true) Oxidized.asetus = asetus @@ -20,7 +20,7 @@ module Oxidized asetus.default.password = 'password' asetus.default.model = 'junos' asetus.default.interval = 3600 - asetus.default.log = File.join Config::Root, 'log' + asetus.default.use_syslog = false asetus.default.debug = false asetus.default.threads = 30 asetus.default.timeout = 20 @@ -48,9 +48,10 @@ module Oxidized raise InvalidConfig, "Error loading config: #{error.message}" end - Log.level = Logger::INFO unless asetus.cfg.debug raise NoConfig, 'edit ~/.config/oxidized/config' if asetus.create - Log.file = asetus.cfg.log if asetus.cfg.log + + # override if comand line flag given + asetus.cfg.debug = cmd_opts[:debug] if cmd_opts[:debug] asetus end diff --git a/lib/oxidized/core.rb b/lib/oxidized/core.rb index 1b918d1..d57c5cb 100644 --- a/lib/oxidized/core.rb +++ b/lib/oxidized/core.rb @@ -1,12 +1,4 @@ module Oxidized - require 'oxidized/log' - require 'oxidized/string' - require 'oxidized/config' - require 'oxidized/config/vars' - require 'oxidized/worker' - require 'oxidized/nodes' - require 'oxidized/manager' - require 'oxidized/hook' class << self def new *args Core.new args @@ -17,7 +9,6 @@ module Oxidized class NoNodesFound < OxidizedError; end def initialize args - Config.load Oxidized.mgr = Manager.new Oxidized.Hooks = HookManager.from_config(Oxidized.config) nodes = Nodes.new @@ -28,7 +19,8 @@ module Oxidized begin require 'oxidized/web' rescue LoadError - raise OxidizedError, 'oxidized-web not found: sudo gem install oxidized-web - or disable web support by setting "rest: false" in your configuration' + raise OxidizedError, 'oxidized-web not found: sudo gem install oxidized-web - \ + or disable web support by setting "rest: false" in your configuration' end @rest = API::Web.new nodes, Oxidized.config.rest @rest.run diff --git a/lib/oxidized/hook.rb b/lib/oxidized/hook.rb index d774653..029688d 100644 --- a/lib/oxidized/hook.rb +++ b/lib/oxidized/hook.rb @@ -46,7 +46,7 @@ class HookManager hook.cfg = cfg @registered_hooks[event] << RegisteredHook.new(name, hook) - Log.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}" + Oxidized.logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}" end def handle event, ctx_params={} @@ -57,7 +57,7 @@ class HookManager begin r_hook.hook.run_hook ctx rescue => e - Log.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " + + Oxidized.logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " + "(#{e.inspect}) for event #{event.inspect}" end end @@ -81,7 +81,7 @@ class Hook end def log(msg, level=:info) - Log.send(level, "#{self.class.name}: #{msg}") + Oxidized.logger.send(level, "#{self.class.name}: #{msg}") end end diff --git a/lib/oxidized/input/ftp.rb b/lib/oxidized/input/ftp.rb index a3d7ac8..93cdb38 100644 --- a/lib/oxidized/input/ftp.rb +++ b/lib/oxidized/input/ftp.rb @@ -28,7 +28,7 @@ module Oxidized end def cmd file - Log.debug "FTP: #{file} @ #{@node.name}" + Oxidized.logger.debug "FTP: #{file} @ #{@node.name}" @ftp.getbinaryfile file, nil end diff --git a/lib/oxidized/input/ssh.rb b/lib/oxidized/input/ssh.rb index e45adb6..476a786 100644 --- a/lib/oxidized/input/ssh.rb +++ b/lib/oxidized/input/ssh.rb @@ -43,7 +43,7 @@ module Oxidized end def cmd cmd, expect=node.prompt - Log.debug "SSH: #{cmd} @ #{node.name}" + Oxidized.logger.debug "SSH: #{cmd} @ #{node.name}" if @exec @ssh.exec! cmd else diff --git a/lib/oxidized/input/telnet.rb b/lib/oxidized/input/telnet.rb index b92d703..e9fd7d9 100644 --- a/lib/oxidized/input/telnet.rb +++ b/lib/oxidized/input/telnet.rb @@ -37,7 +37,7 @@ module Oxidized end def cmd cmd, expect=@node.prompt - Log.debug "Telnet: #{cmd} @#{@node.name}" + Oxidized.logger.debug "Telnet: #{cmd} @#{@node.name}" args = { 'String' => cmd } args.merge!({ 'Match' => expect, 'Timeout' => @timeout }) if expect @telnet.cmd args diff --git a/lib/oxidized/log.rb b/lib/oxidized/log.rb deleted file mode 100644 index 04a2d65..0000000 --- a/lib/oxidized/log.rb +++ /dev/null @@ -1,15 +0,0 @@ -module Oxidized - require 'logger' - - class Logger < Logger - def initialize target=STDOUT - super target - end - def file= target - FileUtils.mkdir_p File.dirname(target) - @logdev = LogDevice.new target - end - end - - Log = Logger.new -end diff --git a/lib/oxidized/node.rb b/lib/oxidized/node.rb index 1bbf6dc..c16e3d0 100644 --- a/lib/oxidized/node.rb +++ b/lib/oxidized/node.rb @@ -62,7 +62,7 @@ module Oxidized level = rescue_fail[resc] resc = " (rescued #{resc})" end - Log.send(level, '%s raised %s%s with msg "%s"' % [self.ip, err.class, resc, err.message]) + Oxidized.logger.send(level, '%s raised %s%s with msg "%s"' % [self.ip, err.class, resc, err.message]) return false rescue => err file = Oxidized::Config::Crash + '.' + self.ip.to_s @@ -72,7 +72,7 @@ module Oxidized fh.puts '-' * 50 fh.puts err.backtrace end - Log.error '%s raised %s with msg "%s", %s saved' % [self.ip, err.class, err.message, file] + Oxidized.logger.error '%s raised %s with msg "%s", %s saved' % [self.ip, err.class, err.message, file] return false end end diff --git a/lib/oxidized/nodes.rb b/lib/oxidized/nodes.rb index f0c5d56..0c02d7a 100644 --- a/lib/oxidized/nodes.rb +++ b/lib/oxidized/nodes.rb @@ -1,8 +1,8 @@ module Oxidized - require 'ipaddr' - require 'oxidized/node' - class Oxidized::NotSupported < OxidizedError; end - class Oxidized::NodeNotFound < OxidizedError; end + require 'ipaddr' + require 'oxidized/node' + class Oxidized::NotSupported < OxidizedError; end + class Oxidized::NodeNotFound < OxidizedError; end class Nodes < Array attr_accessor :source alias :put :unshift @@ -18,13 +18,13 @@ module Oxidized _node = Node.new node new.push _node rescue ModelNotFound => err - Log.error "node %s raised %s with message '%s'" % [node, err.class, err.message] + Oxidized.logger.error "node %s raised %s with message '%s'" % [node, err.class, err.message] rescue Resolv::ResolvError => err - Log.error "node %s is not resolvable, raised %s with message '%s'" % [node, err.class, err.message] + Oxidized.logger.error "node %s is not resolvable, raised %s with message '%s'" % [node, err.class, err.message] end end size == 0 ? replace(new) : update_nodes(new) - Log.info "Loaded #{size} nodes" + Oxidized.logger.info "Loaded #{size} nodes" end end @@ -148,9 +148,9 @@ module Oxidized end end end - + public - + def version node, group with_lock do i = find_node_index node @@ -159,7 +159,7 @@ module Oxidized output.version node, group end end - + def get_version node, group, oid with_lock do i = find_node_index node @@ -168,7 +168,7 @@ module Oxidized output.get_version node, group, oid end end - + def get_diff node, group, oid1, oid2 with_lock do i = find_node_index node diff --git a/lib/oxidized/worker.rb b/lib/oxidized/worker.rb index b36929f..15977e2 100644 --- a/lib/oxidized/worker.rb +++ b/lib/oxidized/worker.rb @@ -14,7 +14,7 @@ module Oxidized ended.each { |job| process job } @jobs.work while @jobs.size < @jobs.want - Log.debug "Jobs #{@jobs.size}, Want: #{@jobs.want}" + Oxidized.logger.debug "Jobs #{@jobs.size}, Want: #{@jobs.want}" # ask for next node in queue non destructive way nextnode = @nodes.first unless nextnode.last.nil? @@ -41,7 +41,7 @@ module Oxidized msg += " with message '#{node.msg}'" if node.msg if node.output.new.store node.name, job.config, :msg => msg, :user => node.user, :group => node.group - Log.info "Configuration updated for #{node.group}/#{node.name}" + Oxidized.logger.info "Configuration updated for #{node.group}/#{node.name}" Oxidized.Hooks.handle :post_store, :node => node, :job => job end @@ -58,10 +58,10 @@ module Oxidized Oxidized.Hooks.handle :node_fail, :node => node, :job => job end - Log.warn msg + Oxidized.logger.warn msg end rescue NodeNotFound - Log.warn "#{node.name} not found, removed while collecting?" + Oxidized.logger.warn "#{node.name} not found, removed while collecting?" end end diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index a3b4953..5786d73 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -6,6 +6,7 @@ describe Oxidized::Node do before(:each) do Oxidized.asetus = Asetus.new Oxidized.config.output.git.repo = 'foo.git' + Oxidized.setup_logger @credentials = mock() -- cgit v1.2.3 From c2a52593a70a89582202d629842189b4a1448a15 Mon Sep 17 00:00:00 2001 From: Elvin Efendi Date: Sun, 13 Dec 2015 22:12:24 -0500 Subject: do not commit when there is no diff --- lib/oxidized/hook/githubrepo.rb | 17 ++++++-- spec/githubrepo_spec.rb | 89 ++++++++++++++++++++++++++++++----------- 2 files changed, 80 insertions(+), 26 deletions(-) (limited to 'spec') diff --git a/lib/oxidized/hook/githubrepo.rb b/lib/oxidized/hook/githubrepo.rb index 22ee8ea..d10b51e 100644 --- a/lib/oxidized/hook/githubrepo.rb +++ b/lib/oxidized/hook/githubrepo.rb @@ -15,13 +15,24 @@ class GithubRepo < Oxidized::Hook end def fetch_and_merge_remote(repo) - repo.fetch('origin', [repo.head.name], credentials: credentials) + result = repo.fetch('origin', [repo.head.name], credentials: credentials) + log result.inspect, :debug - their_branch = repo.branches["origin/master"] or return + unless result[:total_deltas] > 0 + log "nothing recieved after fetch", :debug + return + end + + their_branch = repo.branches["origin/master"] + + log "merging fetched branch #{their_branch.name}", :debug merge_index = repo.merge_commits(repo.head.target_id, their_branch.target_id) - log("Conflicts detected", :warn) if merge_index.conflicts? + if merge_index.conflicts? + log("Conflicts detected, skipping Rugged::Commit.create", :warn) + return + end Rugged::Commit.create(repo, { parents: [repo.head.target, their_branch.target], diff --git a/spec/githubrepo_spec.rb b/spec/githubrepo_spec.rb index 5786d73..9ad43e9 100644 --- a/spec/githubrepo_spec.rb +++ b/spec/githubrepo_spec.rb @@ -3,52 +3,95 @@ require 'rugged' require 'oxidized/hook/githubrepo' describe Oxidized::Node do + let(:credentials) { mock() } + let(:remote) { mock() } + let(:repo_head) { mock() } + let(:repo) { mock() } + let(:gr) { GithubRepo.new } + before(:each) do Oxidized.asetus = Asetus.new Oxidized.config.output.git.repo = 'foo.git' Oxidized.setup_logger + end - @credentials = mock() + describe "#fetch_and_merge_remote" do + before(:each) do + Oxidized.config.hooks.github_repo_hook.remote_repo = 'git@github.com:username/foo.git' + Rugged::Credentials::SshKeyFromAgent.expects(:new).with(username: 'git').returns(credentials) + repo_head.expects(:name).returns('refs/heads/master') + gr.cfg = Oxidized.config.hooks.github_repo_hook + end - remote = mock() - remote.expects(:url).returns('https://github.com/username/foo.git') - remote.expects(:push).with(['refs/heads/master'], credentials: @credentials).returns(true) + it "should not try to merge when there is no update in remote branch" do + repo.expects(:fetch).with('origin', ['refs/heads/master'], credentials: credentials).returns(Hash.new(0)) + repo.expects(:branches).never + repo.expects(:head).returns(repo_head) + gr.fetch_and_merge_remote(repo).must_equal nil + end + describe "when there is update considering conflicts" do + let(:merge_index) { mock() } + let(:their_branch) { mock() } - repo_head = mock() - repo_head.expects(:name).twice.returns('refs/heads/master') + before(:each) do + repo.expects(:fetch).with('origin', ['refs/heads/master'], credentials: credentials).returns({total_deltas: 1}) + their_branch.expects(:target_id).returns(1) + repo_head.expects(:target_id).returns(2) + repo.expects(:merge_commits).with(2, 1).returns(merge_index) + repo.expects(:branches).returns({"origin/master" => their_branch}) + end - repo = mock() - repo.expects(:path).returns('foo.git') - repo.expects(:remotes).returns({'origin' => remote}) - repo.expects(:head).twice.returns(repo_head) - repo.expects(:fetch).with('origin', ['refs/heads/master'], credentials: @credentials).returns(true) - repo.expects(:branches).returns({}) + it "should not try merging when there's conflict" do + repo.expects(:head).twice.returns(repo_head) + their_branch.expects(:name).returns("origin/master") + merge_index.expects(:conflicts?).returns(true) + Rugged::Commit.expects(:create).never + gr.fetch_and_merge_remote(repo).must_equal nil + end - Rugged::Repository.expects(:new).with('foo.git').returns(repo) + it "should merge when there is no conflict" do + repo.expects(:head).times(3).returns(repo_head) + their_branch.expects(:target).returns("their_target") + their_branch.expects(:name).twice.returns("origin/master") + repo_head.expects(:target).returns("our_target") + merge_index.expects(:write_tree).with(repo).returns("tree") + merge_index.expects(:conflicts?).returns(false) + Rugged::Commit.expects(:create).with(repo, { + parents: ["our_target", "their_target"], + tree: "tree", + message: "Merge remote-tracking branch 'origin/master'", + update_ref: "HEAD" + }).returns(1) + gr.fetch_and_merge_remote(repo).must_equal 1 + end + end end describe "#run_hook" do + before(:each) do + remote.expects(:url).returns('https://github.com/username/foo.git') + remote.expects(:push).with(['refs/heads/master'], credentials: credentials).returns(true) + repo_head.expects(:name).twice.returns('refs/heads/master') + repo.expects(:head).twice.returns(repo_head) + repo.expects(:path).returns('foo.git') + repo.expects(:remotes).returns({'origin' => remote}) + repo.expects(:fetch).with('origin', ['refs/heads/master'], credentials: credentials).returns(Hash.new(0)) + Rugged::Repository.expects(:new).with('foo.git').returns(repo) + end + it "will push to the remote repository using https" do Oxidized.config.hooks.github_repo_hook.remote_repo = 'https://github.com/username/foo.git' Oxidized.config.hooks.github_repo_hook.username = 'username' Oxidized.config.hooks.github_repo_hook.password = 'password' - - Rugged::Credentials::UserPassword.expects(:new).with(username: 'username', password: 'password').returns(@credentials) - - gr = GithubRepo.new + Rugged::Credentials::UserPassword.expects(:new).with(username: 'username', password: 'password').returns(credentials) gr.cfg = Oxidized.config.hooks.github_repo_hook - gr.run_hook(nil).must_equal true end it "will push to the remote repository using ssh" do Oxidized.config.hooks.github_repo_hook.remote_repo = 'git@github.com:username/foo.git' - - Rugged::Credentials::SshKeyFromAgent.expects(:new).with(username: 'git').returns(@credentials) - - gr = GithubRepo.new + Rugged::Credentials::SshKeyFromAgent.expects(:new).with(username: 'git').returns(credentials) gr.cfg = Oxidized.config.hooks.github_repo_hook - gr.run_hook(nil).must_equal true end end -- cgit v1.2.3