rvvm 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd6e9e8729d0de5aeabb5a88f183096de1acc98ae8d5e2d70c7be57edf883a0
-  data.tar.gz: aa70e5dd5f06d668c8e83a38043d02f0b86aa047bd7a85c5b4db5ce04567a894
+  metadata.gz: 9232781d6d02b88aa6d9442091845ad5a167046cc6149fffa4b69323dbcef3f2
+  data.tar.gz: b1777bfa093994e1d9e6abac38aea4e286fb13099a9f1fdb1ad4c37daeb5b134
 SHA512:
-  metadata.gz: accdd51566d38973f742e264d35bfecdc1b5ede51d3d0f9062114a4dd8c2d95bc64437026123de630ed2a1ce7b9702cb06d1e4570820cbadf89f946aa9641f22
-  data.tar.gz: a330ed820c00511ced53ffe42ec13d2eec98d9783c3aa581a144a029e46b4a92ed84fd86a27b5c25dc46b83c1f88d9cf8ab2ac0e37e688215713a16ce7bf9e17
+  metadata.gz: a3a0253c53db3ffba91ffa310b0cba9001f5b5d34efd70cdc1f85fef13e09149ed0afcf117ebec4e28d22aa1c1a31e324b963a23515a6ab52dba6423f43e5d0d
+  data.tar.gz: 17c5b7eb71ac667fff426a7570c8e86f98a0a3ddfbc59d034fbb24820074799cbc8cd595fa5f0666e8dc60e4edd9c992e6048497e8f0b2382ee4835689b9d878

data/CHANGELOG.md

@@ -129,3 +129,19 @@
 3. Elaboration and simulation custom waveform trace dump file
 4. Project template files regeneration/restoration to default
 
+## [1.0.0] - 2024-09-17
+
+### Added:
+
+1. CLI log graphics (Crayons module)
+2. Template file generation in pwd
+
+### Fixed:
+
+1. Missing testlist arg conversion to array
+2. Module/itf template creation
+
+### TBI:
+
+1. Elaboration and simulation custom waveform trace dump file
+2. Project template files regeneration/restoration to default

data/lib/rvvm/crayons.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require "tty-spinner"
+require "rainbow/refinement"
+
+using Rainbow
+
+# Utility module providing spinners and stdout mesage formatting.
+#
+# @example
+#   require 'rvvm/crayons'
+#
+#   Crayons.spinner_start("New task...")
+#
+#   # do stuff
+#
+#   Crayons.spinner_log("Halfway done! ^^")
+#
+#   # do some more stuff
+#
+#   Crayons.spinner_stop("Completed!", true)
+#   Crayons.log_pass("Oof, im done now...")
+#
+# @since 1.0.0
+module Crayons
+  # module variables to hold instances of a
+  # running spinner and its thread
+  @spinner = nil
+  @thread = nil
+  @thread_paused = false
+  @spinner_running = false
+
+  # Returns spinner status.
+  #
+  # @returns @spinner_running [Boolean] spinner status
+  def self.spinner_running?
+    @spinner_running
+  end
+
+  # Starts a cli spinner appending the provided message.
+  #
+  # @param message [String] text to append to the spinner
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.spinner_start(message)
+    sleep(0.1)
+    print "\r\e[K"
+    @spinner = TTY::Spinner.new("[:spinner] #{message}")
+    @spinner_running = true
+    @thread = Thread.new do
+      @spinner.auto_spin
+      sleep(0.1) while @thread_paused
+    end
+  end
+
+  # Pauses spinner thread execution to enable uninterrupted stdout outputs.
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.spinner_pause
+    return unless @spinner_running
+
+    print "\r\e[K"
+    @thread_paused = true
+  end
+
+  # Resumes spinner thread execution.
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.spinner_resume
+    @thread_paused = false if @spinner_running
+  end
+
+  # Stops spinner printing a formated status message.
+  #
+  # @param message [String] status message to print
+  # @param exit [Boolean] return code (true - success, false - error)
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.spinner_stop(message = nil, exit)
+    return unless @spinner_running
+
+    spinner_message = message || (exit ? "Done!" : "Failed!")
+    exit ? @spinner.success(spinner_message.green) : @spinner.error(spinner_message.red)
+    @thread.join
+    sleep(0.1)
+    @spinner_running = false
+    print "\r\e[K"
+  end
+
+  # Logs a message during spinner execution removing the need
+  # to manually pause and resume spinner.
+  #
+  # If a spinner is not running simply prints message.
+  #
+  # @param message [String] message to prin
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.spinner_log(message)
+    spinner_pause if @spinner_running
+    puts message
+    spinner_resume if @spinner_running
+  end
+
+  # Logs a green text message to stdout.
+  #
+  # @param message [String] message to print
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.log_pass(message)
+    puts message.green
+  end
+
+  # Logs a red text message to stdout.
+  #
+  # @param message [String] message to print
+  #
+  # @return [void]
+  #
+  # @since 1.0.0
+  def self.log_error(message)
+    puts message.red
+  end
+end

data/lib/rvvm/templates.rb

@@ -136,7 +136,7 @@ endmodule: ${prjname}_tb_top
       type: "module",
       module: "best_rtl_module_ever",
       date: "01/01/2024 00:00",
-      prjname: "RVvM",
+      prjname: " ",
       company: " ",
       username: "me"
     },
@@ -175,7 +175,7 @@ end${type}
       package: "best_rtl_pkg",
       PACKAGE: "BEST_RTL_PACKAGE",
       date: "01/01/2024 00:00",
-      prjname: "RVvM",
+      prjname: " ",
       company: " ",
       username: "me"
     },
@@ -215,7 +215,7 @@ endpackage
     conf: {
       NAME: "BEST_RTL_FILE",
       date: "01/01/2024 00:00",
-      prjname: "RVvM",
+      prjname: " ",
       company: " ",
       username: "me"
     },

data/lib/rvvm/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "crayons"
+
 # Utils module providing utilities and helper methods to rvvm.
 #
 # Mainly used to generate files and templates.
@@ -35,7 +37,8 @@ module Utils
       file.write(content)
     end
   rescue StandardError => e
-    puts "\nFailed to create a file!\nError #{e.message}"
+    Crayons.spinner_stop("Error!", false) if Crayons.spinner_running?
+    Crayons.log_error("\nFailed to create a file!\n #{e.message}")
   end
 
   # Generates a file based on a template.
@@ -54,7 +57,7 @@ module Utils
     filename = name || template[:file][:name]
     filepath = path || template[:file][:path]
 
-    puts "      Generating: #{filepath}/#{filename}"
+    Crayons.spinner_log("Generating: #{filepath}/#{filename}")
     gen_file("#{filepath}/#{filename}", content)
   end
 
@@ -96,7 +99,7 @@ module Utils
       username = handle.read
     end
 
-    username.strip!
+    username&.strip!
     username
   end
 
@@ -113,7 +116,6 @@ module Utils
     array.each do |key|
       return false if hash[key]
     end
-
     true
   end
 end

data/lib/rvvm/version.rb

@@ -3,5 +3,5 @@
 # Module holding current rvvm version.
 module Rvvm
   # Current rvvm module version.
-  VERSION = "0.9.5"
+  VERSION = "1.0.0"
 end

data/lib/rvvm.rb

@@ -28,6 +28,7 @@ module Rvvm
   @templates = Templates.load
   @config_path = nil
   @config = nil
+  @formatted_time = nil
 
   # Instance variables to hold parsed args and required arg symbol list
   @args = {}
@@ -52,15 +53,15 @@ module Rvvm
   # Script argument parsing block.
   # Runs on loading the module using require.
   OptionParser.new do |args|
+    current_time = Time.now
+    @formatted_time = current_time.strftime("%Y-%m-%d %H:%M:%S")
+
     args.on("-h", "--help", "Shows this help") do
       puts "\nRVvM - Ruby Vivado Manager\n\n"
       puts "\tRVvM is a Ruby based tool to manage, compile, elaborate and simulate SystemVerilog and UVM based projects"
       puts "\tusing Xilinx Vivado xvlog, xelab, xrun and xsc.\n\n"
       puts args
 
-      @current_time = Time.now
-      @formatted_time = @current_time.strftime("%Y-%m-%d %H:%M:%S")
-
       req_args = String.new
       @required_args.each do |arg|
         req_args << "--#{arg} "
@@ -74,11 +75,12 @@ module Rvvm
     end
 
     args.on("-n", "--new NAME", "Creates a new project wit the prowided name under pwd")
-    args.on("--module NAME", "Creates a SystemVerilog module template (default path: <prj dir>/design/src)")
+    args.on("-m", "--module NAME", "Creates a SystemVerilog module template (default path: <prj dir>/design/src)")
     args.on("--pkg NAME", "Creates a SystemVerilog package template (default path: <prj dir>/design/pkg)")
     args.on("--itf NAME", "Creates a SystemVerilog interface template (default path: <prj dir>/design/itf)")
     args.on("--svfile NAME", "Creates a generic SystemVerilog file template (default path: <prj dir>/design/src)")
     args.on("--path PATH", "Specifies a path relative to <prj dir> when creating a file template")
+    args.on("--here", "Specifies pwd as the path for template file creation.")
     args.on("-c", "--comp", "Compile SystemVerilog sources")
     args.on("-e", "--elab", "Elaborates project")
     args.on("-r", "--run", "Runs UVM simulation")
@@ -97,7 +99,7 @@ module Rvvm
     args.on("--simlog LOGNAME", "Specifies simulation log name (overwrites config)")
     args.on("--test TESTNAME", "Specifies UVM test to be run by --run (overwrites config)")
     args.on("-b", "--batch", "Run a batch of UVM tests from a test list (overwrites config)")
-    args.on("--testlist TESTLIST", "Specifies test list for a batch of test run (overwrites config)")
+    args.on("--testlist TESTLIST", Array, "Specifies test list as a comma separated string for a batch of test run (overwrites config)")
     args.on("--verb VERBOSITY", "Specifies UVM verbosity <LOW, MEDIUM, HIGH, FULL, DEBUG> (overwrites config)")
     args.on("--simtb TBNAME", "Specifies testbench snapshot for simulation (overwrites config)")
     args.on("--dpilist LISTFILE", "Specifies source file list for DPI-C compilation (overwrites config)")
@@ -121,10 +123,12 @@ module Rvvm
     end
 
     # Check if a required arg is provided
-    if Utils.all_nil?(@args, @required_args)
-      puts "\nNo required options provided!\nFor more info use -h or --help\n"
-      exit(1)
-    end
+    return unless Utils.all_nil?(@args, @required_args)
+
+    puts ""
+    Crayons.log_error("No required options provided!")
+    puts "For more info use -h or --help\n\n"
+    exit(1)
   end
 
   # Argument collision handling and additional settings for
@@ -159,7 +163,8 @@ module Rvvm
   # @since 0.8.0
   def self.execute(command)
     if @args[:debug]
-      puts command
+      Crayons.spinner_log(command)
+      sleep(1)
     else
       system(command)
     end
@@ -173,20 +178,19 @@ module Rvvm
   #
   # @since 0.8.0
   def self.create_new_project(name)
-    puts "\nRVvM: Generating new project: #{name} ...\n"
-
     if File.exist?(name)
-      print "      Directory #{name} already exists. Do you want to overwrite it? [y/n] "
+      print "\nDirectory #{name} already exists. Do you want to overwrite it? [y/n] "
       input = gets.chomp
-      puts " "
+      puts ""
 
-      if input == "y"
-        FileUtils.rm_rf(name)
-      else
-        exit(0)
-      end
+      exit(0) unless input == "y"
+      FileUtils.rm_rf(name)
+    else
+      puts ""
     end
 
+    Crayons.spinner_start("Generating new project: #{name}...")
+
     FileUtils.mkdir(name)
     Dir.chdir(name)
 
@@ -236,16 +240,20 @@ module Rvvm
     temp_conf[:PRJNAME] = name.upcase
     Utils.gen_template(@templates[:tbtop], "#{name}_tb_top.sv", temp_conf)
 
-    puts " "
+    Crayons.spinner_log(" ")
+    Crayons.spinner_pause
     system("git init")
     system("git add .")
     system('git commit -am "Initial commit"')
+    Crayons.spinner_resume
 
-    puts "\nRVvM: New project generated. ^^\n\n"
+    Crayons.spinner_stop("Done!", true)
+    Crayons.log_pass("\nRVvM: New project generated. ^^\n\n")
 
     exit(0)
   rescue StandardError => e
-    puts "RVvM: Failed to create project...\n #{e.message}\n"
+    Crayons.spinner_stop("Error!", false) if Crayons.spinner_running?
+    Crayons.log_error("RVvM failed to create project...\n\n#{e.message}\n")
     exit(1)
   end
 
@@ -256,14 +264,15 @@ module Rvvm
   #
   # @since 0.8.0
   def self.load_config
-    puts "\nRVvM: Loading RVvM project config..."
+    puts ""
+    Crayons.spinner_start("Loading RVvM project config...")
 
     @config_path = Utils.find_file_dir("rvvmconf.json", ".")
     json_file = File.read("#{@config_path}/rvvmconf.json") if @config_path
 
     unless json_file
-      puts "     Failed to load config file!\n"
-      puts "     Make sure you are inside an RVvM project.\n\n"
+      Crayons.log_error("     Failed to load config file!\n")
+      Crayons.log_error("     Make sure you are inside an RVvM project.\n\n")
       exit(1)
     end
 
@@ -274,8 +283,11 @@ module Rvvm
         v.transform_keys(&:to_sym) if v.instance_of?(Hash)
       end.transform_keys(&:to_sym)
     end
+
+    Crayons.spinner_stop(nil, true)
+    puts ""
   rescue JSON::ParserError => e
-    puts "     Invalid config json!\n\n#{e.message}"
+    Crayons.log_error("     Invalid config json!\n\n#{e.message}")
     exit(1)
   end
 
@@ -298,10 +310,14 @@ module Rvvm
     logname = @args[:complog] || File.join([@config[:project][:logDir], @config[:compilation][:logDir], @config[:compilation][:log]])
     complist = @args[:compilelist] || @config[:compilation][:list]
 
-    puts "\nRVvM: Compiling HDL sources..\n"
+    Crayons.spinner_start("Compiling HDL sources...")
 
     cmd = "xvlog -sv -f #{complist} -log #{logname} #{cmd_args}"
-    execute(cmd)
+    Crayons.spinner_pause
+    exit = execute(cmd)
+    Crayons.spinner_resume
+    Crayons.spinner_stop(nil, exit)
+    puts ""
   end
 
   # Compiles C/C++ sources into a shared library to use during
@@ -314,10 +330,12 @@ module Rvvm
     cmd_args = @config[:dpi][:args]
     dpilist = @args[:dpilist] || @config[:dpi][:list]
 
-    puts "\nRVvM: Building DPI-C library...\n"
+    Crayons.spinner_start("Building DPI-C library...")
 
     cmd = "sxc -f #{dpilist} #{cmd_args}"
-    execute(cmd)
+    exit = execute(cmd)
+    Crayons.spinner_stop(nil, exit)
+    puts ""
   end
 
   # Elaborates project into a testbench snapshot using xelab.
@@ -334,12 +352,14 @@ module Rvvm
     tb = @args[:tb] || @config[:elaboration][:tb]
     timescale = @args[:timescale] || @config[:elaboration][:timescale]
 
-    puts "\nRVvM: Elaborating testbench:"
-    puts "     TB TOP: \t#{tb_top}"
-    puts "     SNAPSHOT:\t#{tb}\n"
+    Crayons.spinner_start("Elaborating testbench: #{tb}...")
 
     cmd = "xelab #{tb_top} -relax -s #{tb} -timescale #{timescale} -log #{logname} #{cmd_args}"
-    execute(cmd)
+    Crayons.spinner_pause
+    exit = execute(cmd)
+    Crayons.spinner_resume
+    Crayons.spinner_stop(nil, exit)
+    puts ""
   end
 
   # Runs UVM test simulation on an elaborated testbench snapshot using xrun.
@@ -354,7 +374,7 @@ module Rvvm
     else
       cmd_args << "-R"
     end
-    
+
     # Run simulaton on an array of tests.
     # If in not running in batch mode testlist is an array with a single test
     test = @args[:test] || @config[:simulation][:defTest]
@@ -363,10 +383,10 @@ module Rvvm
 
     tb = @args[:simtb] || @args[:tb] || @config[:elaboration][:tb]
 
-    puts ""
-
     testlist.each_with_index do |simtest, i|
-      puts "RVvM: Running test #{i + 1}/#{testlist.size}: #{simtest}"
+      simtest.strip!
+      puts "" if i.positive?
+      Crayons.spinner_start("Running test #{i + 1}/#{testlist.size}: #{simtest}...")
 
       logname = File.join([@config[:project][:logDir], @config[:simulation][:logDir], @config[:simulation][:log]])
       logname = Utils.interpolate(logname, { testname: simtest })
@@ -374,8 +394,13 @@ module Rvvm
       verb = "UVM_#{@args[:verb] || @config[:simulation][:verbosity]}"
 
       cmd = "xsim #{tb} -log #{logname} -testplusarg \"UVM_VERBOSITY=#{verb}\" -testplusarg \"UVM_TESTNAME=#{simtest}\" #{cmd_args}"
-      execute(cmd)
+      Crayons.spinner_pause
+      exit = execute(cmd)
+      Crayons.spinner_resume
+      Crayons.spinner_stop(nil, exit)
     end
+
+    puts ""
   end
 
   # Runs a pure SystemVerilog/Verilog simulation using xrun.
@@ -387,13 +412,16 @@ module Rvvm
     cmd_args = @config[:simulation][:args]
     tb = @args[:simtb] || @args[:tb] || @config[:elaboration][:tb]
 
-    puts "\nRVvM: Running pure SV/V simulation..."
+    Crayons.spinner_start("Running pure SV/V simulation...")
     logname = @args[:simlog] || File.join([@config[:project][:logDir], @config[:simulation][:logDir], "svsim.log"])
 
     cmd = "xsim #{tb} -log #{logname} #{cmd_args}"
-    execute(cmd)
+    Crayons.spinner_pause
+    exit = execute(cmd)
+    Crayons.spinner_resume
+    Crayons.spinner_stop(nil, exit)
   end
-  
+
   # Opens last generated waveform trace dump to inspect in Vivado GUI.
   #
   # @return [void]
@@ -404,6 +432,8 @@ module Rvvm
 
     cmd = "xsim --gui #{dump}"
     execute(cmd)
+
+    exit(0)
   end
 
   # Generates UVM test functional coverage report using xcrg.
@@ -412,8 +442,13 @@ module Rvvm
   #
   # @since 0.9.0
   def self.coverage
+    Crayons.spinner_start("Generating UVM functional coverage report...")
+
     cmd = "xcrg -report_format html -dir xsim.covdb"
-    execute(cmd)
+    Crayons.spinner_pause
+    exit = execute(cmd)
+    Crayons.spinner_resume
+    Crayons.spinner_stop(nil, exit)
   end
 
   # Opens last generated functional coverage report in a HTML dashboard.
@@ -424,6 +459,8 @@ module Rvvm
   def self.cov_report
     Dir.chdir("xcrg_func_cov_report")
     execute("./dashboard.html")
+
+    exit(0)
   end
 
   # Generates a SystemVerilog module/interface template.
@@ -434,19 +471,30 @@ module Rvvm
   # @return [void]
   #
   # @since 0.9.0
-  def self.create_module(type, name)
+  def self.create_module(name, type)
     conf = @templates[:module][:conf]
     conf[:module] = name
     conf[:date] = @formatted_time
-    conf[:prjname] = @config[:project][:name]
-    conf[:company] = @config[:project][:company]
+    unless @args[:here]
+      conf[:prjname] = @config[:project][:name]
+      conf[:company] = @config[:project][:company]
+    end
 
     conf[:type] = type
     @templates[:module][:file][:path] = "design/itf" if type == "itf"
-    path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+
+    if @args[:here]
+      path = "."
+    else
+      path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+    end
     conf[:username] = Utils.git_userame || " "
 
+    puts ""
+    Crayons.spinner_start("Generating SV #{type} template...")
     Utils.gen_template(@templates[:module], "#{name}.sv", conf, path)
+    Crayons.spinner_stop(nil, true)
+    puts ""
 
     exit(0)
   end
@@ -463,13 +511,23 @@ module Rvvm
     conf[:package] = name
     conf[:PACKAGE] = name.upcase
     conf[:date] = @formatted_time
-    conf[:prjname] = @config[:project][:name]
-    conf[:company] = @config[:project][:company]
+    unless @args[:here]
+      conf[:prjname] = @config[:project][:name]
+      conf[:company] = @config[:project][:company]
+    end
     conf[:username] = Utils.git_userame || " "
 
-    path = File.join([@config[:project][:path], @args[:path] || @templates[:package][:file][:path]])
+    if @args[:here]
+      path = "."
+    else
+      path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+    end
 
+    puts ""
+    Crayons.spinner_start("Generating SV pkg template...")
     Utils.gen_template(@templates[:package], "#{name}.sv", conf, path)
+    Crayons.spinner_stop(nil, true)
+    puts ""
 
     exit(0)
   end
@@ -485,13 +543,23 @@ module Rvvm
     conf = @templates[:svfile][:conf]
     conf[:NAME] = name.upcase
     conf[:date] = @formatted_time
-    conf[:prjname] = @config[:project][:name]
-    conf[:company] = @config[:project][:company]
+    unless @args[:here]
+      conf[:prjname] = @config[:project][:name] || " "
+      conf[:company] = @config[:project][:company] || " "
+    end
     conf[:username] = Utils.git_userame || ""
 
-    path = File.join([@config[:project][:path], @args[:path] || @templates[:package][:file][:path]])
+    if @args[:here]
+      path = "."
+    else
+      path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
+    end
 
+    puts ""
+    Crayons.spinner_start("Generating generic SV file template...")
     Utils.gen_template(@templates[:svfile], "#{name}.sv", conf, path)
+    Crayons.spinner_stop(nil, true)
+    puts ""
 
     exit(0)
   end
@@ -505,13 +573,15 @@ module Rvvm
     create_new_project(@args[:new]) if @args[:new]
 
     check_args
-    load_config
-    handle_args
+    unless @args[:here]
+      load_config
+      handle_args
+    end
 
-    create_module(@args[:module], nil)  if @args[:module]
-    create_module(@args[:itf, "itf"])   if @args[:itf]
-    create_pkg(@args[:pkg])             if @args[:pkg]
-    create_svfile(@args[:svfile])       if @args[:svfile]
+    create_module(@args[:module], "module") if @args[:module]
+    create_module(@args[:itf], "itf")       if @args[:itf]
+    create_pkg(@args[:pkg])                 if @args[:pkg]
+    create_svfile(@args[:svfile])           if @args[:svfile]
 
     prj_top
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvvm
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - mrbya
@@ -29,6 +29,7 @@ files:
 - bin/sandbox
 - exe/rvvm
 - lib/rvvm.rb
+- lib/rvvm/crayons.rb
 - lib/rvvm/templates.rb
 - lib/rvvm/utils.rb
 - lib/rvvm/version.rb