oxidized 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd1e30df648aee0f0e1a19d7a55bb91879e0456b
-  data.tar.gz: 239581a70a3709f67173cb59bf0288bcff6a4b7d
+  metadata.gz: 4f601ebdf3c7562322e2b76313f60e4128863968
+  data.tar.gz: c0151bcf8e6c02d53511321f198bdd7fd55ac1cf
 SHA512:
-  metadata.gz: 98c9644577c24e064c415e985b09f501ef4ce9153a9ab3e7921fcb6093057e037cccc3157c8d2eca71660641501670e9840a57abd45d330ad5b482e8ec640148
-  data.tar.gz: 4c9cfe10817d51454ceaca602e10d8dc08d283b8f7a1c850185064369840eb0c80f6479a513ffa2fcbcdbdad36b265eee92fcda278c8b0f10e5b7ad1dda7d2c0
+  metadata.gz: ff1578ea27961bdf57d32433da245795a880f95e6698f1f2b37692617d4779467673c78a1e27318204c8fc5b0ef4bbb05c379bee870f1fe59365727bef7a8222
+  data.tar.gz: fde31a1ef6e58ceebe9b1bcc822efdcc37971c234b474f64daa679bb50c87f308e474c7aad132ac41f837be91e4034aaba8db346fed987cc3f3a6dea7846bc3d

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.10.0
+- FEATURE: Various refactoring (by @ElvinEfendi)
+- FEATURE: Ciena SOAS support (by @jgroom33)
+- FEATURE: support group variables (by @supertylerc)
+- BUGFIX: various ((orly))  (by @marnovdm, @danbaugher, @MrRJ45, @asynet, @nickhilliard)
+
 # 0.9.0
 - FEATURE: input log now uses devices name as file, instead of string from config (by @skoef)
 - FEATURE: Dell Networkign OS (dnos) support (by @erefre)

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    oxidized (0.9.0)
+      asetus (~> 0.1)
+      net-ssh (~> 3.0, >= 3.0.2)
+      rugged (~> 0.21, >= 0.21.4)
+      slop (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    asetus (0.3.0)
+    coderay (1.1.0)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.8.3)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    net-ssh (3.0.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rugged (0.23.3)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  minitest (~> 5.8)
+  mocha (~> 1.1)
+  oxidized!
+  pry (~> 0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,4 +1,4 @@
-# Oxidized
+# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized)
 
 [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized)
 
@@ -42,39 +42,66 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
 
 # Supported OS types
 
- * A10 Networks ACOS
- * Alcatel-Lucent ISAM 7302/7330
- * Alcatel-Lucent Operating System AOS
- * Alcatel-Lucent Operating System AOS7
- * Alcatel-Lucent Operating System Wireless
- * Alcatel-Lucent TiMOS
- * Arista EOS
- * Brocade Fabric OS
- * Brocade Ironware
- * Brocade NOS (Network Operating System)
- * Brocade Vyatta
- * Cisco AireOS
- * Cisco ASA
- * Cisco IOS
- * Cisco IOS-XR
- * Cisco NXOS
- * Cisco SMB (Nikola series)
- * Cumulus Linux
- * DELL PowerConnect
- * Extreme Networks XOS
- * Force10 FTOS
- * Force10 NDOS
- * FortiGate FortiOS
- * HP Comware (HP A-series, H3C, 3Com)
- * HP ProCurve
- * Huawei VRP
- * Juniper JunOS
- * Juniper ScreenOS (Netscreen)
- * Mikrotik RouterOS
- * MRV Master-OS
- * Ubiquiti AirOS
- * Palo Alto PAN-OS
- * Zyxel ZyNOS
+ * A10 Networks
+   * ACOS
+ * Alcatel-Lucent
+   * ISAM
+   * AOS
+   * AOS7
+   * Wireless
+   * TiMOS
+ * Arista
+   * EOS
+ * Arris
+   * C4CMTS
+ * Aruba
+   * AOSW
+ * Brocade
+   * FabricOS
+   * Ironware
+   * NOS (Network Operating System)
+   * Vyatta
+ * Ciena
+   * SOAS
+ * Cisco
+   * AireOS
+   * ASA
+   * IOS
+   * IOSXR
+   * NXOS
+   * SMB (Nikola series)
+ * Cumulus
+   * Linux
+ * DELL
+   * PowerConnect
+   * AOSW
+ * Extreme Networks
+   * XOS
+ * Force10
+   * FTOS
+ * Force10
+   * DNOS
+ * FortiGate
+   * FortiOS
+ * HP
+   * Comware (HP A-series, H3C, 3Com)
+   * Procurve
+ * Huawei
+   * VRP
+ * Juniper
+   * JunOS
+   * ScreenOS (Netscreen)
+ * Mikrotik
+   * RouterOS
+ * MRV
+   * MasterOS
+ * Ubiquiti
+   * AirOS
+   * Edgeos
+ * Palo Alto
+   * PANOS
+ * Zyxel
+   * ZyNOS
 
 
 # Installation
@@ -113,7 +140,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.
 ```
@@ -444,6 +471,8 @@ OX_NODE_MSG
 OX_NODE_GROUP
 OX_JOB_STATUS
 OX_JOB_TIME
+OX_REPO_COMMITREF
+OX_REPO_NAME
 ```
 
 Exec hook recognizes following configuration keys:

data/Rakefile

@@ -1,10 +1,5 @@
-begin
-  require 'rake/testtask'
-  require 'bundler'
-  # Bundler.setup
-rescue LoadError
-  warn 'bundler missing'
-end
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 gemspec = eval(File.read(Dir['*.gemspec'].first))
 file    = [gemspec.name, gemspec.version].join('-') + '.gem'
@@ -17,8 +12,9 @@ end
 desc 'Run minitest'
 task :test do
   Rake::TestTask.new do |t|
-    t.libs.push "lib"
-    t.test_files = FileList['spec/*_spec.rb']
+    t.libs << 'spec'
+    t.test_files = FileList['spec/**/*_spec.rb']
+    t.warning = true
     t.verbose = true
   end
 end
@@ -49,3 +45,5 @@ desc 'Push to rubygems'
 task :push => :tag do
   system "gem push gems/#{file}"
 end
+
+task default: :test

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'oxidized'
+require 'pry'
+
+Pry.start

data/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

data/extra/nagios_check_failing_nodes.rb

@@ -23,12 +23,12 @@ json.each do |node|
   end
 end
 
-if pending
-  puts '[WARN] Pending backup: ' + pending_nodes.join(',')
-  exit 1
-elsif critical
+if critical
   puts '[CRIT] Unable to backup: ' + critical_nodes.join(',')
   exit 2
+elsif pending
+  puts '[WARN] Pending backup: ' + pending_nodes.join(',')
+  exit 1
 else
   puts '[OK] Backup of all nodes completed successfully.'
   exit 0

data/extra/oxidized-report-git-commits

@@ -0,0 +1,80 @@
+#!/bin/sh
+# 
+# A script to maintain a local working copy of an oxidized configuration
+# repository and mail out diffs for configuration changes
+# 
+# Copyright 2016 Nick Hilliard <nick@foobar.org>, All Rights Reserved
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# usage: add the following hook to the oxidized config file:
+# 
+# hooks:
+#  email_output:
+#    type: exec
+#    events: [post_store, node_fail]
+#    cmd: 'update-local-repo.sh ~/gitdir/ | mail -s "Oxidized updates for ${OX_NODE_NAME}" update-recipient@example.com'
+#    async: true
+#    timeout: 120
+# 
+#
+# The script takes a single argument, namely a git working directory name,
+# e.g.  "~/gitdir/".  This is only used as a staging directory and should
+# not be set to be the same as the git repo directory.
+#
+
+PATH=${PATH}:/usr/local/bin:/usr/local/sbin
+export PATH
+
+gitdir=$1
+
+if [ X${OX_REPO_COMMITREF} = "X" ]; then
+	echo \$OX_REPO_COMMITREF not set
+	exit 64
+fi
+
+if [ X${OX_REPO_NAME} = "X" ]; then
+	echo \$OX_REPO_NAME not set
+	exit 64
+fi
+	
+if [ ! -d ${gitdir}/.git ]; then
+	git clone -q ${OX_REPO_NAME} ${gitdir}
+
+	ret=$?
+	if [ X"${ret}" != X0 ] && [ X"${ret}" != X1 ]; then
+		echo git clone failed: aborting.
+		exit 128
+	fi
+fi
+
+cd ${gitdir}
+
+git pull -q > /dev/null 2>&1 
+ret=$?
+if [ X"${ret}" != X0 ] && [ X"${ret}" != X1 ]; then
+	echo git pull failed: aborting.
+	exit 128
+fi
+
+# Git is probably working at this stage, so safe to emit more info
+
+echo "Node name: ${OX_NODE_NAME}"
+echo "Group Name: ${OX_NODE_GROUP}"
+echo "Job Time: ${OX_JOB_TIME}"
+echo "Git Commit ID: ${OX_REPO_COMMITREF}"
+echo "Git Repo: ${OX_REPO_NAME}"
+echo "Local working dir: ${gitdir}"
+echo ""
+
+git diff --no-color ${OX_REPO_COMMITREF}~1..${OX_REPO_COMMITREF}

data/extra/rvm.oxidized.upstart

@@ -0,0 +1,18 @@
+start on started networking
+
+respawn
+
+setuid oxidized
+setgid oxidized
+
+chdir /home/oxidized
+
+env HOME=/home/oxidized
+
+pre-start script
+	test -x /usr/local/rvm/wrappers/ruby-2.1.2/oxidized || { stop; exit 0; }
+end script
+
+script
+	exec /usr/local/rvm/wrappers/ruby-2.1.2/oxidized
+end script

data/lib/oxidized.rb

@@ -1,6 +1,49 @@
 module Oxidized
   class OxidizedError < StandardError; end
-  Encoding.default_external = 'UTF-8'
-  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
+    @@asetus
+  end
+
+  def self.asetus=(val)
+    @@asetus = val
+  end
+
+  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

data/lib/oxidized/cli.rb

@@ -1,11 +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
@@ -16,13 +19,16 @@ module Oxidized
     private
 
     def initialize
-      Log.info "Oxidized starting, running as pid #{$$}"
       _args, @opts = parse_opts
-      CFG.debug = true if @opts[:debug]
+
+      Config.load(@opts)
+      Oxidized.setup_logger
+
+      @pidfile = File.expand_path("pid")
     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
@@ -40,5 +46,49 @@ module Oxidized
       end
       [opts.parse!, opts]
     end
+
+    def pidfile
+      @pidfile
+    end
+
+    def pidfile?
+      !!pidfile
+    end
+
+    def write_pid
+      if pidfile?
+        begin
+          File.open(pidfile, ::File::CREAT | ::File::EXCL | ::File::WRONLY){|f| f.write("#{Process.pid}") }
+          at_exit { File.delete(pidfile) if File.exists?(pidfile) }
+        rescue Errno::EEXIST
+          check_pid
+          retry
+        end
+      end
+    end
+
+    def check_pid
+      if pidfile?
+        case pid_status(pidfile)
+        when :running, :not_owned
+          puts "A server is already running. Check #{pidfile}"
+          exit(1)
+        when :dead
+          File.delete(pidfile)
+        end
+      end
+    end
+
+    def pid_status(pidfile)
+      return :exited unless File.exists?(pidfile)
+      pid = ::File.read(pidfile).to_i
+      return :dead if pid == 0
+      Process.kill(0, pid)
+      :running
+    rescue Errno::ESRCH
+      :dead
+    rescue Errno::EPERM
+      :not_owned
+    end
   end
 end