origen_app_generators 1.1.4 → 2.2.0

data/lib/origen_app_generators/test_engineering/stand_alone_application.rb

@@ -1,8 +1,9 @@
 module OrigenAppGenerators
   module TestEngineering
-    require 'origen_app_generators/sub_block_parser'
     # Generates a generic application shell
     class StandAloneApplication < Application
+      include Common
+
       desc 'A stand alone test engineering application'
 
       # Any methods that are not protected will get invoked in the order that they are
@@ -13,13 +14,12 @@ module OrigenAppGenerators
         # The methods to get the common user input that applies to all applications will
         # get called at the start automatically, you have a chance here to ask any additional
         # questions that are specific to the type of application being generated
-        get_top_level_names
-        get_sub_block_names
       end
 
       def generate_files
-        # Calling this will build all files, directories and symlinks contained in the
-        # hash returned by the filelist method
+        @development_dependencies = [
+          ['origen_testers']
+        ]
         build_filelist
       end
 
@@ -37,122 +37,8 @@ module OrigenAppGenerators
 
       protected
 
-      def sub_block_parser
-        @sub_block_parser ||= SubBlockParser.new
-      end
-
-      def get_top_level_names
-        puts
-        puts 'NAME YOUR TOP-LEVEL DEVICE(S)'
-        puts
-        puts 'What do you want to call the top-level class that represents your device?'
-        puts 'By default it will be called TopLevel, but if you want this application to support multiple devices you should'
-        puts 'give them unique names.'
-        puts 'Separate multiple names with a comma:    Falcon, Eagle, Vulture'
-        puts
-
-        valid = false
-        until valid
-          @top_level_names = get_text(single: true, default: 'TopLevel').strip.split(',').map do |name|
-            name.strip.gsub(/\s+/, '_').camelize
-          end
-          unless @top_level_names.empty?
-            # Should we check anything here?
-            valid = true
-          end
-        end
-        @top_level_names
-      end
-
-      def get_sub_block_names
-        puts
-        puts 'DEFINE YOUR SUB-BLOCKS'
-        puts
-        puts 'What sub-blocks does this device contain?'
-        puts 'You can leave this blank, but entering some details of the sub-blocks you will want to involve in your tests'
-        puts 'will save you some manual setup of the associated models and controllers.'
-        puts 'You can specify layers of hierarchy and multiple instantiations, here are some examples:'
-        puts
-        puts '  A RAM, OSC, PLL and 2 ATDs at the top-level:    ram, osc, pll, atd(2)'
-        puts '  With 3 COMMS blocks with embedded components:   ram, osc, pll, atd(2), comms[ram(2), osc](3)'
-        if @top_level_names.size > 1
-          puts
-          puts 'If you want different modules for each of your top-level devices you can do:'
-          puts
-          puts "  #{@top_level_names[0]}[ram, atd(2)], #{@top_level_names[1]}[ram(2), atd(4)]"
-        end
-        puts
-
-        valid = false
-        until valid
-          input = get_text(single: true).strip
-          if input.empty?
-            @sub_blocks_lookup = {}
-            valid = true
-          else
-            begin
-              @sub_blocks_lookup = sub_block_parser.parse(input)
-              valid = true
-            rescue
-              valid = false
-            end
-          end
-        end
-        @sub_blocks_lookup
-      end
-
-      # Returns a hash that looks like:
-      #
-      #   {"Falcon"=>{"RAM"=>{}, "ATD"=>{:instances=>2}}, "Eagle"=>{"RAM"=>{:instances=>2}, "ATD"=>{:instances=>4}}}
-      def top_level_sub_blocks
-        blocks = {}
-        # Make sure that each top-level object has a sub blocks assignment
-        if @top_level_names.any? { |n| @sub_blocks_lookup[n] }
-          @top_level_names.each do |name|
-            if @sub_blocks_lookup[name]
-              blocks[name] = @sub_blocks_lookup[name][:children] || {}
-            else
-              blocks[name] = {}
-            end
-          end
-        # Duplicate the given sub blocks to all top-level objects if none have been specified
-        else
-          @top_level_names.each do |name|
-            blocks[name] = @sub_blocks_lookup
-          end
-        end
-        blocks
-      end
-
-      # Returns a hash with all sub-blocks at the top-level, e.g.:
-      #
-      #   {"RAM"=>{}, "ATD"=>{}, "Comms"=>{"RAM"=>{:instances=>2}, "Osc"=>{}}, "Osc"=>{}}
-      def sub_blocks
-        blocks = {}
-        top_level_sub_blocks.each do |top, attrs|
-          extract_sub_blocks(attrs) do |name, attrs|
-            if blocks[name]
-              if blocks[name] != (attrs[:children] || {})
-                Origen.log.warning "The app builder does not currently support different sub-block definitions for block #{name}"
-                Origen.log.warning 'Only the first defintion has been built'
-              end
-            else
-              blocks[name] = attrs[:children] || {}
-            end
-          end
-        end
-        blocks
-      end
-
-      def extract_sub_blocks(blocks, &block)
-        blocks.each do |name, attrs|
-          yield name, attrs
-          extract_sub_blocks(attrs[:children], &block) if attrs[:children]
-        end
-      end
-
       # Defines the filelist for the generator, the default list is inherited from the
-      # parent class (Application).
+      # parent class (Plugin).
       # The filelist can contain references to generate files, directories or symlinks in the
       # new application.
       #
@@ -160,74 +46,16 @@ module OrigenAppGenerators
       # from the parent generator, this means that your generator will automatically stay up
       # to date with the latest conventions
       #
-      # The master templates live in templates/app_generators/application, but
+      # The master templates live in templates/app_generators/plugin, but
       # DO NOT MODIFY THESE FILES DIRECTLY.
       # Either add or remove things post-generation in the modify_files method or copy the
-      # master file to the equivalent sub-directory of templates/app_generators/test_engineering/generic_stand_alone_application
+      # master file to the equivalent sub-directory of templates/app_generators/test_engineering/mpg_test_block
       # which will override the version in the master directory.
       #
       # Additional files can be added or removed from the filelist as shown below.
       def filelist
         @filelist ||= begin
-          list = super  # Always pick up the parent list
-          # Example of how to remove a file from the parent list
-          list.delete(:lib_top_level)
-          list.delete(:target_debug)
-          list.delete(:target_production)
-          list.delete(:target_default)
-          # Example of how to add a file, in this case the file will be compiled and copied to
-          # the same location in the new app
-          @top_level_names.each_with_index do |name, i|
-            list["top_level_model_#{i}"] = { source:  'lib/top_level.rb',
-                                             dest:    "lib/#{@name}/#{name.underscore}.rb",
-                                             options: { name: name, sub_blocks: top_level_sub_blocks[name] }
-                                           }
-
-            list["top_level_controller_#{i}"] = { source:  'lib/top_level_controller.rb',
-                                                  dest:    "lib/#{@name}/#{name.underscore}_controller.rb",
-                                                  options: { name: name }
-                                                }
-
-            list["target_#{name}"] = { source:  'target/top_level.rb',
-                                       dest:    "target/#{name.underscore}.rb",
-                                       options: { name: name }
-                                     }
-            if i == 0
-              list[:target_default] =  { source: "#{name.underscore}.rb", # Relative to the file being linked to
-                                         dest:   'target/default.rb',     # Relative to destination_root
-                                         type:   :symlink }
-            end
-          end
-
-          sub_blocks.each do |name, blocks|
-            list["ip_block_#{name}"] = { source:  'lib/ip_block.rb',
-                                         dest:    "lib/#{@name}/#{name.underscore}.rb",
-                                         options: { name: name, sub_blocks: blocks }
-                                       }
-
-            list["ip_block_controller_#{name}"] = { source: 'lib/ip_block_controller.rb',
-                                                    dest:   "lib/#{@name}/#{name.underscore}_controller.rb" }
-          end
-
-          list[:environment_j750] = { source: 'environment/j750.rb' }
-          list[:environment_uflex] = { source: 'environment/uflex.rb' }
-          list[:environment_v93k] = { source: 'environment/v93k.rb' }
-          list[:environment_jlink] = { source: 'environment/jlink.rb' }
-          # Alternatively specifying a different destination, typically you would do this when
-          # the final location is dynamic
-          # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
-          # Example of how to create a directory
-          # list[:pattern_dir] = { dest: "pattern", type: :directory }
-          # Example of how to create a symlink
-          list[:environment_default] = { source: 'j750.rb',          # Relative to the file being linked to
-                                         dest:   'environment/default.rb', # Relative to destination_root
-                                         type:   :symlink }
-          # Test engineering source directories
-          list[:program_dir] = { dest: 'program', type: :directory }
-          list[:pattern_dir] = { dest: 'pattern', type: :directory }
-          # Example source files
-          list[:pattern_example] = { source: 'pattern/example.rb' }
-          # Remember to return the final list
+          list = common_filelist(super)  # Always pick up the parent list
           list
         end
       end

data/lib/origen_app_generators/test_engineering/test_block.rb

@@ -2,6 +2,8 @@ module OrigenAppGenerators
   module TestEngineering
     # Generates a generic plugin shell
     class TestBlock < Plugin
+      include Common
+
       desc 'An IP test module intended to plugin into a top-level (SoC) application'
 
       def initialize(*args)
@@ -13,8 +15,6 @@ module OrigenAppGenerators
         # The methods to get the common user input that applies to all applications will
         # get called at the start automatically, you have a chance here to ask any additional
         # questions that are specific to the type of application being generated
-        get_ip_names
-        get_sub_block_name
       end
 
       def generate_files
@@ -25,72 +25,15 @@ module OrigenAppGenerators
       end
 
       def final_modifications
-        prepend_to_file "lib/#{@name}.rb", "require 'origen_testers'\n"
-        # Add require line
-        doc_helpers = /gem 'origen_doc_helpers'/
-        inject_into_file 'Gemfile', "\ngem 'origen_jtag'\ngem 'origen_arm_debug'\n",
-                         after: doc_helpers
+        prepend_to_file "app/lib/#{@name}.rb", "require 'origen_testers'\n"
       end
 
       def conclude
         puts "New test module created at: #{destination_root}"
-        puts
-        puts 'Generate an example pattern by running "origen g example"'
       end
 
       protected
 
-      def get_ip_names
-        puts
-        puts 'NAME THE IP BLOCKS THAT THIS MODULE WILL SUPPORT'
-        puts
-        puts "You don't need to name them all up front, but you must declare at least one."
-        puts 'We recommend that you use the official name(s) for the IP(s) as used by your design team.'
-        puts 'Separate multiple names with a comma:    FLASH_C40_512K, FLASH_C40_2M'
-        puts
-
-        valid = false
-        until valid
-          @ip_names = get_text(single: true).strip.split(',').map do |name|
-            n = name.strip.symbolize.to_s.upcase
-            unless n.empty?
-              n
-            end
-          end.compact
-          unless @ip_names.empty?
-            # Should we check anything here?
-            valid = true
-          end
-        end
-        @ip_names
-      end
-
-      def get_sub_block_name
-        puts
-        puts "WHAT SHOULD BE THE PATH TO #{@ip_names.first} WHEN IT IS INSTANTIATED IN AN SOC?"
-        puts
-        puts 'Your IP(s) will be instantiated by a top-level (SoC) model, at which point it should be given a generic nickname'
-        puts 'that will provide an easy way to access it.'
-        puts 'For example, if you had an IP model for an NVM block, the IP name might be "FLASH_C40_512K_128K", but when it is'
-        puts 'instantiated it would be given the name "flash", allowing it be easily accessed as "dut.flash".'
-        puts
-
-        valid = false
-        until valid
-          @sub_block_name = get_text(single: true).strip.split(',').map do |name|
-            n = name.strip.symbolize.to_s.downcase
-            unless n.empty?
-              n
-            end
-          end.compact
-          unless @sub_block_name.empty?
-            # Should we check anything here?
-            valid = true
-          end
-        end
-        @sub_block_name = @sub_block_name.first
-      end
-
       # Defines the filelist for the generator, the default list is inherited from the
       # parent class (Plugin).
       # The filelist can contain references to generate files, directories or symlinks in the
@@ -109,51 +52,7 @@ module OrigenAppGenerators
       # Additional files can be added or removed from the filelist as shown below.
       def filelist
         @filelist ||= begin
-          list = super  # Always pick up the parent list
-          # Example of how to remove a file from the parent list
-          list.delete(:target_debug)
-          list.delete(:target_production)
-          # Example of how to add a file, in this case the file will be compiled and copied to
-          # the same location in the new app
-          list[:target_default] = { source: 'target/default.rb' }
-          list[:environment_v93k] = { source: 'environment/v93k.rb' }
-          list[:environment_j750] = { source: 'environment/j750.rb' }
-          list[:environment_ultraflex] = { source: 'environment/ultraflex.rb' }
-          list[:program_prb1] = { source: 'program/prb1.rb' }
-          list[:lib_interface] = { source: 'lib/interface.rb', dest: "lib/#{@name}/interface.rb" }
-          # Alternatively specifying a different destination, typically you would do this when
-          # the final location is dynamic
-          # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
-          # Example of how to create a directory
-          list[:pattern_dir] = { dest: 'pattern', type: :directory }
-          # Example of how to create a symlink
-          list[:environment_default] = { source: 'ultraflex.rb',           # Relative to the file being linked to
-                                         dest:   'environment/default.rb', # Relative to destination_root
-                                         type:   :symlink }
-          list[:dev_dut] = { source:  'lib_dev/dut.rb',
-                             dest:    "lib/#{@name}_dev/dut.rb",
-                             options: { class_name: @ip_names.first, sub_block_name: @sub_block_name }
-                           }
-          list[:dev_dutc] = { source: 'lib_dev/dut_controller.rb',
-                              dest:   "lib/#{@name}_dev/dut_controller.rb"
-                            }
-
-          @ip_names.each_with_index do |name, i|
-            list["ip_#{i}"] = { source:  'lib/model.rb',
-                                dest:    "lib/#{@name}/#{name.underscore}.rb",
-                                options: { name: name }
-                              }
-
-            list["ip_controller_#{i}"] = { source:  'lib/controller.rb',
-                                           dest:    "lib/#{@name}/#{name.underscore}_controller.rb",
-                                           options: { name: name }
-                                         }
-          end
-
-          list[:pattern_example] = { source:  'pattern/example.rb',
-                                     options: { sub_block_name: @sub_block_name }
-                                   }
-          # Remember to return the final list
+          list = common_filelist(super)  # Always pick up the parent list
           list
         end
       end

data/templates/app_generators/application/Gemfile

@@ -1,15 +1,27 @@
+<% if (@audience != :external) && (Origen.site_config.gem_server_pull || Origen.site_config.gem_server) -%>
+<%   Array(Origen.site_config.gem_server_pull || Origen.site_config.gem_server).each do |server| -%>
+source '<%= server %>'
+<%   end -%>
+<% else %>
 source 'https://rubygems.org'
-<% if (@audience != :external) && Origen.site_config.gem_server -%>
-source '<%= Origen.site_config.gem_server %>'
 <% end -%>
 
 gem 'origen', '>= <%= @latest_origen_version %>'
 
-gem 'origen_doc_helpers'
-
 gem 'byebug'
 
-gem 'origen_updater'
+gem 'origen_doc_helpers'
+<% if @development_dependencies -%>  
+  <% @development_dependencies.each do |dep| -%>
+gem <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+  <% end -%>
+<% end -%>
+
+<% if (@audience != :external) && Origen.site_config.gem_push_plugins -%>
+<%   Origen.site_config.gem_push_plugins.each do |plugin| -%>
+gem <%= Array(plugin).map{ |d| "\"#{d}\"" }.join(', ') %>
+<%   end -%>
+<% end -%>
 
 # Uncomment these if you want to use a visual debugger (e.g. Visual Studio Code) to debug your app
 #gem 'ruby-debug-ide'

data/templates/app_generators/application/{lib → app/blocks}/top_level.rb

@@ -4,7 +4,7 @@ module <%= @namespace %>
     #
     #   origen i
     #
-    #   > $dut.hi
+    #   > dut.hi
     def hi
       puts "Hello master!"
     end

data/templates/app_generators/application/app/lib/module.rb

@@ -0,0 +1,6 @@
+require 'origen'
+<% if @type == :plugin -%>
+require_relative '../../config/application.rb'
+<% end -%>
+module <%= @namespace %>
+end

data/templates/app_generators/application/config/application.rb

@@ -1,20 +1,19 @@
 require 'origen'
 class <%= @namespace %>Application < Origen::Application
-
   # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
   # for a full list of the configuration options available
 
   # These attributes should never be changed, the duplication here will be resolved in future
   # by condensing these attributes that do similar things
-  self.name       = "<%= @name %>"
-  self.namespace  = "<%= @namespace %>"
-  config.name     = "<%= @name %>"
-  config.initials = "<%= @namespace %>"
+  self.name       = '<%= @name %>'
+  self.namespace  = '<%= @namespace %>'
+  config.name     = '<%= @name %>'
+  config.initials = '<%= @namespace %>'
   # Change this to point to the revision control repository for this <%= @type %>
 <% if @audience == :external -%>
-  #config.rc_url   = "ssh://git@github.com:myaccount/<%= @name %>.git" 
+  # config.rc_url   = "ssh://git@github.com:myaccount/<%= @name %>.git"
 <% else -%>
-  #config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
+  # config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
 <% end -%>
 <% if @audience == :external -%>
   config.release_externally = true
@@ -23,11 +22,11 @@ class <%= @namespace %>Application < Origen::Application
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
 <% if @audience == :external -%>
-  #config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/<%= @name %>"
-  #config.web_domain = "http://origen-sdk.org/<%= @name %>"
+  # config.web_directory = 'git@github.com:Origen-SDK/Origen-SDK.github.io.git/<%= @name %>'
+  # config.web_domain = 'http://origen-sdk.org/<%= @name %>'
 <% else -%>
-  #config.web_directory = "/path/to/server/<%= @name %>"
-  #config.web_domain = "http://origen.mycompany.net/<%= @name %>"
+  # config.web_directory = '/path/to/server/<%= @name %>'
+  # config.web_domain = 'http://origen.mycompany.net/<%= @name %>'
 <% end -%>
 
   # When false Origen will be less strict about checking for some common coding errors,
@@ -38,76 +37,74 @@ class <%= @namespace %>Application < Origen::Application
   # See: http://origen-sdk.org/origen/latest/guides/utilities/lint/
   config.lint_test = {
     # Require the lint tests to pass before allowing a release to proceed
-    run_on_tag: true,
+    run_on_tag:   true,
     # Auto correct violations where possible whenever 'origen lint' is run
-    auto_correct: true, 
-    # Limit the testing for large legacy applications
-    #level: :easy,
+    auto_correct: true,
     # Run on these directories/files by default
-    #files: ["lib", "config/application.rb"],
+    files:        ['app', 'config/application.rb']
   }
 
   config.semantically_version = true
 
   # An example of how to set application specific LSF parameters
-  #config.lsf.project = "msg.te"
-  
+  # config.lsf.project = "msg.te"
+
   # An example of how to specify a prefix to add to all generated patterns
-  #config.pattern_prefix = "nvm"
+  # config.pattern_prefix = "nvm"
 
   # An example of how to add header comments to all generated patterns
-  #config.pattern_header do
-  #  cc "This is a pattern created by the example origen application"
-  #end
+  # config.pattern_header do
+  #   cc "This is a pattern created by the example origen application"
+  # end
 
   # By default all generated output will end up in ./output.
   # Here you can specify an alternative directory entirely, or make it dynamic such that
-  # the output ends up in a setup specific directory. 
-  #config.output_directory do
-  #  "#{Origen.root}/output/#{$dut.class}"
-  #end
+  # the output ends up in a setup specific directory.
+  # config.output_directory do
+  #   "#{Origen.root}/output/#{$dut.class}"
+  # end
 
   # Similarly for the reference files, generally you want to setup the reference directory
   # structure to mirror that of your output directory structure.
-  #config.reference_directory do
-  #  "#{Origen.root}/.ref/#{$dut.class}"
-  #end
- 
+  # config.reference_directory do
+  #   "#{Origen.root}/.ref/#{$dut.class}"
+  # end
+
   # This will automatically deploy your documentation after every tag
-  #def after_release_email(tag, note, type, selector, options)
-  #  command = "origen web compile --remote --api"
-  #  Dir.chdir Origen.root do
-  #    system command
-  #  end
-  #end
-<% if @validate_release_tests %>  
+  # def after_release_email(tag, note, type, selector, options)
+  #   command = "origen web compile --remote --api"
+  #   Dir.chdir Origen.root do
+  #     system command
+  #   end
+  # end
+<% if @validate_release_tests -%>
   # Ensure that all tests pass before allowing a release to continue
   def validate_release
     if <%= Array(@validate_release_tests).map { |t| "!system('#{t}')" }.join(' || ') %>
       puts "Sorry but you can't release with failing tests, please fix them and try again."
       exit 1
     else
-      puts "All tests passing, proceeding with release process!"
+      puts 'All tests passing, proceeding with release process!'
     end
   end
-<% else %>
+<% else -%>
   # Ensure that all tests pass before allowing a release to continue
-  #def validate_release
-  #  if !system("origen specs") || !system("origen examples")
-  #    puts "Sorry but you can't release with failing tests, please fix them and try again."
-  #    exit 1
-  #  else
-  #    puts "All tests passing, proceeding with release process!"
-  #  end
-  #end
+  # def validate_release
+  #   if !system('origen specs') || !system('origen examples')
+  #     puts "Sorry but you can't release with failing tests, please fix them and try again."
+  #     exit 1
+  #   else
+  #     puts 'All tests passing, proceeding with release process!'
+  #   end
+  # end
 <% end -%>
 
   # To enabled source-less pattern generation create a class (for example PatternDispatcher)
   # to generate the pattern. This should return false if the requested pattern has been
   # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.
-  #def before_pattern_lookup(requested_pattern)
-  #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
-  #end
+  # def before_pattern_lookup(requested_pattern)
+  #   PatternDispatcher.new.dispatch_or_return(requested_pattern)
+  # end
 
   # If you use pattern iterators you may come across the case where you request a pattern
   # like this:
@@ -115,11 +112,10 @@ class <%= @namespace %>Application < Origen::Application
   #
   # However it cannot be found by Origen since the pattern name is actually example_pat_bx.atp
   # In the case where the pattern cannot be found Origen will pass the name to this translator
-  # if it exists, and here you can make any substitutions to help Origen find the file you 
+  # if it exists, and here you can make any substitutions to help Origen find the file you
   # want. In this example any instances of _b\d, where \d means a number, are replaced by
   # _bx.
-  #config.pattern_name_translator do |name|
-  #  name.gsub(/_b\d/, "_bx")
-  #end
-
+  # config.pattern_name_translator do |name|
+  #   name.gsub(/_b\d/, "_bx")
+  # end
 end