origen 0.34.3 → 0.52.0

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,177 @@
+# 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 output/my_app directory.
+
+Usage: origen app_gen:test [options]
+       origen app_gen:test --regression             # Test all generators
+       origen app_gen:test --inputs 0               # Test with user inputs set 0
+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
+
+  output_dir = File.join(Origen.root, 'output')
+  FileUtils.rm_rf output_dir if File.exist?(output_dir)
+  FileUtils.mkdir_p output_dir
+
+  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 origen exec tmp/new_app_tests.rb'
+          cmds << 'origen web compile --no-serve'
+          cmds
+        elsif op.to_s == 'load_target'
+          target_load_test_required = true
+          'origen exec tmp/new_app_tests.rb'
+        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.mkdir_p('output/my_app/tmp')
+            FileUtils.cp "#{Origen.root!}/lib/origen_app_generators/new_app_tests.rb", 'output/my_app/tmp'
+          end
+
+          operation_failed = false
+          Bundler.with_clean_env do
+            Dir.chdir "#{Origen.root}/output/my_app" 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 = 2
+  MINOR = 0
+  BUGFIX = 0
+  DEV = nil
+
+  VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
+end

data/origen_app_generators/doc/history

@@ -0,0 +1,223 @@
+<a class="anchor release_tag" name="v2_0_0"></a>
+<h1><a href="#v2_0_0">Tag: v2.0.0</a></h1>
+
+##### Branch: 'master'
+
+##### by Stephen McGinty on 27-May-2019 09:28AM
+
+
+Generated apps now come with an app/ dir as supported by Origen >= 0.50.0
+
+<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
+
+