oxidized-web 0.13.1 → 0.14.0

data/docs/development.md

@@ -0,0 +1,170 @@
+# Index
+1. [Run from git](#how-to-run--develop-oxidized-web-from-git)
+2. [Update weblibs](#update-the-weblibs)
+3. [Release](#how-to-release-a-new-version-of-oxidized-web)
+
+# How to run / develop oxidized-web from git
+## Using the latest oxidized package
+When you develop oxidized-web, it is quite simple to run it from git. As it depends on oxidized,
+oxidized will be included in `bundle install`, and you just have to run `bundle exec oxidized`.
+You need bundler, if not installed yet. On debian-based systems, you can run `sudo apt install ruby-bundler` to install it.
+
+All steps in one to copy & pase:
+```shell
+git clone git@github.com:ytti/oxidized-web.git
+cd oxidized-web
+bundle config set --local path 'vendor/bundle'
+bundle install
+bundle exec oxidized
+```
+
+Changes to haml templates are reloaded on the fly. For changes to the ruby
+scripts, you have to stop an restart `bundle exec oxidized`.
+
+## Paralell development between oxidized and oxidized-web
+You may need to make some changes in oxidized **and** oxidized-web. For this,
+git clone oxidized and oxidized-web in a common root directory, add the direct
+dependency to ../oxidized-web in oxidized and run oxidized from the oxidized
+repo:
+
+```shell
+git clone git@github.com:ytti/oxidized-web.git
+git clone git@github.com:ytti/oxidized.git
+cd oxidized
+bundle config set --local path 'vendor/bundle'
+echo "gem 'oxidized-web', path: '../oxidized-web'" >> Gemfile
+bundle install
+bundle exec bin/oxidized
+```
+
+Be careful when commiting your work in oxidized *NOT* to include the changes to
+Gemfile, as this is a local change for development. I (@robertcheramy) didn't
+find a better way to do this, better ideas are welcome :-)
+
+If your changes to oxidized **AND** oxidzed-web are dependent from another, make
+sure you document this in the respectives CHANGELOG.md, so that everyone is
+informed at the next release.
+
+# Update the weblibs
+The weblibs are beeing downloaded and maintained by `npm`.
+
+Run `npm install` to download the weblibs. They will be stored under
+`node_modules`.
+The file `package-lock.json` (wich is tracked in git) ensures that every
+developer gets the same versions.
+
+Run `npm outdated` to get a list of new releases:
+
+```shell
+oxidized-web$ npm outdated
+Package             Current  Wanted  Latest  Location                         Depended by
+datatables.net-bs5    2.0.7   2.0.8   2.0.8  node_modules/datatables.net-bs5  oxidized-web
+```
+
+Run `npm update` to get the latest releases. They still are not used
+oxidzed-web. Run `rake weblibs` to sync `node_modules` with
+`lib/oxidized/web/public/weblibs`.
+
+Test, and commit the changes to the weblibs **and** package-lock.json. Don't
+forget to document your changes in CHANGELOG.md.
+
+# How to release a new version of Oxidized-web?
+
+## Review changes
+Run `git diff 0.xx.yy..master` (where `0.xx.yy` is to be changed to the last
+release) and review all the changes that have been done. Have a specific look
+at changes you don't understand.
+
+It is nicer to read in a GUI, so you can use something like
+`git difftool --tool=kdiff3 -d 0.xx.yy..master` to see it in kdiff3.
+
+## Update the gem dependencies to the latest versions
+```
+bundle outaded
+bundle update
+bundle outaded
+```
+
+Retest after updating!
+
+## Update the weblibs to the latest versions
+```
+npm outdated
+```
+
+Retest after updating!
+
+## Update rubocup .rubocop_todo.yml
+Run `bundle exec rubocop --auto-gen-config`,
+and make sure `bundle exec rake` passes after it.
+
+If you change some code => Restart the release process at the beginning ;-)
+
+## Make sure the file permissions are correct
+Run `bundle exec rake chmod`
+
+## Test, test test!
+Run `bundle exec rake` on the git repository to check the code against rubocop and rund the
+defined tests in `/spec`.
+
+Run Oxidized-web from git against the latest Oxidized version `bundle exec oxdized`
+
+Run Oxidized-web from git against the latest git of Oxidized (see above).
+
+Do not integrate late PRs into master if they do not fix issues for the release. The must wait for the next release.
+
+## Version numbering
+Oxidized-web versions are nummered like 0.major.minor
+- major is incremented when releasing new features. minor is then set to 0
+- minor is incremented when releasing fixes only, just after a major version.
+
+## Release
+1. Checkout the master branch of oxidized-web. Make sure you are up to date with origin.
+2. Change the version in lib/oxidized/web/version.rb
+3. Change CHANGELOG.md to replace [Unreleased] with [0.xx.yy – 202Y-MM-DD]
+4. Run `git diff` to check your changes
+5. Commit the changes to the local git repository with a commit message “chore(release): release version 0.xx.yy”
+6. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
+7. Build the gem with ‘rake build’
+8. Install an test the gem locally:
+```
+gem install --user-install pkg/oxidized-web-0.xx.yy.gem
+~/.local/share/gem/ruby/3.1.0/bin/oxidized
+```
+## Release in github
+1. Push the commit and the tag to github:
+```
+git push
+git push origin 0.xx.yy
+```
+
+2. Make a release from the tag in github
+- Thank the contributors
+- Only describe major changes, and refer to CHANGELOG.md
+- List new contributors (generated automatically)
+
+## Release in rubygems
+Push the gem with ‘rake push’
+
+You need an account at rubygems which is allowed to push oxidized
+
+## Release in docker.io
+The OCI-Containter is automatically build and pushed to docker.io by github
+
+## Update CHANGELOG.md for next release
+Add
+```
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+```
+And push to github
+
+## Congratulate yourself
+Great job! Treat yourself to your favorite drink, you deserve it!
+

data/lib/oxidized/web/mig.rb

@@ -9,7 +9,7 @@ module Oxidized
 
       # read cloginrc and return a hash with node name, which a hash value which contains user,
       # password, eventually enable
-      def cloginrc clogin_file
+      def cloginrc(clogin_file)
         close_file = clogin_file
         file = close_file.read
         file = file.gsub('add', '')
@@ -17,24 +17,20 @@ module Oxidized
         hash = {}
         file.each_line do |line|
           # stock all device name, and password and enable if there is one
-          line = line.split(' ')
-          for i in 0..line.length
+          line = line.split
+          (0..line.length).each do |i|
             if line[i] == 'user'
               # add the equipment and user if not exist
-              unless hash[line[i + 1]]
-                hash[line[i + 1]] = { user: line[i + 2] }
-              end
+              hash[line[i + 1]] = { user: line[i + 2] } unless hash[line[i + 1]]
             # if the equipment exist, add password and enable password
             elsif line[i] == 'password'
               if hash[line[i + 1]]
                 if line.length > i + 2
                   h = hash[line[i + 1]]
                   h[:password] = line[i + 2]
-                  if /\s*/.match(line[i + 3])
-                    h[:enable] = line[i + 3]
-                  end
+                  h[:enable] = line[i + 3] if /\s*/.match(line[i + 3])
                   hash[line[i + 1]] = h
-                elsif line.length = i + 2
+                elsif line.length == i + 2
                   h = hash[line[i + 1]]
                   h[:password] = line[i + 2]
                   hash[line[i + 1]] = h
@@ -47,17 +43,15 @@ module Oxidized
         hash
       end
 
-      def model_dico model
+      def model_dico(model)
         dico = { 'cisco' => 'ios', 'foundry' => 'ironware' }
         model = model.gsub("\n", '')
-        if dico[model]
-          model = dico[model]
-        end
+        model = dico[model] if dico[model]
         model
       end
 
       # add node and group for an equipment (take a list of router.db)
-      def rancid_group router_db_list
+      def rancid_group(router_db_list)
         model = {}
         hash = cloginrc @cloginrc
         router_db_list.each do |router_db|
@@ -70,20 +64,20 @@ module Oxidized
           file.each_line do |line|
             line = line.split(':')
             node = line[0]
-            if hash[node]
-              h = hash[node]
-              model = model_dico line[1].to_s
-              h[:model] = model
-              h[:group] = group
-            end
+            next unless hash[node]
+
+            h = hash[node]
+            model = model_dico line[1].to_s
+            h[:model] = model
+            h[:group] = group
           end
           file_close.close
         end
         hash
       end
-      
+
       # write a router.db conf, need the hash and the path of the file we whish create
-      def write_router_db hash
+      def write_router_db(hash)
         router_db = File.new(@path_new_router, 'w')
         hash.each do |key, value|
           line = key.to_s
@@ -91,15 +85,13 @@ module Oxidized
           line += ":#{value[:user]}"
           line += ":#{value[:password]}"
           line += ":#{value[:group]}"
-          if value[:enable]
-            line += ":#{value[:enable]}"
-          end
+          line += ":#{value[:enable]}" if value[:enable]
           router_db.puts(line)
         end
         router_db.close
       end
 
-      def edit_conf_file path_conf, router_db_path
+      def edit_conf_file(path_conf, router_db_path)
         file_close = File.open(path_conf, 'r')
         file = file_close
         file = file.read
@@ -107,29 +99,27 @@ module Oxidized
         new_file = []
         file.each_line do |line|
           if source_reached
-            unless /^\w/.match(line)
-              next
-            end
+            next unless /^\w/.match(line)
 
             source_reached = false
           end
           new_file.push(line)
-          if /source:/.match(line)
-            source_reached = true
-            new_file.push("  default: csv\n")
-            new_file.push("  csv:\n")
-            new_file.push("    file: #{router_db_path}\n")
-            new_file.push("    delimiter: !ruby/regexp /:/\n")
-            new_file.push("    map:\n")
-            new_file.push("      name: 0\n")
-            new_file.push("      model: 1\n")
-            new_file.push("      username: 2\n")
-            new_file.push("      password: 3\n")
-            new_file.push("      group: 4\n")
-            new_file.push("    vars_map:\n")
-            new_file.push("      enable: 5\n")
-            next
-          end
+          next unless /source:/.match(line)
+
+          source_reached = true
+          new_file.push("  default: csv\n")
+          new_file.push("  csv:\n")
+          new_file.push("    file: #{router_db_path}\n")
+          new_file.push("    delimiter: !ruby/regexp /:/\n")
+          new_file.push("    map:\n")
+          new_file.push("      name: 0\n")
+          new_file.push("      model: 1\n")
+          new_file.push("      username: 2\n")
+          new_file.push("      password: 3\n")
+          new_file.push("      group: 4\n")
+          new_file.push("    vars_map:\n")
+          new_file.push("      enable: 5\n")
+          next
         end
         file_close.close
 
@@ -143,7 +133,7 @@ module Oxidized
       def go_rancid_migration
         hash = rancid_group @hash_router_db
         write_router_db hash
-        edit_conf_file "#{ENV['HOME']}/.config/oxidized/config", @path_new_router
+        edit_conf_file "#{Dir.home}/.config/oxidized/config", @path_new_router
       end
     end
   end

data/lib/oxidized/web/public/css/oxidized.css

@@ -0,0 +1,59 @@
+/* Display status of device in /nodes and /stats */
+.status, .success, .no_connection, .never {
+  float: right;
+  width: 15px;
+  height: 15px;
+  border: 1px solid;
+  margin-right: 70%;
+  margin-bottom: 0px;
+  border-radius: 2px; }
+
+.success {
+  background-color: #64FE2E; }
+
+.no_connection {
+  background-color: #FF0000; }
+
+.never {
+  background-color: #58ACFA; }
+
+/* node/version/diffs */
+.added {
+  background-color: #DBFFDB; }
+
+.deleted {
+  background-color: #FFDDDD; }
+
+
+.diff-index {
+  background-color: #FFFF99; }
+
+.diff-empty {
+  background-color: #F0F0F0; }
+
+.diffs, .diffs_old, .diffs_new {
+  background-color: #FAFAFA;
+  border: 2px solid #ccc;
+  border-radius: 5px;
+  padding: 3px;
+  font-family: Consolas, "Lucida Console", monospace;
+  white-space: pre; }
+
+.diffs_old {
+  float: left;
+  width: 49%;
+  overflow: auto; }
+
+.diffs_new {
+  margin-left: 51%;
+  width: 49%;
+  overflow: auto; }
+
+.old_version_title {
+  float: left;
+  width: 49%;
+  font-weight: bold; }
+
+.new_version_title {
+  margin-left: 51%;
+  font-weight: bold; }

data/lib/oxidized/web/public/scripts/oxidized.js

@@ -25,16 +25,6 @@ var onFileSelected = function() {
   });
 };
 
-// fix colvis buttons
-var fixColVisBtn = function() {
-  $('.ColVis_Button').each(function() {
-    $(this).addClass('btn btn-default');
-  });
-  $('.ColVis_MasterButton').each(function() {
-    $(this).addClass('pull-right');
-  });
-};
-
 var convertTime = function() {
   /* Convert UTC times to local browser times
   *  Requires that the times on the server are UTC
@@ -53,14 +43,13 @@ var convertTime = function() {
     var hour = ("0" + date.getHours()).slice(-2);
     var minute = ("0" + date.getMinutes()).slice(-2);
     var second = ("0" + date.getSeconds()).slice(-2);
-    var timeZone = date.toString().match(/\(.*\)/)[0].match(/[A-Z]/g).join('');
+    var timeZone = date.toString().match(/[A-Z]{3,4}[+-][0-9]{4}/)[0];
     $(this).text(year + '-' + month + '-' + day + ' ' + hour + ':' + minute + ':' + second + ' ' + timeZone);
   });
 };
 
 $(function() {
   onFileSelected();
-  fixColVisBtn();
   convertTime();
   // Add a row to the migration form
   $("#add").click(function() {