oxidized-web 0.13.1 → 0.14.0

data/spec/node_spec.rb

@@ -0,0 +1,143 @@
+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 author/email/message to the commit when using put and json' do
+      data = {
+        'author' => '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 = {
+        'author' => '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
+
+  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/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,8 @@
+# Needed to get the error output on the console and not in last_response.body
+ENV['APP_ENV'] = 'test'
+
+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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oxidized-web
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Saku Ytti
 - Samer Abdel-Hafez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: charlock_holmes
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -68,129 +68,149 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: oxidized
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: oxidized
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.4
+        version: '0.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.4
+        version: '0.26'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 6.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 6.5.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :runtime
+        version: '2.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
+        version: '5.18'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '5.18'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rails_best_practices
   requirement: !ruby/object:Gem::Requirement
@@ -211,28 +231,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 1.64.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.64.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 0.12.3
 description: puma+sinatra+haml webUI + REST API for oxidized
 email:
 - saku@ytti.fi
@@ -242,42 +346,46 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/ruby.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
+- docs/development.md
 - lib/oxidized/web.rb
 - lib/oxidized/web/mig.rb
-- lib/oxidized/web/public/css/bootstrap.min.css
-- lib/oxidized/web/public/css/buttons.bootstrap.min.css
-- lib/oxidized/web/public/css/dataTables.bootstrap.css
-- lib/oxidized/web/public/css/dataTables.colVis.css
-- lib/oxidized/web/public/css/oxidized_custom.css
-- lib/oxidized/web/public/fonts/glyphicons-halflings-regular.eot
-- lib/oxidized/web/public/fonts/glyphicons-halflings-regular.svg
-- lib/oxidized/web/public/fonts/glyphicons-halflings-regular.ttf
-- lib/oxidized/web/public/fonts/glyphicons-halflings-regular.woff
-- lib/oxidized/web/public/images/diff_15x17.png
+- lib/oxidized/web/public/css/oxidized.css
 - lib/oxidized/web/public/images/favicon.ico
 - lib/oxidized/web/public/images/oxidizing.png
 - lib/oxidized/web/public/images/oxidizing_40px.png
-- lib/oxidized/web/public/images/sort_asc.png
-- lib/oxidized/web/public/images/sort_asc_disabled.png
-- lib/oxidized/web/public/images/sort_both.png
-- lib/oxidized/web/public/images/sort_desc.png
-- lib/oxidized/web/public/images/sort_desc_disabled.png
-- lib/oxidized/web/public/images/versioning_18px.png
-- lib/oxidized/web/public/scripts/bootstrap.min.js
-- lib/oxidized/web/public/scripts/dataTables.bootstrap.js
-- lib/oxidized/web/public/scripts/dataTables.colVis.js
-- lib/oxidized/web/public/scripts/jquery-2.1.1.min.js
-- lib/oxidized/web/public/scripts/jquery.dataTables.min.js
-- lib/oxidized/web/public/scripts/jquery.min.js
 - lib/oxidized/web/public/scripts/oxidized.js
 - lib/oxidized/web/public/scripts/script-migration.js
+- lib/oxidized/web/public/weblibs/bootstrap-icons.css
+- lib/oxidized/web/public/weblibs/bootstrap.bundle.js
+- lib/oxidized/web/public/weblibs/bootstrap.bundle.js.map
+- lib/oxidized/web/public/weblibs/bootstrap.css
+- lib/oxidized/web/public/weblibs/bootstrap.css.map
+- lib/oxidized/web/public/weblibs/bootstrap.js
+- lib/oxidized/web/public/weblibs/bootstrap.js.map
+- lib/oxidized/web/public/weblibs/buttons.bootstrap5.css
+- lib/oxidized/web/public/weblibs/buttons.bootstrap5.js
+- lib/oxidized/web/public/weblibs/buttons.colVis.js
+- lib/oxidized/web/public/weblibs/dataTables.bootstrap5.css
+- lib/oxidized/web/public/weblibs/dataTables.bootstrap5.js
+- lib/oxidized/web/public/weblibs/dataTables.buttons.js
+- lib/oxidized/web/public/weblibs/dataTables.js
+- lib/oxidized/web/public/weblibs/fonts/bootstrap-icons.woff
+- lib/oxidized/web/public/weblibs/fonts/bootstrap-icons.woff2
+- lib/oxidized/web/public/weblibs/jquery.js
+- lib/oxidized/web/version.rb
 - lib/oxidized/web/views/conf_search.haml
 - lib/oxidized/web/views/diffs.haml
 - lib/oxidized/web/views/footer.haml
@@ -286,17 +394,23 @@ files:
 - lib/oxidized/web/views/migration.haml
 - lib/oxidized/web/views/node.haml
 - lib/oxidized/web/views/nodes.haml
-- lib/oxidized/web/views/sass/oxidized.sass
 - lib/oxidized/web/views/stats.haml
 - lib/oxidized/web/views/version.haml
 - lib/oxidized/web/views/versions.haml
 - lib/oxidized/web/webapp.rb
 - oxidized-web.gemspec
+- package-lock.json
+- package.json
+- spec/node_spec.rb
+- spec/root_spec.rb
+- spec/spec_helper.rb
+- spec/webapp_spec.rb
 homepage: http://github.com/ytti/oxidized-web
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,15 +418,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: sinatra API + webUI for oxidized
 test_files: []