oxidized-web 0.13.1 → 0.15.0

data/spec/node_spec.rb

@@ -0,0 +1,99 @@
+require_relative 'spec_helper'
+
+describe Oxidized::API::WebApp do
+  include Rack::Test::Methods
+
+  def app
+    Oxidized::API::WebApp
+  end
+
+  before do
+    @nodes = mock('Oxidized::Nodes')
+    app.set(:nodes, @nodes)
+  end
+
+  describe '/node/fetch/' do
+    it 'gets the latest configuration of a node' do
+      @nodes.expects(:fetch).with('sw42', nil).returns('Configuration of sw42')
+
+      get '/node/fetch/sw42'
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal 'Configuration of sw42'
+    end
+
+    it 'gets the configuration of a node when a group is given' do
+      @nodes.expects(:fetch).with('sw42', 'mygroup').returns('Configuration of sw42')
+
+      get '/node/fetch/mygroup/sw42'
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal 'Configuration of sw42'
+    end
+
+    it 'gets the configuration of a node when a group contains /' do
+      @nodes.expects(:fetch).with('sw42', 'my/group').returns('Configuration of sw42')
+
+      get '/node/fetch/my/group/sw42'
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal 'Configuration of sw42'
+    end
+
+    it 'displays an error when the node is not found' do
+      @nodes.expects(:fetch).raises(Oxidized::NodeNotFound, 'unable to find \'sw12\'')
+
+      get '/node/fetch/sw12'
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal 'unable to find \'sw12\''
+    end
+  end
+
+  describe '/node/next/' do
+    it 'marks a node to be reloaded, then redirects to /nodes' do
+      # Don't know why the method has been called Nodes#next...
+      # This is for reloading the node configuration
+      @nodes.expects(:next).with('sw42')
+      get '/node/next/sw42'
+
+      _(last_response.redirect?).must_equal true
+      _(last_response.location).must_equal 'http://example.org/nodes'
+    end
+
+    it 'returns ok when requiring json' do
+      @nodes.expects(:next).with('sw42')
+      get '/node/next/sw42.json'
+
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal '["ok"]'
+    end
+
+    # Don't know if this feature is used by anyone...
+    it 'attaches user/email/message to the commit when using put and json' do
+      data = {
+        'user' => 'me',
+        'email' => 'me@example.com',
+        'message' => 'minitest, rack/test & mock simply rock',
+        'from' => 'unused variable!'
+      }
+      @nodes.expects(:next).with('sw42', data)
+
+      put '/node/next/sw42.json', data.to_json, "CONTENT_TYPE" => "application/json"
+
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal '["ok"]'
+    end
+
+    it 'attaches data to the commit when using a group and put, then redirects' do
+      data = {
+        'user' => 'me',
+        'email' => 'me@example.com',
+        'message' => 'minitest, rack/test & mock simply rock',
+        'from' => 'unused variable!'
+      }
+      @nodes.expects(:next).with('sw42', data)
+
+      put '/node/next/mygroup/sw42', data.to_json, "CONTENT_TYPE" => "application/json"
+
+      _(last_response.redirect?).must_equal true
+      _(last_response.location).must_equal 'http://example.org/nodes'
+    end
+  end
+end

data/spec/node_version_spec.rb

@@ -0,0 +1,102 @@
+require_relative 'spec_helper'
+
+describe Oxidized::API::WebApp do
+  include Rack::Test::Methods
+
+  def app
+    Oxidized::API::WebApp
+  end
+
+  before do
+    @nodes = mock('Oxidized::Nodes')
+    app.set(:nodes, @nodes)
+  end
+
+  describe '/node/version.?:format?' do
+    it 'fetches all versions of a node without a group' do
+      @nodes.expects(:version).with('sw5', nil).returns(
+        [{ oid: "C006", date: "2025-02-05 19:49:00 +0100" },
+         { oid: "C003", date: "2025-02-05 19:03:00 +0100" },
+         { oid: "C001", date: "2025-02-05 19:01:00 +0100" }]
+      )
+
+      get '/node/version?node_full=sw5'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?(
+          "<tr>\n<td>3</td>\n<td>2025-02-05 19:49:00 +0100</td>\n"
+        )).must_equal true
+    end
+
+    it 'fetches all versions of a node with a group' do
+      @nodes.expects(:version).with('sw5', 'group1').returns(
+        [{ oid: "C006", date: "2025-02-05 19:49:00 +0100" },
+         { oid: "C003", date: "2025-02-05 19:03:00 +0100" },
+         { oid: "C001", date: "2025-02-05 19:01:00 +0100" }]
+      )
+
+      get '/node/version?node_full=group1/sw5'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?(
+          "<tr>\n<td>3</td>\n<td>2025-02-05 19:49:00 +0100</td>\n"
+        )).must_equal true
+    end
+
+    it 'fetches all versions of a node with a group with /' do
+      @nodes.expects(:version).with('sw5', 'gr/oup1').returns(
+        [{ oid: "C006", date: "2025-02-05 19:49:00 +0100" },
+         { oid: "C003", date: "2025-02-05 19:03:00 +0100" },
+         { oid: "C001", date: "2025-02-05 19:01:00 +0100" }]
+      )
+
+      get '/node/version?node_full=gr/oup1/sw5'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?(
+          "<tr>\n<td>3</td>\n<td>2025-02-05 19:49:00 +0100</td>\n"
+        )).must_equal true
+    end
+  end
+
+  describe '/node/version/view.?:format?' do
+    it 'fetches a previous version from git' do
+      @nodes.expects(:get_version).with('sw5', '', 'c8aa93cab5').returns('Old configuration of sw5')
+
+      get '/node/version/view?node=sw5&group=&oid=c8aa93cab5&date=2024-06-07 08:27:37 +0200&num=2'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?('Old configuration of sw5')).must_equal true
+    end
+
+    it 'does not display binary content' do
+      @nodes.expects(:get_version).with('sw5', '', 'c8aa93cab5').returns("\xff\x42 binary content\x00")
+
+      get '/node/version/view?node=sw5&group=&oid=c8aa93cab5&date=2024-06-07 08:27:37 +0200&num=2'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?('cannot display')).must_equal true
+    end
+
+    it 'fetches a git-version when using a group containing /' do
+      @nodes.expects(:get_version).with('sw5', 'my/group', 'c8aa93cab5').returns('Old configuration of sw5')
+
+      get '/node/version/view?node=sw5&group=my/group&oid=c8aa93cab5&date=2024-06-07 08:27:37 +0200&num=2'
+      _(last_response.ok?).must_equal true
+      _(last_response.body.include?('Old configuration of sw5')).must_equal true
+    end
+
+    it 'does not encode html-chars in text-format' do
+      configuration = "text &/<> \n ascii;"
+      @nodes.expects(:get_version).with('sw5', '', 'c8aa93cab5').returns(configuration)
+      get '/node/version/view?node=sw5&group=&oid=c8aa93cab5&date=2024-06-07 08:27:37 +0200&num=2&format=text'
+
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal configuration
+    end
+
+    it 'does not encode html-chars in json-format' do
+      configuration = "text &/<> \n ascii;"
+      @nodes.expects(:get_version).with('sw5', '', 'c8aa93cab5').returns(configuration)
+      get '/node/version/view?node=sw5&group=&oid=c8aa93cab5&date=2024-06-07 08:27:37 +0200&num=2&format=json'
+
+      _(last_response.ok?).must_equal true
+      _(last_response.body).must_equal '["text &/<> \n"," ascii;"]'
+    end
+  end
+end

data/spec/nodes_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'spec_helper'
+require 'json'
+
+describe Oxidized::API::WebApp do
+  include Rack::Test::Methods
+
+  def app
+    Oxidized::API::WebApp
+  end
+
+  before do
+    @nodes = mock('Oxidized::Nodes')
+    @nodes.expects(:list).returns(
+      [{ name: 'sw4', ip: '10.10.10.10', model: 'ios', time: 'time', mtime: 'mtime' },
+       { name: 'sw5', ip: '10.10.10.5',  model: 'ios', time: 'time', mtime: 'mtime' },
+       { name: 'sw6', ip: '10.10.10.6',  model: 'ios', time: 'time', mtime: 'mtime' },
+       { name: 'sw7', ip: '10.10.10.7',  model: 'ios', time: 'time', mtime: 'mtime', group: 'group1' },
+       { name: 'sw8', ip: '10.10.10.8',  model: 'aos', time: 'time', mtime: 'mtime', group: 'group1' },
+       { name: 'sw9', ip: '10.10.10.9',  model: 'aos', time: 'time', mtime: 'mtime', group: 'gr/oup1' }]
+    )
+    app.set(:nodes, @nodes)
+  end
+
+  describe '/nodes.?:format?' do
+    it 'shows all nodes' do
+      get '/nodes.json'
+
+      _(last_response.ok?).must_equal true
+      result = JSON.parse(last_response.body)
+      _(result.length).must_equal 6
+    end
+  end
+
+  describe '/nodes/:filter/*' do
+    it 'shows all nodes of a group' do
+      get '/nodes/group/group1.json'
+
+      _(last_response.ok?).must_equal true
+      result = JSON.parse(last_response.body)
+      _(result.length).must_equal 2
+    end
+    it 'shows all nodes of a group with /' do
+      get '/nodes/group/gr/oup1.json'
+
+      _(last_response.ok?).must_equal true
+      result = JSON.parse(last_response.body)
+      _(result.length).must_equal 1
+    end
+    it 'shows all nodes of a model' do
+      get '/nodes/model/ios.json'
+
+      _(last_response.ok?).must_equal true
+      result = JSON.parse(last_response.body)
+      _(result.length).must_equal 4
+    end
+  end
+end

data/spec/root_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+
+describe Oxidized::API::WebApp do
+  include Rack::Test::Methods
+
+  def app
+    Oxidized::API::WebApp
+  end
+
+  describe '/' do
+    it 'should redirect to /nodes' do
+      get '/'
+
+      _(last_response.redirect?).must_equal true
+      _(last_response.location).must_equal 'http://example.org/nodes'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# Needed to get the error output on the console and not in last_response.body
+ENV['APP_ENV'] = 'test'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'rack/test'
+require 'oxidized'
+require 'oxidized/web/webapp'
+require 'mocha/minitest'

data/spec/webapp_spec.rb

@@ -0,0 +1,28 @@
+require_relative 'spec_helper'
+
+# Test helper methods in Oxidized::API::WebApp
+
+describe Oxidized::API::WebApp do
+  include Rack::Test::Methods
+
+  before do
+    @webapp = Oxidized::API::WebApp.new
+  end
+
+  describe 'convert_to_utf8' do
+    it 'cannot work with binary data' do
+      # private method => we must use send
+      result = @webapp.helpers.send(:convert_to_utf8, "\xff\x42 binary content\x00")
+      _(result).must_equal 'The text contains binary values - cannot display'
+    end
+  end
+
+  describe 'diff_view' do
+    it 'cannot work with binary data' do
+      # private method => we must use send
+      result = @webapp.helpers.send(:diff_view, "\xff\x42 binary content\x00")
+      _(result[:old_diff]).must_equal ['The text contains binary values - cannot display']
+      _(result[:new_diff]).must_equal ['The text contains binary values - cannot display']
+    end
+  end
+end