origen 0.38.0 → 0.40.0

data/origen_app_generators/config/application.rb

@@ -0,0 +1,153 @@
+require 'origen'
+class OrigenAppGeneratorsApplication < Origen::Application
+  # This information is used in headers and email templates, set it specific
+  # to your application
+  config.name     = "Origen App Generators"
+  config.initials = "Origen_App_Generators"
+  config.rc_url   = "ssh://git@github.com:Origen-SDK/origen_app_generators.git"
+  config.release_externally = true
+
+  # To enable deployment of your documentation to a web server (via the 'origen web'
+  # command) fill in these attributes. The example here is configured to deploy to
+  # the origen.freescale.net domain, which is an easy option if you don't have another
+  # server already in mind. To do this you will need an account on CDE and to be a member
+  # of the 'origen' group.
+  config.web_directory = "/proj/.web_origen/html/origen_app_generators"
+  config.web_domain = "http://origen-sdk.org/origen_app_generators"
+
+  # When false Origen will be less strict about checking for some common coding errors,
+  # it is recommended that you leave this to true for better feedback and easier debug.
+  # This will be the default setting in Origen v3.
+  config.strict_errors = true
+
+  # See: http://origen.freescale.net/origen/latest/guides/utilities/lint/
+  config.lint_test = {
+    # Require the lint tests to pass before allowing a release to proceed
+    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,
+    # Run on these directories/files by default
+    #files: ["lib", "config/application.rb"],
+  }
+
+  # Versioning is based on a timestamp by default, if you would rather use semantic
+  # versioning, i.e. v1.0.0 format, then set this to true.
+  # In parallel go and edit config/version.rb to enable the semantic version code.
+  config.semantically_version = true
+
+  config.shared = {
+    #patterns: "pattern",
+    #templates: "templates",
+    #programs: "program",
+    command_launcher: "config/shared_commands.rb"
+  }
+
+  # An example of how to set application specific LSF parameters
+  #config.lsf.project = "msg.te"
+  
+  # An example of how to specify a prefix to add to all generated patterns
+  #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
+
+  # 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
+
+  # Similary 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
+ 
+  # This will automatically deploy your documentation after every tag
+  #def after_release_email(tag, note, type, selector, options)
+  #  deployer = Origen.app.deployer
+  #  if deployer.running_on_cde? && deployer.user_belongs_to_origen?
+  #    command = "origen web compile --remote --api"
+  #    if Origen.app.version.production?
+  #      command += " --archive #{Origen.app.version}"
+  #    end
+  #    Dir.chdir Origen.root do
+  #      system command
+  #    end
+  #  end 
+  #end
+
+  # 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
+
+  # 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
+
+  # If you use pattern iterators you may come accross the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # 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 
+  # 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
+
+  # If you want to use pattern iterators, that is the ability to generate multiple pattern
+  # variants from a single source file, then you can define the required behavior here.
+  # The examples below implement some of the iterators that were available in Origen 1,
+  # you can remove them if you don't want to use them, or of course modify or add new 
+  # iterators specific to your application logic.
+  
+  # By setting iterator
+  config.pattern_iterator do |iterator|
+    # Define a key that you will use to enable this in a pattern, here the iterator
+    # can be enabled like this: Pattern.create(by_setting: [1,2,3]) do
+    iterator.key = :by_setting
+
+    # The value passed from the pattern via the key comes in here as the first
+    # argument, the name applied here can be anything, but settings seem reasonable since
+    # an array of setting values is expected.
+    # The last argument &pattern is mandatory and represents the pattern block (the bit contained
+    # within Pattern.create do ... end)
+    iterator.loop do |settings, &pattern|
+      # Implement the loop however you like, here we loop for each value in the array
+      settings.each do |setting|
+        # Now call the pattern passing in the setting argument, this would be captured
+        # in the pattern like this:
+        #   Pattern.create do |setting|
+        pattern.call(setting)
+      end
+    end
+
+    # Each pattern iteration needs a unique name, otherwise Origen will simply overwrite 
+    # the same output file each time.
+    # The base pattern name and the pattern argument, in this case the setting, will be
+    # passed in here and whatever is returned is what will be used as the name.
+    iterator.pattern_name do |name, setting|
+      # Substiture _x in the name with the setting, _1, _2, etc.
+      name.gsub("_x", "_#{setting}")
+    end
+  end
+
+
+end

data/origen_app_generators/config/boot.rb

@@ -0,0 +1 @@
+require "origen_app_generators"

data/origen_app_generators/config/commands.rb

@@ -0,0 +1,63 @@
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/origen/commands.rb in your Origen core workspace for more examples and 
+# inspiration.
+#
+# Also see the official docs on adding commands:
+#   http://origen.freescale.net/origen/latest/guides/custom/commands/
+
+# Map any command aliases here, for example to allow origen -x to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "-x" => "execute",
+}
+
+# The requested command is passed in here as @command, this checks it against
+# the above alias table and should not be removed.
+@command = aliases[@command] || @command
+
+## Now branch to the specific task code
+case @command
+
+# Run the unit tests  
+when "specs"
+  require "rspec"
+  exit RSpec::Core::Runner.run(['spec'])
+
+## Run the example-based (diff) tests
+#when "examples"  
+#  Origen.load_application
+#  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "origen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{Origen.top}/lib/origen/commands/generate.rb"
+#
+#  if Origen.app.stats.changed_files == 0 &&
+#     Origen.app.stats.new_files == 0 &&
+#     Origen.app.stats.changed_patterns == 0 &&
+#     Origen.app.stats.new_patterns == 0
+#
+#    Origen.app.stats.report_pass
+#  else
+#    Origen.app.stats.report_fail
+#    status = 1
+#  end
+#  puts
+#  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+#
+## Always leave an else clause to allow control to fall back through to the
+## Origen command handler.
+## You probably want to also add the command details to the help shown via
+## origen -h, you can do this be assigning the required text to @application_commands
+## before handing control back to Origen. Un-comment the example below to get started.
+else
+  @application_commands = <<-EOT
+ specs        Run the specs (tests), -c will enable coverage
+  EOT
+
+end 

data/origen_app_generators/config/shared_commands.rb

@@ -0,0 +1,172 @@
+# The requested command is passed in here as @command
+case @command
+
+when "app_gen:test"
+  options = {}
+
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = <<-END
+Test the generators by emulating the 'origen new' command execution and building the new
+application into the tmp directory.
+
+Usage: origen app_gen:test [options]
+END
+    opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+    opts.on('-i', '--inputs INDEX', Integer, "Apply the set of test inputs defined in #{Origen.app.namespace}::TEST_INPUTS[INDEX]") { |f| options[:inputs] = f }
+    opts.on('-r', '--regression', "Run all sets of test inputs defined in #{Origen.app.namespace}::TEST_INPUTS[INDEX]") { options[:regression] = true }
+    opts.on('-a', '--all_generators', "Include the generators from Origen core") { options[:all_generators] = true }
+    opts.separator ''
+    opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  end
+
+  opt_parser.orig_parse! ARGV
+
+  FileUtils.rm_rf "#{Origen.root}/tmp" if File.exist?("#{Origen.root}/tmp")
+
+  if options[:inputs] || options[:regression]
+    if options[:regression]
+      inputs = Origen.app.namespace.constantize::TEST_INPUTS
+    else
+      inputs = [Origen.app.namespace.constantize::TEST_INPUTS[options[:inputs].to_i]]
+    end
+
+    prefix = 'bundle exec ' unless Origen.site_config.gem_manage_bundler
+
+    overall_fail = false
+
+    inputs.each do |vals|
+      test_failed = false
+      post_build_operations = Array(vals.pop)
+      target_load_test_required = false
+      post_build_operations = post_build_operations.map do |op|
+        if op.to_s == 'default'
+          target_load_test_required = true
+          cmds = ['origen -v']
+          # For some reason this command doesn't work in Travis CI, don't know why and
+          # couldn't work out how to fix (looks like a Bundler-related issue)
+          cmds << 'origen lint --no-correct' unless ENV['TRAVIS']
+          cmds << 'bundle exec rake new_app_tests:load_target'
+          cmds << 'origen web compile --no-serve'
+          cmds
+        elsif op.to_s == 'load_target'
+          target_load_test_required = true
+          'rake new_app_tests:load_target'
+        else
+          op
+        end
+      end.flatten
+
+      str = vals.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
+      cmd = "#{prefix} origen app_gen:test"
+      cmd += ' --debugger' if options[:debugger]
+      cmd += ' --all_generators' if options[:all_generators]
+      passed = false
+      Bundler.with_clean_env do
+        passed = system "echo '#{str}' | #{cmd}"
+      end
+
+      if passed
+        # The app is successfully built, now see if it works...
+        unless post_build_operations.empty?
+          if target_load_test_required
+            FileUtils.cp "#{Origen.root!}/lib/tasks/new_app_tests.rake", 'tmp/lib/tasks'
+          end
+
+          operation_failed = false
+          Bundler.with_clean_env do
+            Dir.chdir "#{Origen.root}/tmp" do
+              post_build_operations.each_with_index do |op, i|
+                if i == 0 && !Origen.site_config.gem_manage_bundler
+                  system('bundle')
+                end
+                Origen.log.info "Running command: #{op}"
+                if system("#{prefix}#{op}")
+                  Origen.log.success "Command passed: #{op}"
+                else
+                  Origen.log.error "Command failed: #{op}"
+                  operation_failed = true
+                end
+              end
+            end
+          end
+
+          if operation_failed
+            if options[:regression]
+              overall_fail = true
+            else
+              Origen.app.stats.report_fail
+              exit 1
+            end
+          end
+        end
+      else
+        Origen.log.error "The generator failed to build!"
+        if options[:regression]
+          overall_fail = true
+        else
+          Origen.app.stats.report_fail
+          exit 1
+        end
+      end
+    end
+
+    if options[:regression] && overall_fail
+      Origen.app.stats.report_fail
+      exit 1
+    else
+      Origen.app.stats.report_pass
+      exit 0
+    end
+
+  else
+
+    # Launch the generator in a standalone shell, 
+    # this is to emulate how it will run in real life and cause it to fail if there are
+    # any dependencies on running within an Origen app environment
+    boot = "#{Origen.root!}/bin/boot.rb"
+    origen_lib = "#{Origen.top}/lib"
+    app_gen_lib = "#{Origen.root!}/lib"
+    app_lib = "#{Origen.root}/lib"
+    load_generators = "#{Origen.root}/config/load_generators.rb"
+    cmd = "#{boot} #{origen_lib} #{app_gen_lib} #{app_lib} #{load_generators}"
+    cmd = "#{cmd} true" if options[:all_generators] || Origen.app.name == :origen_app_generators
+    cmd = "ruby #{cmd}" if Origen.os.windows?
+    cmd = "bundle exec #{cmd}" unless Origen.site_config.gem_manage_bundler
+    # puts cmd
+    passed = false
+    Bundler.with_clean_env do
+      passed = system cmd
+    end
+    exit passed ? 0 : 1
+  end
+
+when "app_gen:new"
+  options = {}
+
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = <<-END
+Create a new application generator.
+
+Usage: origen app_gen:new [options]
+END
+    opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+    opts.separator ''
+    opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+  end
+
+  opt_parser.orig_parse! ARGV
+
+  OrigenAppGenerators::New.start []
+  exit 0
+
+# Always leave an else clause to allow control to fall back through to the Origen command handler.
+# You probably want to also add the command details to the help shown via 'origen -h',
+# you can do this bb adding the required text to @plugin_commands before handing control back to
+# Origen.
+else
+  @plugin_commands << <<-EOT
+ app_gen:test Test run the 'origen new' command operation using your latest generators
+ app_gen:new  Create a new application or plugin generator
+  EOT
+
+end

data/origen_app_generators/config/version.rb

@@ -0,0 +1,8 @@
+module OrigenAppGenerators
+  MAJOR = 1
+  MINOR = 2
+  BUGFIX = 0
+  DEV = nil
+
+  VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
+end

data/origen_app_generators/doc/history

@@ -0,0 +1,213 @@
+<a class="anchor release_tag" name="v1_2_0"></a>
+<h1><a href="#v1_2_0">Tag: v1.2.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 20-Jul-2018 10:27AM
+
+
+* Added a fall back way of working out the latest Origen version if the default way
+  of fetching it from rubygems.org fails (e.g. due to https connection issues in
+  runtime environment).
+
+* Removed 'https://rubygems.org' as a Gemfile source when the app/plugin type is internal
+  and Origen.site\_config.gem\_server has been configured. Origen.site\_config.gem\_server can
+  be set to an array of sources, so site configurations can put it back in again if they want it.
+
+* Disabled lint checks in the regression command, couldn't work out why it is failing in
+  CI/Travis, though it still works and is enabled when the regression command
+  (origen app\_gen:test -r) is run locally.
+
+<a class="anchor release_tag" name="v1_1_4"></a>
+<h1><a href="#v1_1_4">Tag: v1.1.4</a></h1>
+
+##### Branch: 'master'
+
+##### by David Welguisz on 07-Dec-2017 10:23AM
+
+
+#### Bug Fix
+*  Gemfile.lock was bad.  Had windows specific gems.  This one is clean.
+
+<a class="anchor release_tag" name="v1_1_3"></a>
+<h1><a href="#v1_1_3">Tag: v1.1.3</a></h1>
+
+##### Branch: 'master'
+
+##### by David Welguisz on 17-Oct-2017 11:33AM
+
+
+#### Bug Fix
+*  Previous release had it that copying directories could only happen if they had the same destination and source name.  Now source and destination directory can be different. 
+
+<a class="anchor release_tag" name="v1_1_2"></a>
+<h1><a href="#v1_1_2">Tag: v1.1.2</a></h1>
+
+##### Branch: 'master'
+
+##### by David Welguisz on 16-Oct-2017 12:57PM
+
+
+#### Updates
+*  Added the ability to recursively copy a directory in the app generator
+*  Added examples in the comment section of build\_filelist
+
+<a class="anchor release_tag" name="v1_1_1"></a>
+<h1><a href="#v1_1_1">Tag: v1.1.1</a></h1>
+
+##### Branch: 'master'
+
+##### by David Welguisz on 06-Oct-2017 13:05PM
+
+
+#### Updates
+*  Added the ability to recursively copy a directory in the app generator
+*  Added examples in the comment section of build\_filelist
+
+<a class="anchor release_tag" name="v1_1_0"></a>
+<h1><a href="#v1_1_0">Tag: v1.1.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 29-Aug-2017 05:48AM
+
+
+* Improvements to the custom app generators application template
+* Improved the source path lookup for custom app generators, now includes
+  a base dir and should now add dirs for any additional sub-classing that
+  is added
+* All directories will now include .keep files by default, though this can
+  be inhibited by setting nokeep: true within the directory definition in
+  the filelist
+
+<a class="anchor release_tag" name="v1_0_1"></a>
+<h1><a href="#v1_0_1">Tag: v1.0.1</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 18-Aug-2017 18:46PM
+
+
+Some bug fixes after first trial in the wild, no changes to documented behavior
+
+<a class="anchor release_tag" name="v1_0_0"></a>
+<h1><a href="#v1_0_0">Tag: v1.0.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 17-Aug-2017 13:47PM
+
+
+Added support for company customized application generators
+
+<a class="anchor release_tag" name="v0_4_0"></a>
+<h1><a href="#v0_4_0">Tag: v0.4.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 24-May-2017 17:31PM
+
+
+Added origen\_updater to all new apps and fixed some bugs
+
+<a class="anchor release_tag" name="v0_3_2"></a>
+<h1><a href="#v0_3_2">Tag: v0.3.2</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 06-Jun-2016 21:32PM
+
+
+Fix for \#1
+
+<a class="anchor release_tag" name="v0_3_1"></a>
+<h1><a href="#v0_3_1">Tag: v0.3.1</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 26-May-2016 05:48AM
+
+
+Added .byebug\_history to generated .gitignore
+
+<a class="anchor release_tag" name="v0_3_0"></a>
+<h1><a href="#v0_3_0">Tag: v0.3.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 13-May-2016 00:15AM
+
+
+Added an initial test module template
+
+<a class="anchor release_tag" name="v0_2_3"></a>
+<h1><a href="#v0_2_3">Tag: v0.2.3</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 25-Feb-2016 09:15AM
+
+
+Added maillists
+
+<a class="anchor release_tag" name="v0_2_2"></a>
+<h1><a href="#v0_2_2">Tag: v0.2.2</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 22-Sep-2015 09:46AM
+
+
+Added basic web pages templates to generated apps/plugins
+
+<a class="anchor release_tag" name="v0_2_1"></a>
+<h1><a href="#v0_2_1">Tag: v0.2.1</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 21-Sep-2015 10:34AM
+
+
+Include template .files in the gem build
+
+<a class="anchor release_tag" name="v0_2_0"></a>
+<h1><a href="#v0_2_0">Tag: v0.2.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 21-Sep-2015 08:18AM
+
+
+Initial release of stand alone test engineering app template
+
+<a class="anchor release_tag" name="v0_1_0"></a>
+<h1><a href="#v0_1_0">Tag: v0.1.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 10-Sep-2015 07:47AM
+
+
+Initial working version of stand alone test engineering app generator
+
+<a class="anchor release_tag" name="v0_0_3"></a>
+<h1><a href="#v0_0_3">Tag: v0.0.3</a></h1>
+
+##### Branch: 'master'
+
+##### by r49409 on 24-Jun-2015 10:41AM
+
+
+The generic application and plugin generators now build an app that can boot
+
+<a class="anchor release_tag" name="v0_0_2"></a>
+<h1><a href="#v0_0_2">Tag: v0.0.2</a></h1>
+
+##### Branch: 'master'
+
+##### by r49409 on 24-Jun-2015 08:06AM
+
+
+Initial version that can run, the generated new app could have bugs however
+
+

data/origen_app_generators/lib/origen_app_generators/application.rb

@@ -0,0 +1,62 @@
+module OrigenAppGenerators
+  # The base generator class that should be used by all application generators
+  class Application < Base
+    # Any methods that are not protected will get invoked in the order they are
+    # defined when the generator is run
+
+    protected
+
+    def type
+      :application
+    end
+
+    # This is the default list of files that will get generated for a new application
+    # when you call the compile_filelist method.
+    # To customize this for a domain specific application generator you can either
+    # delete an entry:
+    #
+    #   filelist.delete(:config_application)
+    #   compile_filelist
+    #
+    # Or point it to a different template, the supplied path is relative to templates/app_generators
+    #
+    #   filelist[:config_application][:source] = "dng_test_app/config/application.rb"
+    #   compile_filelist
+    def filelist
+      fail '@name must be defined before calling filelist for the first time' unless @name
+      @filelist ||= {
+        config_application: { source: 'config/application.rb' },
+        config_version:     { source: 'config/version.rb' },
+        config_boot:        { source: 'config/boot.rb' },
+        config_commands:    { source: 'config/commands.rb' },
+        config_dev:         { source: 'config/maillist_dev.txt' },
+        config_prod:        { source: 'config/maillist_prod.txt' },
+        doc_history:        { source: 'doc/history' },
+        target_default:     { source: 'target/default.rb' },
+        # target_default:     { source: 'debug.rb',          # Relative to the file being linked to
+        #                      dest:   'target/default.rb', # Relative to destination_root
+        #                      type:   :symlink },
+        environment_dir:    { dest: 'environment', type: :directory },
+        lib_module:         { source: 'lib/module.rb',
+                              dest:   "lib/#{@name}.rb" },
+        lib_tasks:          { source: 'lib/app.rake',
+                              dest:   "lib/tasks/#{@name}.rake" },
+        spec_helper:        { source: 'spec/spec_helper.rb' },
+        web_index:          { source: 'templates/web/index.md.erb' },
+        web_basic_layout:   { source: 'templates/web/layouts/_basic.html.erb' },
+        web_navbar:         { source: 'templates/web/partials/_navbar.html.erb' },
+        web_release_notes:  { source: 'templates/web/release_notes.md.erb' },
+        rakefile:           { source: 'Rakefile' },
+        gemfile:            { source: 'Gemfile' },
+        gitignore:          { source: '.gitignore' },
+        irbrc:              { source: '.irbrc' },
+        rspec:              { source: '.rspec' },
+        # This sets the initial mode of the new workspace to 'debug'
+        session:            { source: 'origen_core_session',
+                              dest:   '.session/origen_core',
+                              copy:   true
+                            }
+      }
+    end
+  end
+end