tng-gtk-utils 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06432f9bb54220cd63a3edb58ac8d8d297ed8efbe5cc2cd38e38d25f8221a6a1
-  data.tar.gz: 570751a38e231e9717579bcfe7fb70a01282744d3ef60922e7312dc6c7697839
+  metadata.gz: c0e290048720e0757b10dfc4db1d2634eee413962757f410db71000cac302ee9
+  data.tar.gz: 86567f1d1136aeeaefd81411e7d0b4bd6233f67d6775c0768dbded76086dd0b0
 SHA512:
-  metadata.gz: faa209d904dfa9cc449ec0f7a1740200f9e0279e42bc8ced8f44acdaa21c5c2ed35734b060e0472d5ca7e6ee37032f01fd6a5ac09b23d451c48eb52aacae04a1
-  data.tar.gz: 64b48f6d6f41dc44ce799e929a1f1adc1484dfaee48b1b87816ae4b6c254e022dd9b471eacbb161efe16fabb4368f68fca7f5eab1cd698e576fd73c854d7a587
+  metadata.gz: 6bb18b7732f2915afac16dbedd850139795447e63933da2929121fd7661b53fe679a4a5cb41e3ce819b52fea4713972daf9209a92b358450f8f45b80c0761af2
+  data.tar.gz: 881e2543e51d3481a35d0f4750c776e23d1d9718cbf682565733509439cf80d16d35a756837926cfae71174333c1289c82b0d6a4754e7e0675ef8a26e8af3704

data/.gitignore

@@ -48,3 +48,8 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.rspec_status
+cleanup.sh
+push.sh
+

data/README.md

@@ -13,21 +13,31 @@ For details on the overall 5GTANGO architecture please check [here](https://5gta
 This library implements some of the features that were being duplicated in the 5GTANGO Gatekeeper repositories mentioned above, [`tng-gtk-common`](https://github.com/sonata-nfv/tng-gtk-common), [`tng-gtk-sp`](https://github.com/sonata-nfv/tng-gtk-sp) and [`tng-gtk-vnv`](https://github.com/sonata-nfv/tng-gtk-vnv).
 
 ### Logger
-Ruby's standard library already provides a [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html), which we want to extend and make it providing outputs such as the following (in JSON format):
+Ruby's standard library already provides a [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html), which we want to extend and make it providing outputs such as the following (in JSON format -- see [this user story](https://git.cs.upb.de/5gtango/UserStories/issues/376), authentication is needed):
 
 ```json
 {
   "type": "I",
   "timestamp": "2018-10-18 15:49:08 UTC",
-  "status": "END",
+  "start_stop": "STOP",
   "component": "tng-api-gtw",
   "operation": "package upload",
-  "result": "package uploaded 201",
-  "status_code": "201",
+  "message": "package uploaded 201",
+  "status": "201",
   "time_elapsed": "00:01:20"
 }
 ```
-The usual approach of redefining the formatter (see below) doesn't have the full flexibility. 
+These fields have the following meanings/values:
+* `type`: **mandatory**, can be `I`(nfo), `W`(arning), `D`(ebug), `E`(rror), `F`(atal) or `U`(nknown);
+* `timestamp`: **mandatory**, it's the timestamp of the logged message, in UTC format;
+* `start_stop`: optional (can be empty), `START` or `STOP`
+* `component`: **mandatory**, holds the name of the component logging the message;
+* `operation`: **mandatory**, holds the operation logging the message;
+* `message`: **mandatory**, the message to be logged;
+* `status`: optional, makes sense for `start_stop='STOP'`, e.g., to hold the HTTP status;
+* `time_elapsed`: optional, makes sense for `start_stop='STOP'`, to hold the time the operation took to complete.
+
+The usual approach of redefining the formatter in the `Logger` standard library (see below) doesn't have the full flexibility we need: 
 
 ```ruby
 Logger.new(logdev, formatter: proc {|severity, datetime, progname, msg|
@@ -35,13 +45,30 @@ Logger.new(logdev, formatter: proc {|severity, datetime, progname, msg|
 })
 ```
 
-It should also support a `LOGLEVEL` variable that may assume one of the usual values `debug`, `info`, `warning`, `error`, `fatal` or `unknown` (defaults to `warning`, so only logging messages marked as `unknown`, `fatal`, `error` or `warning` are shown).
+It should also support a `LOGLEVEL` variable that may assume one of the usual values `debug`, `info`, `warning`, `error`, `fatal` or `unknown` (defaults to `info`, so only logging messages marked as `unknown`, `fatal`, `error`, `warning` or `info` are shown -- see [this user story](https://git.cs.upb.de/5gtango/UserStories/issues/410)).
+
+This output is achieved by calling methods such as `Logger.debug(...)`, with the minimum number of mandatory fields.
 
 #### Example
+An example of using the above described logger is the following:
 ```ruby
+LOG_COMPONENT=self.name
+LOGGER=Tng::Gtk::Utils::Logger
+...
+LOGGER.error(component: LOG_COMPONENT, operation:__method__.to_s, message:"key :uuid is missing in record #{record}") 
+```
+
+For example, if the `time_elapsed` field is to be filled, we can do the following:
+```ruby
+began_at = Time.now.utc
+do_some_lengthy_processing()
+LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"Done!", time_elapsed: Time.now.utc-began_at) 
 ```
 
 #### Dependencies
+The `Tng::Gtk::Utils::Logger` class depends on the following ruby gems:
+
+* `json`;
 
 ### Cache
 The first ...

data/lib/tng/gtk/utils/cache.rb

@@ -66,39 +66,37 @@ module Tng
 
       class Cache
         CACHE_PREFIX='cache'
-        LOG_COMPONENT='Tng::Gtk::Utils::Cache'
+        LOG_COMPONENT=self.name
+        LOGGER=Tng::Gtk::Utils::Logger
         STRATEGIES = {
           redis: RedisCache,
           memory: MemoryCache
         }
         class << self; attr_accessor :strategy; end
 
-        #def strategy=(value) self.class.strategy = value end
-        #def strategy() self.class.strategy end
-
         self.strategy = ENV['REDIS_URL'] ? STRATEGIES[:redis] : STRATEGIES[:memory]
-        Tng::Gtk::Utils::Logger.info(start_stop: 'START', component:'Tng::Gtk::Utils::Cache', operation:'class definition', message:"Strategy used: #{self.strategy}") 
+        LOGGER.info(start_stop: 'START', component:LOG_COMPONENT, operation:'class definition', message:"Strategy used: #{self.strategy}") 
 
         def self.cache(record)
           unless record.key?(:uuid)
-            Tng::Gtk::Utils::Logger.error(component: LOG_COMPONENT, operation:'.cache', message:"Cache key :uuid is missing in record #{record}") 
+            LOGGER.error(component: LOG_COMPONENT, operation:__method__.to_s, message:"key :uuid is missing in record #{record}") 
             return nil
           end
-          Tng::Gtk::Utils::Logger.info(component: LOG_COMPONENT, operation:'.cache', message:"Cache key '#{CACHE_PREFIX}:#{record[:uuid]}' with value '#{record}' (strategy #{self.strategy})") 
+          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{CACHE_PREFIX}:#{record[:uuid]}' with value '#{record}' (strategy #{self.strategy})") 
           self.strategy.set("#{CACHE_PREFIX}:#{record[:uuid]}", record.to_json)
           record
         end
         def self.cached?(key)
-          Tng::Gtk::Utils::Logger.info(component: LOG_COMPONENT, operation:'.cached?', message:"Cached? key '#{CACHE_PREFIX}:#{key}' (strategy #{self.strategy})")
+          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{CACHE_PREFIX}:#{key}' (strategy #{self.strategy})")
           data = self.strategy.get("#{CACHE_PREFIX}:#{key}")
           return '' if data.nil?
           JSON.parse(data, symbolize_names: :true) 
         end
         def self.clear(key)
-          Tng::Gtk::Utils::Logger.info(component: LOG_COMPONENT, operation:'.clear', message:"Clearing key '#{key}' (strategy #{self.strategy})")
+          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{key}' (strategy #{self.strategy})")
           self.strategy.del(key)
         end
-        Tng::Gtk::Utils::Logger.info(start_stop: 'STOP', component:'Tng::Gtk::Utils::Cache', operation:'class definition', message:"Strategy used: #{self.strategy}") 
+        LOGGER.info(start_stop: 'STOP', component:LOG_COMPONENT, operation:'class definition', message:"Strategy used: #{self.strategy}") 
       end
     end
   end

data/lib/tng/gtk/utils/fetch.rb

@@ -34,6 +34,7 @@
 require 'net/http'
 require 'json'
 require 'redis'
+require 'tng/gtk/utils/logger'
 require 'tng/gtk/utils/cache'
 
 module Tng
@@ -41,22 +42,21 @@ module Tng
     module Utils
 
       class Fetch
-        NO_CACHE=ENV.fetch('NO_CACHE', nil)
         
         class << self; attr_accessor :site; end
-
-        #def site=(value) self.class.site = value end
-        #def site() self.class.site end
   
         def self.call(params)
           msg=self.name+'#'+__method__.to_s
-          STDERR.puts "#{msg}: params=#{params} site=#{self.site}"
+          began_at=Time.now.utc
+          Tng::Gtk::Utils::Logger.info(start_stop: 'START', component:self.name, operation:__method__.to_s, message:"params=#{params} site=#{self.site}")
           original_params = params.dup
           begin
             if params.key?(:uuid)
-              unless NO_CACHE
+              no_cache=ENV.fetch('NO_CACHE', nil)
+              
+              unless no_cache
                 cached = Tng::Gtk::Utils::Cache.cached?(params[:uuid])
-                return cached if cached
+                return cached unless (cached.nil? || cached.empty?)
               end
               uuid = params.delete :uuid
               uri = URI.parse("#{self.site}/#{uuid}")
@@ -65,28 +65,29 @@ module Tng
               uri = URI.parse(self.site)
               uri.query = URI.encode_www_form(sanitize(params))
             end
-            STDERR.puts "#{msg}: uri=#{uri}"
+            Tng::Gtk::Utils::Logger.debug(component:self.name, operation:__method__.to_s, message:"uri=#{uri}")
             request = Net::HTTP::Get.new(uri)
             request['content-type'] = 'application/json'
             response = Net::HTTP.start(uri.hostname, uri.port) {|http| http.request(request)}
-            STDERR.puts "#{msg}: response=#{response.inspect}"
+            Tng::Gtk::Utils::Logger.debug(component:self.name, operation:__method__.to_s, message:"response=#{response.inspect}")
             case response
             when Net::HTTPSuccess
               body = response.read_body
-              STDERR.puts "#{msg}: 200 (Ok) body=#{body}"
+              Tng::Gtk::Utils::Logger.debug(component:self.name, operation:__method__.to_s, message:"body=#{body}", status: '200')
               result = JSON.parse(body, quirks_mode: true, symbolize_names: true)
               cache_result(result)
+              Tng::Gtk::Utils::Logger.info(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"result=#{result} site=#{self.site}", time_elapsed: Time.now.utc - began_at)
               return result
             when Net::HTTPNotFound
-              STDERR.puts "#{msg}: 404 Not found body=#{body}"
+              Tng::Gtk::Utils::Logger.info(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"body=#{body}", status:'404', time_elapsed: Time.now.utc - began_at)
               return {} unless uuid.nil?
               return []
             else
-              STDERR.puts "#{msg}: #{response.message}"
+              Tng::Gtk::Utils::Logger.error(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"#{response.message}", status:'404', time_elapsed: Time.now.utc - began_at)
               return nil
             end
           rescue Exception => e
-            STDERR.puts "E, #{Time.now.utc} #{msg}: #{e.message}"
+            Tng::Gtk::Utils::Logger.error(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"#{e.message}", time_elapsed: Time.now.utc - began_at)
           end
           nil
         end
@@ -99,14 +100,16 @@ module Tng
         end
   
         def self.cache_result(result)
-          msg=self.name+'#'+__method__.to_s
-          STDERR.puts "#{msg} result=#{result})"
+          Tng::Gtk::Utils::Logger.debug(component:self.name, operation:__method__.to_s, message:"result=#{result}")
           if result.is_a?(Hash)      
+            STDERR.puts "Caching #{result}"
             Tng::Gtk::Utils::Cache.cache(result)
             return
           end
+          STDERR.puts "#{result} is not an Hash"
           result.each do |record|
-            Tng::Gtk::Utils::Cache.cache(ecord)
+            STDERR.puts "Caching #{record}"
+            Tng::Gtk::Utils::Cache.cache(record)
           end
         end
       end

data/lib/tng/gtk/utils/logger.rb

@@ -32,7 +32,6 @@
 # encoding: utf-8
 # frozen_string_literal: true
 require 'json'
-require 'logger'
 
 module Tng
   module Gtk
@@ -44,28 +43,28 @@ module Tng
         LOGGER_LEVELS = ['D', 'I', 'W', 'E', 'F', 'U'].freeze
         
         class << self
-          def error(start_stop: '', component:, operation:, message:, status: , time_elapsed:)
-            generic(type: 'E', start_stop: start_stop, component:component, operation: operation, message:message, status: status, time_elapsed:time_elapsed)
+          def error(start_stop: '', component:, operation:, message:, status:'', time_elapsed:'')
+            generic(type: 'E', start_stop: start_stop, component: component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
-          def warning(start_stop: '', component:, operation: , message:, status: , time_elapsed:)
-            generic(type: 'W', start_stop: start_stop, component:component, operation:operation, message:message, status:status, time_elapsed:time_elapsed)
+          def warning(start_stop: '', component:, operation: , message:, status:'', time_elapsed:'')
+            generic(type: 'W', start_stop: start_stop, component: component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
-          def info(start_stop: '', component:, operation: , message:, status: , time_elapsed:)
-            generic(type: 'I', start_stop: start_stop, component:component, operation:operation, message:message, status:status, time_elapsed:time_elapsed)
+          def info(start_stop: '', component:, operation:, message:, status:'', time_elapsed:'')
+            generic(type: 'I', start_stop: start_stop, component: component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
-          def fatal(start_stop: '', component:, operation: , message:, status: , time_elapsed:)
-            generic(type: 'F', start_stop: start_stop, component:component, operation:operation, message:message, status:status, time_elapsed:time_elapsed)
+          def fatal(start_stop: '', component:, operation: , message:, status:'', time_elapsed:'')
+            generic(type: 'F', start_stop: start_stop, component: component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
           def debug(start_stop: '', component:, operation:, message:, status:'', time_elapsed:'')
-            generic(type: 'D', start_stop: start_stop, component:component, operation:operation, message:message, status:status, time_elapsed:time_elapsed)
+            generic(type: 'D', start_stop: start_stop, component: component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
-          def unknown(start_stop: '', component:, operation: , message:, status: , time_elapsed:)
-            generic(type: 'U', start_stop: start_stop, component: component, operation:operation, message: message, status:status, time_elapsed: time_elapsed)
+          def unknown(start_stop: '', component:, operation: , message:, status:'', time_elapsed:'')
+            generic(type: 'U', start_stop: start_stop, component:  component, operation: operation, message: message, status: status, time_elapsed: time_elapsed)
           end
             
           private
           def generic(type:, start_stop:, component:, operation:, message:, status:, time_elapsed:) 
-            LOGFILE.puts "#{{
+            message = {
               type: type,                 # mandatory, can be I(nfo), W(arning), D(ebug), E(rror), F(atal) or U(nknown)
               timestamp: Time.now.utc, # mandatory
               start_stop: start_stop,                    # optional, can be empty, 'START' or 'STOP'
@@ -74,11 +73,13 @@ module Tng
               message: message,      # mandatory
               status: status,                        # optional, makes sense for start_stop='END'
               time_elapsed: time_elapsed              # optional, makes sense for start_stop='END'
-            }.to_json}" if logger_level(type) < LOGLEVEL
+            }
+            LOGFILE.puts "#{message.to_json}" if log?(type)
+            message
           end
           
-          def logger_level(level)
-            LOGGER_LEVELS.find_index(LOGGER_LEVELS[level])
+          def log?(level)
+            LOGGER_LEVELS.index(level) >= LOGGER_LEVELS.index(LOGLEVEL[0].upcase)
           end
         end
       end

data/lib/tng/gtk/utils/version.rb

@@ -1,7 +1,7 @@
 module Tng
   module Gtk
     module Utils
-      VERSION = "0.2.1"
+      VERSION = "0.2.3"
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "bundler/setup"
 require "tng/gtk/utils"
+require 'webmock/rspec'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -12,3 +13,4 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
+WebMock.disable_net_connect!() #allow_localhost: true)

data/spec/tng/gtk/utils/fetch_spec.rb

@@ -33,15 +33,33 @@
 # frozen_string_literal: true
 require_relative '../../../spec_helper'
 require 'tng/gtk/utils/fetch'
+require 'securerandom'
 
 RSpec.describe Tng::Gtk::Utils::Fetch do
-  context 'with UUID' do
-    let(:data) {{uuid: SecureRandom.uuid, whatever: 'else'}}
-    it 'should cache passed data' do
-      cache
+  let(:data) {{uuid: SecureRandom.uuid, whatever: 'else'}}
+  context 'with NO_CACHE' do
+    it 'should fetch requested data' do
+      allow(ENV).to receive(:[]).with("NO_CACHE").and_return("true")
+      Tng::Gtk::Utils::Fetch.site='http://example.com'
+      WebMock.stub_request(:get, Tng::Gtk::Utils::Fetch.site+'/'+data[:uuid]).to_return(body: data.to_json, status: 200)
+      expect(Tng::Gtk::Utils::Fetch.call({uuid: data[:uuid]})).to eq(data)
     end
   end
-  context 'without UUID' do
-    it 'should not cache passed data'
+  context 'without NO_CACHE' do
+    before(:each){allow(ENV).to receive(:[]).with("NO_CACHE").and_return("")}
+    it 'should cache passed data the first time' do
+      allow(Tng::Gtk::Utils::Cache).to receive(:cached?).with(data[:uuid]).and_return('')
+      allow(Tng::Gtk::Utils::Cache).to receive(:cache).with(data).and_return(data)
+      Tng::Gtk::Utils::Fetch.site='http://example.com'
+      WebMock.stub_request(:get, Tng::Gtk::Utils::Fetch.site+'/'+data[:uuid]).to_return(body: data.to_json, status: 200)
+      Tng::Gtk::Utils::Fetch.call({uuid: data[:uuid]})
+      expect(Tng::Gtk::Utils::Cache).to have_received(:cache).with(data)
+    end
+    it 'should fetch from cache passed data the next time' do
+      allow(Tng::Gtk::Utils::Cache).to receive(:cached?).with(data[:uuid]).and_return(data)
+      allow(Tng::Gtk::Utils::Cache).to receive(:cache).with(data).and_return(data)
+      Tng::Gtk::Utils::Fetch.call({uuid: data[:uuid]})
+      expect(Tng::Gtk::Utils::Cache).not_to have_received(:cache).with(data)
+    end
   end
 end

data/spec/tng/gtk/utils/logger_spec.rb

@@ -32,7 +32,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 require_relative '../../../spec_helper'
-require 'tng/gtk/utils/logget'
+require 'tng/gtk/utils/logger'
 
 RSpec.describe Tng::Gtk::Utils::Logger do
     it 'should cache passed data' do

data/tng-gtk-utils.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", '~> 0.12.0'
+  spec.add_development_dependency "webmock", '~> 3.1.1'
   
   spec.add_dependency 'redis', '~> 4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tng-gtk-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - José Bonnet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement