nxgreport 0.10.0 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a070244e38842f494942ea189deba31e45360a50857946d17c11749ab10db465
-  data.tar.gz: f903e4695cffc3a15069340f563e2ed7930d1531139ff7a4b6219786e8452649
+  metadata.gz: 20f1a2f039923a59eab3e9bbe4004412a43bafb78c4a5f4ce51c8ba8d3115cac
+  data.tar.gz: 56d2dfc8399405c0d8522ad09a923da5f5fd1dfe595bbe464410119e987ec685
 SHA512:
-  metadata.gz: d65497235406123d769ac72f0f61b1a16ca565926911d34819ddcd8d5ea730f2363d969212e372613a9457d97a1649ed8711fc15c75ee0c619a1d34d804adec8
-  data.tar.gz: 8eb082850d2be42ef630e83e23a68e1058182ab26ee84f8738b17d8f8964b5e45de460ee05d905fe8e15bbde41f577348055457f5da00f416b2cf542064cdc17
+  metadata.gz: 718711f7ae9222e6d288cb284a96cd00ff79bf6d25997fe818cc56324a77959ccf5b63a1f9c8e1893b6db7aea4bee04ec828f824d2026daa64944791b649e59f
+  data.tar.gz: e79dd72fe1564a1cf6a91156077d778592d7a81b543ff6ec1524cd88897784d8e0df9c10c44cf87b7b202c1b2586f4240a9af298b8802e2799930d95857572a0

data/lib/nxgreport.rb

@@ -1,5 +1,5 @@
-
 require 'fileutils'
-require 'nxgcore.rb'
+require "nxgreport/version"
+require 'nxgreport/nxgcore.rb'
 
-$NxgReport = NxgCore.new().instance()
+$NxgReport = NxgCore.new().instance()

data/lib/nxgreport/nxgcore.rb

@@ -0,0 +1,217 @@
+require 'fileutils'
+require 'nxgreport/nxghtml.rb'
+
+class NxgCore
+    class NxgReport
+
+      include NxgHTML
+
+        def initialize(data_provider)
+          @data_provider = data_provider
+          @data_provider[:pass] = 0
+          @data_provider[:fail] = 0
+          @data_provider[:total] = 0
+          @data_provider[:open_on_completion] = false
+          @data_provider[:features] = Array.new()
+          @data_provider[:title] = ""
+          @data_provider[:report_path] = ""
+          @start_time = Time.now.to_f
+          @test_start_time = Time.now.to_f
+        end
+
+        def setup(location: "./NxgReport.html", title: "$NxgReport")
+            @data_provider[:report_path] = location.empty? ? "./NxgReport.html" : location
+            @data_provider[:title] = title
+        end
+    
+        def open_upon_execution(value: true)
+          return if !value
+
+          @data_provider[:open_on_completion] = value
+        end
+    
+        def set_environment(name: "")
+          return if name.empty?() 
+          
+          @data_provider[:environment] = name
+        end
+    
+        def set_app_version(no: "")
+          return if no.empty?()
+            
+          version_no = no.downcase.gsub("app", "").gsub("version", "").strip
+          @data_provider[:app_version] = "App Version #{version_no}"
+        end
+    
+        def set_release(name: "")
+          return if name.empty?() 
+            
+          @data_provider[:release_name] = name
+        end
+    
+        def set_os(name: "")
+          return if name.empty?() 
+            
+          @data_provider[:os] = name
+        end
+    
+        def set_device(name: "")
+          return if name.empty?() 
+            
+          @data_provider[:device] = name
+        end
+    
+        def set_execution(date: "")
+          return if date.empty?() 
+            
+          @data_provider[:execution_date] = date
+        end
+
+        def set_execution_time()
+          time_diff_in_mins = 0
+          time_diff_in_secs = 0
+
+          @data_provider[:features].each do |feature|
+            feature["tests"].each do |test|
+              time_diff_in_secs += test["time"]
+            end
+          end
+
+          time_diff_in_mins = ((time_diff_in_secs)  / 60).to_i
+
+          if time_diff_in_mins >= 60
+            time_diff_in_hrs = (time_diff_in_mins / 60.to_f).round(2)
+            @data_provider[:execution_time] = "#{time_diff_in_hrs} #{time_diff_in_hrs == 1 ? "hour" : "hours"}"
+          else
+            @data_provider[:execution_time] = "#{time_diff_in_mins} mins"
+          end
+        end
+    
+        def log_test(feature_name: "", test_name:"", test_status: "", tag: "", comments: "", execution_time: 0)
+          if feature_name.nil?() || feature_name.strip.empty?()
+            log("Feature name cannot be empty.")
+            return
+          end
+  
+          if test_status.nil?() || test_status.strip.empty?()
+            log("Test status cannot be empty.")
+            return
+          end
+
+          if test_name.nil?() || test_name.strip.empty?()
+            log("Test name cannot be empty.")
+            return
+          end
+
+          f_name = feature_name.strip
+          t_name = test_name.strip
+          t_pass = test_status.strip.downcase.include?('pass') ? true : false
+          t_comments = comments.strip
+
+          if !feature_exists?(f_name)
+            new_feature = {
+              "name" => f_name,
+              "total" => 0,
+              "pass" => 0,
+              "fail" => 0,
+              "tests" => Array.new()
+            }
+            @data_provider[:features].push(new_feature)
+          end
+
+          update_feature(f_name, t_name, t_pass, t_comments, get_execution_time(execution_time), tag)
+          @data_provider[:total] += 1
+          @data_provider[t_pass ? :pass : :fail] += 1
+        end
+    
+        def build()
+          @data_provider[:report_path] = generate_report_path() if @data_provider[:report_path].empty?()
+          @data_provider[:title] = "$NxgReport" if @data_provider[:title].empty?()
+          folder_check()
+          set_execution_time()
+          write()
+          if @data_provider[:open_on_completion]
+            system("open #{@data_provider[:report_path]}") if File.file?(@data_provider[:report_path])
+          end
+        end
+    
+        # Private methods
+
+        def update_feature(f_name, t_name, t_pass, t_comments, t_execution_time, t_tag)
+          @data_provider[:features].each do |feature|
+            if feature["name"].eql?(f_name)
+              feature["total"]+=1
+              feature[t_pass ? "pass" : "fail"]+=1
+              feature["tests"].push({
+                "name" => t_name,
+                "testPass" => t_pass,
+                "comments" => t_comments, 
+                "time" => t_execution_time,
+                "tag" => t_tag
+              })
+              return
+            end
+          end
+        end
+
+        def feature_exists?(feature_name)
+          @data_provider[:features].each do |feature|
+            return true if feature["name"].eql?(feature_name)
+          end
+          return false
+        end
+
+        def log(message)
+          puts("🤖- #{message}")
+        end
+    
+        def folder_check()
+          folder = File.dirname(@data_provider[:report_path])
+          FileUtils.mkdir_p(folder) unless File.directory?(folder)
+        end
+    
+        def clean()
+            File.delete(@data_provider[:report_path]) if File.file?(@data_provider[:report_path])
+        end
+    
+        def write()
+          clean()
+          if @data_provider[:features].length == 0
+            log("No tests logged, cannot build empty report.")
+            return
+          end
+          template = File.new(@data_provider[:report_path], 'w')
+          template.puts(html(@data_provider))
+          template.close()
+        end
+
+        def generate_report_path()
+          report_filename = @data_provider.key?(:release_name) ? @data_provider[:release_name] : "NxgReport"
+          report_filename += "-#{@data_provider[:device]}" if @data_provider.key?(:device)
+          report_filename += "-#{@data_provider[:os]}" if @data_provider.key?(:os)
+          report_filename += "-#{@data_provider[:app_version]}" if @data_provider.key?(:app_version)
+          report_filename += "-#{@data_provider[:environment]}" if @data_provider.key?(:environment)
+          report_filename = report_filename.gsub(/[^0-9a-z-]/i, '')
+          return "./#{report_filename}.html"
+        end
+
+        def get_execution_time(execution_time)
+          if execution_time != 0 
+            @test_start_time = Time.now.to_f
+            return execution_time.round()
+          end
+          @test_end_time = Time.now.to_f
+          execution_time = (@test_end_time - @test_start_time).round()
+          @test_start_time = Time.now.to_f
+          return execution_time
+        end
+
+        private :log, :clean, :write, :update_feature, :folder_check
+    end
+
+    private_constant :NxgReport
+
+    def instance(data_provider: Hash.new())
+        NxgReport.new(data_provider)
+    end
+end

data/lib/{nxgcss.rb → nxgreport/nxgcss.rb}

@@ -14,21 +14,21 @@ module NxgCss
           --primary-color: #fff;
           --secondary-color: #fff;
           --primary-font-color: #424242;
-          --green: rgb(31, 172, 31);
+          --green: rgb(19, 143, 19);
           --red: rgb(214, 7, 7);
           --blue: rgb(0, 89, 255);
-          --red-bg: rgba(255, 0, 0, 0.233);
+          --red-bg: #ff073925;
         }
-  
+
         [theme=\"dark\"] {
           --background-color: #252525;
           --primary-color: #2e2e2e;
-          --secondary-color: rgba(255, 255, 255, 0.842);
+          --secondary-color: #fff;
           --primary-font-color: #f9fafccb;
-          --green: rgb(6, 207, 6);
-          --red: rgb(228, 1, 1);
-          --blue: rgb(91, 226, 250);
-          --red-bg: rgba(201, 53, 53, 0.479);
+          --green: #15ce40;
+          --red: #ff073a;
+          --blue: #2cbcff;
+          --red-bg: #ff07392c;
         }
   
         * {
@@ -71,6 +71,36 @@ module NxgCss
   
         #sidebar-div {
           margin: auto;
+          display: grid;
+          grid-template-rows: 1fr auto;
+          place-items: center;
+        }
+
+        #sidebar-catergories {
+          width: 80%;
+          display: flex;
+          flex-wrap: wrap;
+          justify-content: center;
+          transition: opacity 0.5s ease-in-out;
+          transition-delay: 0.5s;
+          opacity: 0;
+          margin-top: 25px;
+        }
+
+        #sidebar-catergories > div {
+          background-color: var(--background-color);
+          border-radius: 1em;
+          margin: 0.5em 0.2em;
+          padding: 0.2em 0.5em;
+          -webkit-box-shadow: -3px 0px 5px -3px rgba(216, 216, 216, 0.75);
+          -moz-box-shadow: -3px 0px 5px -3px rgba(216, 216, 216, 0.75);
+          box-shadow: -3px 0px 5px -3px rgba(216, 216, 216, 0.75);
+        }
+
+        #sidebar-catergories > div > h6 {
+          color: var(--primary-font-color);
+          font-weight: normal;
+          font-size: 0.8em;
         }
   
         #sidebar-overlay-test-info {
@@ -101,21 +131,43 @@ module NxgCss
           height: fit-content;
         }
   
-        #sidebar-title-wrap,
+        #sidebar-title-wrap {
+          display: grid;
+          grid-template-columns: 1fr auto;
+          place-items: center;
+        }
+
         #sidebar-overlay-test-info {
           display: flex;
           place-items: center;
           flex-wrap: wrap;
         }
+
+        #sidebar-title {
+          margin: 0 0.2em 0 0;
+        }
   
         #sidebar-title,
         #sidebar-status {
           color: var(--secondary-color);
+          transition: opacity 0.5s ease-in-out;
+          transition-delay: 0.5s;
+          opacity: 0;
         }
   
         #test-title {
           margin: 0;
         }
+
+        #test-execution-time {
+          font-size: 0.7em;
+          font-weight: bold;
+          background: var(--primary-gradient);
+          color: white;
+          padding: 0.2em 0.5em;
+          border-radius: 0.5em;
+          margin-left: 0.5em;
+        }
   
         h2,
         h3,
@@ -245,7 +297,7 @@ module NxgCss
           }
   
           #pt {
-            font-size: 0.7em;
+            font-size: 0.8em;
           }
   
           .funcname {

data/lib/nxgreport/nxghtml.rb

@@ -0,0 +1,196 @@
+require 'nxgreport/nxgcss.rb'
+require 'nxgreport/nxgjs.rb'
+
+module NxgHTML
+    
+    include NxgCss
+    include NxgJavascript
+
+    def html(data_provider)
+        @data_provider = data_provider
+        "<html lang=\"en\">
+            #{head()}
+            #{body()}
+            #{js(@data_provider)}
+        </html>"
+    end
+
+    def head()
+        "<head>
+          <meta charset=\"UTF-8\" />
+          <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />
+          <script src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js\"></script>
+          <script> #{js_detect_system_dark_mode()}</script>
+          <title>Home | #{@data_provider[:title]}</title>
+          #{google_fonts_link()}
+          #{icons_link()}
+          #{css(@data_provider)}
+        </head>"
+    end
+
+    def google_fonts_link()
+        "<link
+          href=\"https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,600;0,700;0,800;1,300;1,400;1,600;1,700;1,800&display=swap\"
+          rel=\"stylesheet\"
+        />"
+    end
+
+    def icons_link()
+        "<link
+            href=\"https://fonts.googleapis.com/icon?family=Material+Icons\"
+            rel=\"stylesheet\"
+        />"
+    end
+
+    def body()
+        "<body id=\"app\" onload=\"onRefresh()\">
+          <div id=\"sidebar\" onclick=\"closeDetails(event)\">
+            <div id=\"sidebar-div\">
+              <div id=\"sidebar-title-wrap\">
+                <h1 id=\"sidebar-title\">Title</h1>
+                <i class=\"material-icons\" id=\"sidebar-status\">check_circle</i>
+              </div>
+              <div id=\"sidebar-catergories\">
+              </div>
+            </div>
+          </div>
+        <div id=\"sidebar-overlay\" onclick=\"closeDetails(event)\">
+          <div id=\"sidebar-overlay-grid\"></div>
+        </div>
+          <div id=\"body-wrap\">
+            #{header()}
+            #{config()}
+            #{features()}
+            #{footer()}
+          </div>
+        </body>"
+    end
+
+    def header()
+        "<div id=\"header\">
+          <h1 id=\"app-title\">#{@data_provider[:title]}</h1>
+          <div id=\"theme-wrap\">
+            <button id=\"theme-switch\" onclick=\"switchTheme()\">
+              <i class=\"material-icons\" id=\"theme-icon\">wb_sunny</i>
+            </button>
+          </div>
+        </div>"
+    end
+
+    def features()
+        "<div class=\"features-grid\"></div>"
+    end
+
+    def footer()
+        "<div id=\"footer\">
+          <p>
+            Developed by
+            <span>
+              <a
+                href=\"https://www.linkedin.com/in/balabharathijayaraman\"
+                rel=\"noopener\"
+                target=\"_blank\"
+                >Balabharathi Jayaraman</a
+              >
+            </span>
+          </p>
+        </div>"
+    end
+
+    def config()
+        return if @data_provider.length == 0
+
+        return "<div class=\"params-container\">
+                    #{release_name()}
+                    #{execution_date()}
+                    #{device()}
+                    #{os()}
+                    #{app_version()}
+                    #{environment()}
+                    #{passed_tests()}
+                    #{failed_tests()}
+                    #{percentage_pass()}
+                    #{execution_time()}
+                    #{filter()}
+                </div>"
+    end
+
+    def execution_time()
+        return if !@data_provider.key?(:environment)
+        
+        return config_item("Total execution time", @data_provider[:execution_time],'access_time')
+    end
+
+    def filter()
+        "<div class=\"param-wrap\" onclick=\"setFilter()\" id=\"filter\" title=\"Filter tests\">
+            <i class=\"pi material-icons\">filter_list</i>
+            <h5 id=\"pt\">Failed</h5>
+        </div>"
+    end
+
+    def passed_tests()
+        "<div class=\"param-wrap\" title=\"Passed tests\">
+            <i class=\"pi green-font material-icons\">check_circle</i>
+            <h5 id=\"pt\">#{@data_provider[:pass] == 0 ? "None" : @data_provider[:pass]}</h5>
+        </div>"
+    end
+
+    def failed_tests()
+        "<div class=\"param-wrap\" title=\"Failed tests\" #{@data_provider[:fail] > 0 ? "onclick=\"filterAllFailed()\" style=\"cursor: pointer\"" : ""}>
+            <i class=\"pi red-font material-icons\">cancel</i>
+            <h5 id=\"pt\">#{@data_provider[:fail] == 0 ? "None" : @data_provider[:fail]}</h5>
+        </div>"
+    end
+
+    def percentage_pass()
+        pass_percentage = ((@data_provider[:pass]/@data_provider[:total].to_f) * 100).round(2)
+
+        return "<div class=\"param-wrap\" title=\"Pass percentage\">
+                  <i class=\"pi #{pass_percentage.to_i == 100 ? "green-font" : ""} material-icons\">equalizer</i>
+                  <h5 id=\"pt\">#{pass_percentage.to_i == 100 ? pass_percentage.to_i : pass_percentage}%</h5>
+                </div>"
+    end
+
+    def environment()
+        return if !@data_provider.key?(:environment)
+
+        return config_item("Test environment", @data_provider[:environment], "layers")
+    end
+
+    def app_version()
+        return if !@data_provider.key?(:app_version)
+
+        return config_item("App version tested", @data_provider[:app_version], "info")
+    end
+
+    def release_name()
+        return if !@data_provider.key?(:release_name)
+
+        return config_item("Release", @data_provider[:release_name], "bookmark")
+    end
+
+    def os()
+        return if !@data_provider.key?(:os)
+
+        return config_item("Os tested", @data_provider[:os], "settings")
+    end
+
+    def device()
+        return if !@data_provider.key?(:device)
+            
+        return config_item("Device tested", @data_provider[:device], "devices")
+    end
+
+    def execution_date()
+        @data_provider[:execution_date] = Time.now().strftime("%b %d, %Y") if !@data_provider.key?(:execution_date)
+            
+        return config_item("Execution date", @data_provider[:execution_date], "event")
+    end
+
+    def config_item(toot_tip, name, icon)
+        "<div class=\"param-wrap\" title=\"#{toot_tip}\">
+            <i class=\"pi material-icons\">#{icon}</i>
+            <h5 id=\"pt\">#{name}</h5>
+        </div>"
+    end
+end