oxidized-web 0.14.0 → 0.15.0

data/lib/oxidized/web/version.rb

@@ -2,6 +2,6 @@
 
 module Oxidized
   module API
-    WEB_VERSION = '0.14.0'
+    WEB_VERSION = '0.15.0'
   end
 end

data/lib/oxidized/web/views/layout.haml

@@ -20,10 +20,6 @@
               %a.nav-link{class: request.path_info == '/nodes/stats' ? 'active' : '',
                             :'aria-current' => request.path_info == '/nodes/stats' ? 'page' : 'false',
                             href: url_for('/nodes/stats')} Stats
-            %li.nav-item
-              %a.nav-link{class: request.path_info == '/migration' ? 'active' : '',
-                            :'aria-current' => request.path_info == '/migration' ? 'page' : 'false',
-                            href: url_for('/migration')} Migration
           %form.d-flex{role: 'search',
                       action: url_for('/nodes/conf_search'),
                       method: 'post'}

data/lib/oxidized/web/webapp.rb

@@ -6,7 +6,6 @@ require 'tilt/haml'
 # rubocop:disable Lint/RedundantRequireStatement
 require 'pp'
 # rubocop:enable Lint/RedundantRequireStatement
-require 'oxidized/web/mig'
 require 'htmlentities'
 require 'charlock_holmes'
 module Oxidized
@@ -26,9 +25,17 @@ module Oxidized
         redirect url_for('/images/favicon.ico')
       end
 
-      get '/nodes/:filter/:value.?:format?' do
+      # :filter can be "group" or "model"
+      # URL: /nodes/group/<GroupName>[.json]
+      # URL: /nodes/model/<ModelName>[.json]
+      # an optional .json extention returns the data as JSON
+      #
+      # as GroupName can include /, we use splat to match its value
+      # and extract the optional ".json" with route_parse
+      get '/nodes/:filter/*' do
+        value, @json = route_parse params[:splat].first
         @data = nodes.list.select do |node|
-          next unless node[params[:filter].to_sym] == params[:value]
+          next unless node[params[:filter].to_sym] == value
 
           node[:status] = 'never'
           node[:time]   = 'never'
@@ -100,7 +107,7 @@ module Oxidized
         out :text
       end
 
-      # URL: /node/fetch/<group>/<node>.json
+      # URL: /node/fetch/<group>/<node>[.json]
       # <group> is optional, and not used
       # .json is optional. If given, will return 'ok'
       # if not, it redirects to /nodes
@@ -128,40 +135,17 @@ module Oxidized
         out :node
       end
 
-      # redirect to the web page for rancid - oxidized migration
-      get '/migration' do
-        out :migration
-      end
-
-      # get the files send
-      post '/migration' do
-        number = params[:number].to_i
-        cloginrc_file = params['cloginrc'][:tempfile]
-        path_new_file = params['path_new_file']
-
-        router_db_files = []
-
-        i = 1
-        while i <= number
-          router_db_files.push({ file: params["file#{i}"][:tempfile], group: params["group#{i}"] })
-          i += 1
-        end
-
-        migration = Mig.new(router_db_files, cloginrc_file, path_new_file)
-        migration.go_rancid_migration
-        redirect url_for('//nodes')
-      end
-
-      # show the lists of versions for a node
+      # display the versions of a node
+      # URL: /node/version[.json]?node_full=<GroupName/NodeName>
       get '/node/version.?:format?' do
         @data = nil
         @group = nil
         @node = nil
         node_full = params[:node_full]
         if node_full.include? '/'
-          node_full = node_full.split('/')
+          node_full = node_full.rpartition("/")
           @group = node_full[0]
-          @node = node_full[1]
+          @node = node_full[2]
           @data = nodes.version @node, @group
         else
           @node = node_full
@@ -182,7 +166,7 @@ module Oxidized
         }
 
         the_data = nodes.get_version node, @info[:group], @info[:oid]
-        if params[:format] == 'json' || params[:format] == 'text'
+        if %w[json text].include?(params[:format])
           @data = the_data
         else
           utf8_encoded_content = convert_to_utf8(the_data)
@@ -231,6 +215,10 @@ module Oxidized
         redirect url_for("/node/version/diffs?node=#{params[:node]}&group=#{params[:group]}&oid=#{params[:oid]}&date=#{params[:date]}&num=#{params[:num]}&oid2=#{params[:oid2]}")
       end
 
+      # Taken von Haml 5.0, so it still works in 6.0
+      HTML_ESCAPE = { '&' => '&amp;', '<' => '&lt;', '>' => '&gt;', '"' => '&quot;', "'" => '&#39;' }.freeze
+      HTML_ESCAPE_ONCE_REGEX = /['"><]|&(?!(?:[a-zA-Z]+|#(?:\d+|[xX][0-9a-fA-F]+));)/
+
       private
 
       def out(template = :text)
@@ -328,9 +316,6 @@ module Oxidized
         { old_diff: old_diff, new_diff: new_diff }
       end
 
-      # Taken von Haml 5.0, so it still works in 6.0
-      HTML_ESCAPE = { '&' => '&amp;', '<' => '&lt;', '>' => '&gt;', '"' => '&quot;', "'" => '&#39;' }.freeze
-      HTML_ESCAPE_ONCE_REGEX = /['"><]|&(?!(?:[a-zA-Z]+|#(?:\d+|[xX][0-9a-fA-F]+));)/
       def escape_once(text)
         text = text.to_s
         text.gsub(HTML_ESCAPE_ONCE_REGEX, HTML_ESCAPE)

data/oxidized-web.gemspec

@@ -18,17 +18,18 @@ Gem::Specification.new do |s|
 
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version =                       '>= 3.1'
+  s.required_ruby_version = '>= 3.1'
 
-  s.add_runtime_dependency 'charlock_holmes',     '~> 0.7.5'
-  s.add_runtime_dependency 'emk-sinatra-url-for', '~> 0.2'
-  s.add_runtime_dependency 'haml',                '~> 6.0'
-  s.add_runtime_dependency 'htmlentities',        '~> 4.3'
-  s.add_runtime_dependency 'json',                '~> 2.3'
-  s.add_runtime_dependency 'oxidized',            '~> 0.26'
-  s.add_runtime_dependency 'puma',                '>= 3.11.4', '< 6.5.0'
-  s.add_runtime_dependency 'sinatra',             '>= 1.4.6', '< 5.0'
-  s.add_runtime_dependency 'sinatra-contrib',     '>= 1.4.6', '< 5.0'
+  s.add_dependency 'charlock_holmes',     '~> 0.7.5'
+  s.add_dependency 'emk-sinatra-url-for', '~> 0.2'
+  s.add_dependency 'haml',                '~> 6.0'
+  s.add_dependency 'htmlentities',        '~> 4.3'
+  s.add_dependency 'json',                '~> 2.3'
+  s.add_dependency 'ostruct',             '~> 0.6'
+  s.add_dependency 'oxidized',            '~> 0.31'
+  s.add_dependency 'puma',                '>= 3.11.4'
+  s.add_dependency 'sinatra',             '>= 1.4.6'
+  s.add_dependency 'sinatra-contrib',     '>= 1.4.6'
 
   s.add_development_dependency 'bundler',              '~> 2.2'
   s.add_development_dependency 'minitest',             '~> 5.18'
@@ -36,11 +37,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test',            '~> 2.1'
   s.add_development_dependency 'rails_best_practices', '~> 1.19'
   s.add_development_dependency 'rake',                 '~> 13.0'
-  s.add_development_dependency 'rubocop',              '~> 1.64.1'
-  s.add_development_dependency 'rubocop-minitest',     '~> 0.35.0'
-  s.add_development_dependency 'rubocop-rails',        '~> 2.25.0'
-  s.add_development_dependency 'rubocop-rake',         '~> 0.6.0'
+  s.add_development_dependency 'rubocop',              '~> 1.72.1'
+  s.add_development_dependency 'rubocop-minitest',     '~> 0.37.1'
+  s.add_development_dependency 'rubocop-rails',        '~> 2.30.0'
+  s.add_development_dependency 'rubocop-rake',         '~> 0.7.1'
   s.add_development_dependency 'simplecov',            '~> 0.22.0'
   s.add_development_dependency 'simplecov-cobertura',  '~> 2.1.0'
-  s.add_development_dependency 'simplecov-html',       '~> 0.12.3'
+  s.add_development_dependency 'simplecov-html',       '~> 0.13.1'
 end

data/package-lock.json

@@ -60,38 +60,38 @@
       ]
     },
     "node_modules/datatables.net": {
-      "version": "2.0.8",
-      "resolved": "https://registry.npmjs.org/datatables.net/-/datatables.net-2.0.8.tgz",
-      "integrity": "sha512-4/2dYx4vl975zQqZbyoVEm0huPe61qffjBRby7K7V+y9E+ORq4R8KavkgrNMmIgO6cl85Pg4AvCbVjvPCIT1Yg==",
+      "version": "2.2.2",
+      "resolved": "https://registry.npmjs.org/datatables.net/-/datatables.net-2.2.2.tgz",
+      "integrity": "sha512-gfODIKE3gpgbVeZy2QGj2Dq9roO6hy00S+k1knklrqlMyAMrh1wt0Q6ryBUM7gU96U77ysbq8dYhxFdmcC/oPQ==",
       "dependencies": {
         "jquery": ">=1.7"
       }
     },
     "node_modules/datatables.net-bs5": {
-      "version": "2.0.8",
-      "resolved": "https://registry.npmjs.org/datatables.net-bs5/-/datatables.net-bs5-2.0.8.tgz",
-      "integrity": "sha512-rpz/yO2NZMP1Uso/sSsaFAKwdCjYPa1/KLxAVr0JNJJV9ygFLHcuKTcNmoc1cekcsjYcGyybWKaNu4NfpZ74vg==",
+      "version": "2.2.2",
+      "resolved": "https://registry.npmjs.org/datatables.net-bs5/-/datatables.net-bs5-2.2.2.tgz",
+      "integrity": "sha512-0mAbpUf0EpnIEc0RlN6vSrSk9y/+NuReiwDpjHYY3RfzdvH6Lt0+7Q9OU5RIbYxaFxES/z60thxdrw7IUFnBhw==",
       "dependencies": {
-        "datatables.net": "2.0.8",
+        "datatables.net": "2.2.2",
         "jquery": ">=1.7"
       }
     },
     "node_modules/datatables.net-buttons": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/datatables.net-buttons/-/datatables.net-buttons-3.0.2.tgz",
-      "integrity": "sha512-J+vk4hLtTivnl+RxzpKPE7CG4ggdgHPQcHnpqViy9w6ia18Uh69dQktX6NJ87QrqNPCTMUyHDzUzsRFURG4/Fw==",
+      "version": "3.2.2",
+      "resolved": "https://registry.npmjs.org/datatables.net-buttons/-/datatables.net-buttons-3.2.2.tgz",
+      "integrity": "sha512-+aLTbkbksNmyGpK+8KXbpwYKXYOXvZQR2ySA/8oOQeJU53Xw/67cOHowenEr2d43/RLaz+I0zvV/1Yn+jMRiDw==",
       "dependencies": {
         "datatables.net": "^2",
         "jquery": ">=1.7"
       }
     },
     "node_modules/datatables.net-buttons-bs5": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/datatables.net-buttons-bs5/-/datatables.net-buttons-bs5-3.0.2.tgz",
-      "integrity": "sha512-whufHsfKgzzdmTqM7JnFUph5hveHTCAvs9N0CP+5t7k7sIr7b94rIxv22/2Wt4veLcd3v73NdhPWl4j/GfzyhA==",
+      "version": "3.2.2",
+      "resolved": "https://registry.npmjs.org/datatables.net-buttons-bs5/-/datatables.net-buttons-bs5-3.2.2.tgz",
+      "integrity": "sha512-xjUcbYCBHcUthD1pvo5ghTNjqE6fTMygRrKd0QjBHKQxcqxmHG/m0djD2s6cFBfm8oov132U7U2JCXgQifOoUA==",
       "dependencies": {
         "datatables.net-bs5": "^2",
-        "datatables.net-buttons": "3.0.2",
+        "datatables.net-buttons": "3.2.2",
         "jquery": ">=1.7"
       }
     },

data/spec/node_spec.rb

@@ -66,9 +66,9 @@ describe Oxidized::API::WebApp do
     end
 
     # Don't know if this feature is used by anyone...
-    it 'attaches author/email/message to the commit when using put and json' do
+    it 'attaches user/email/message to the commit when using put and json' do
       data = {
-        'author' => 'me',
+        'user' => 'me',
         'email' => 'me@example.com',
         'message' => 'minitest, rack/test & mock simply rock',
         'from' => 'unused variable!'
@@ -83,7 +83,7 @@ describe Oxidized::API::WebApp do
 
     it 'attaches data to the commit when using a group and put, then redirects' do
       data = {
-        'author' => 'me',
+        'user' => 'me',
         'email' => 'me@example.com',
         'message' => 'minitest, rack/test & mock simply rock',
         'from' => 'unused variable!'
@@ -96,48 +96,4 @@ describe Oxidized::API::WebApp do
       _(last_response.location).must_equal 'http://example.org/nodes'
     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 sw42')
-
-      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 sw42')).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 sw42')
-
-      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 sw42')).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/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/spec_helper.rb

@@ -1,6 +1,9 @@
 # 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'