origen_app_generators 0.0.3 → 0.1.0

data/lib/origen_app_generators/test_engineering/{generic_test_block.rb → test_block.rb}

@@ -1,8 +1,8 @@
 module OrigenAppGenerators
   module TestEngineering
     # Generates a generic plugin shell
-    class GenericTestBlock < Plugin
-      desc 'A generic test block'
+    class TestBlock < Plugin
+      desc 'A test block intended to plugin into a top-level application'
 
       def generate_files
         @runtime_dependencies = [

data/lib/tasks/app_generators.rake

@@ -4,9 +4,17 @@ task :new do
 end
 
 desc 'Test run the new app process'
-task :test do
+task :test, [:set] do |t, args|
   _delete_tmp_dir
-  _execute_generator(:invoke)
+  if args[:set]
+    vals = OrigenAppGenerators::TEST_INPUTS[args[:set].to_i]
+    vals.pop # Throw away the test commands
+    str = vals.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
+    result = system "echo '#{str}' | rake test"
+  else
+    result = _execute_generator(:invoke)
+  end
+  exit 1 unless result
 end
 
 desc "Test run a specific generator: rake 'run[TestEngineering::GenericTestBlock]'"
@@ -20,6 +28,34 @@ task :run, [:generator_class] do |_t, args|
   _execute_generator(klass)
 end
 
+desc 'Test that all generators build'
+task :regression do
+  OrigenAppGenerators::TEST_INPUTS.each do |inputs|
+    commands = ['origen -v'] + inputs.pop
+    if ENV['TRAVIS'] && ENV['CONTINUOUS_INTEGRATION']
+      prefix = 'bundle && bundle exec '
+    end
+    str = inputs.map { |i| i == :default ? "\n" : "#{i}\n" }.join('')
+    # Test the app can build
+    unless system "echo '#{str}' | rake test"
+      Origen.app.stats.report_fail
+      exit 1
+    end
+    # Test the app can boot
+    Bundler.with_clean_env do
+      Dir.chdir 'tmp' do
+        commands.each do |command|
+          unless system("#{prefix}#{command}")
+            Origen.app.stats.report_fail
+            exit 1
+          end
+        end
+      end
+    end
+  end
+  Origen.app.stats.report_pass
+end
+
 def _execute_generator(klass)
   # With the generator identified this now launches it in a standalone shell
   # This is to emulate how it will run in real life and cause it to fail if there are
@@ -27,12 +63,15 @@ def _execute_generator(klass)
 
   boot = "#{File.expand_path(File.dirname(__FILE__))}/boot.rb"
   origen_lib = "#{Origen.top}/lib"
+  origen_lib = '/proj/mem_c40tfs_testeng/r49409/origen/lib'
   cmd = "#{boot} #{origen_lib} #{klass}"
   cmd = "ruby #{cmd}" if Origen.running_on_windows?
   # puts cmd
+  result = false
   Bundler.with_clean_env do
-    system cmd
+    result = system cmd
   end
+  result
 end
 
 def _delete_tmp_dir

data/lib/tasks/boot.rb

@@ -21,8 +21,8 @@ FileUtils.rm_rf tmp_dir if File.exist?(tmp_dir)
 FileUtils.mkdir_p tmp_dir
 
 begin
+  require 'origen'
   Dir.chdir tmp_dir do
-    require 'origen'
     # For some reason this is not being defined by required origen anymore
     User = Origen::Users::User unless defined? User
     if RUBY_VERSION >= '2.0.0'

data/templates/app_generators/application/Gemfile

@@ -1,11 +1,10 @@
 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', '>= <%= @latest_origen_version %>'
 
-#gem "doc_helpers"
+gem 'origen_doc_helpers'
 
-if RUBY_VERSION >= '2.0.0'
-  gem 'byebug', '~>3.5'
-else
-  gem 'debugger', '~>1.6'
-end
+gem 'byebug', '~>3.5'

data/templates/app_generators/application/Rakefile

@@ -1,9 +1,5 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/app_tasks.rake, and they will automatically be available to Rake.
-
-# Any task files found in lib/tasks/shared/*.rake will be available to other apps that
-# include this app as a plugin
-
 require "bundler/setup"
 require "origen"
 

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

@@ -10,7 +10,10 @@ class <%= @namespace %>Application < Origen::Application
   self.namespace  = "<%= @namespace %>"
   config.name     = "<%= @name %>"
   config.initials = "<%= @namespace %>"
-  config.rc_url    = "" 
+  config.rc_url   = "" 
+<% if @audience == :external -%>
+  config.release_externally = true
+<% end -%>
 
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
@@ -62,16 +65,10 @@ class <%= @namespace %>Application < Origen::Application
  
   # 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.prefixed}"
-      end
-      Dir.chdir Origen.root do
-        system command
-      end
-    end 
+    command = "origen web compile --remote --api"
+    Dir.chdir Origen.root do
+      system command
+    end
   end
 
   # Ensure that all tests pass before allowing a release to continue

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

@@ -1,11 +1,4 @@
-# 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/
+# This file should be used to extend the origen with application specific commands
 
 # Map any command aliases here, for example to allow 'origen ex' to refer to a 
 # command called execute you would add a reference as shown below: 
@@ -24,7 +17,7 @@ case @command
 # in here or you can require an external file if preferred.
 when "my_command"
   puts "Doing something..."
-  require "commands/my_command"    # Would load file lib/commands/my_command.rb
+  #require "commands/my_command"    # Would load file lib/commands/my_command.rb
   # You must always exit upon successfully capturing a command to prevent 
   # control flowing back to Origen
   exit 0
@@ -32,13 +25,11 @@ when "my_command"
 ## Example of how to make a command to run unit tests, this simply invokes RSpec on
 ## the spec directory
 #when "specs"
-#  ARGV.unshift "spec"
 #  require "rspec"
-#  require "rspec/autorun"
-#  exit 0 # This will never be hit on a fail, RSpec will automatically exit 1
+#  exit RSpec::Core::Runner.run(['spec'])
 
 ## Example of how to make a command to run diff-based tests
-#when "examples"  
+#when "examples", "test"
 #  Origen.load_application
 #  status = 0
 #
@@ -60,6 +51,12 @@ when "my_command"
 #    status = 1
 #  end
 #  puts
+#  if @command == "test"
+#    Origen.app.unload_target!
+#    require "rspec"
+#    result = RSpec::Core::Runner.run(['spec'])
+#    status = status == 1 ? 1 : result
+#  end
 #  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
@@ -71,6 +68,7 @@ else
 #  @application_commands = <<-EOT
 # specs        Run the specs (tests), -c will enable coverage
 # examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
 #  EOT
 
 end 

data/templates/app_generators/application/origen_core_session

@@ -0,0 +1,2 @@
+{: refresh_interval_in_minutesiA:	modeI"
+debug:EF

data/templates/app_generators/plugin/Gemfile

@@ -1,8 +1,17 @@
 source 'https://rubygems.org'
+<% if (@audience != :external) && Origen.site_config.gem_server -%>
+source '<%= Origen.site_config.gem_server %>'
+<% end -%>
 
 # Specify your gem's dependencies in <%= @name %>.gemspec
 gemspec
 
+<% if @audience == :external -%>
+# This gem provides integration with https://coveralls.io/ to monitor
+# your application's test coverage
+gem 'coveralls', require: false
+<% end -%>
+
 # Only these gems should be added here
 if RUBY_VERSION >= '2.0.0'
   gem 'byebug', '~>3.5'

data/templates/app_generators/plugin/Rakefile

@@ -0,0 +1,9 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/app_tasks.rake, and they will automatically be available to Rake.
+#
+# Any task files found in lib/tasks/shared/*.rake will be made available to 3rd party
+# apps that use this plugin
+require "bundler/setup"
+require "origen"
+
+Origen.app.load_tasks

data/templates/app_generators/plugin/config/boot.rb

@@ -0,0 +1,17 @@
+# This file is used to boot your plugin when it is running in standalone mode
+# from its own workspace - i.e. when the plugin is being developed.
+#
+# It will not be loaded when the plugin is imported by a 3rd party app - in that
+# case only lib/<%= @name %>.rb is loaded.
+#
+# Therefore this file can be used to load anything extra that you need to boot
+# the development environment for this app. For example this is typically used
+# to load some additional test classes to use your plugin APIs so that they can
+# be tested and/or interacted with in the console.
+require "<%= @name %>"
+
+# Load a Top-level/DUT class that is defined within this plugin's lib directory
+# and is required by some of our tests.
+# Normally such a class should not be exposed to 3rd party users of the plugin,
+# so we required it here rather than in lib/<%= @name %>.rb.
+#require "<%= @name %>/test/top_level"

data/templates/app_generators/test_engineering/stand_alone_application/Gemfile

@@ -0,0 +1,14 @@
+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_testers'
+
+gem 'origen_debuggers'
+
+gem 'origen_doc_helpers'
+
+gem 'byebug', '~>3.5'

data/templates/app_generators/test_engineering/stand_alone_application/environment/j750.rb

@@ -0,0 +1 @@
+$tester = OrigenTesters::J750.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/jlink.rb

@@ -0,0 +1 @@
+$tester = OrigenDebuggers::JLink.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/uflex.rb

@@ -0,0 +1 @@
+$tester = OrigenTesters::UltraFLEX.new

data/templates/app_generators/test_engineering/stand_alone_application/environment/v93k.rb

@@ -0,0 +1 @@
+$tester = OrigenTesters::V93K.new

data/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block.rb

@@ -0,0 +1,23 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>
+    include Origen::Model
+
+    def initialize(options = {})
+      instantiate_registers(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_registers(options = {})
+    end
+
+    def instantiate_sub_blocks(options = {})
+<% @options[:sub_blocks].each do |name, attrs| -%>
+<%   if attrs[:instances] -%>
+      sub_blocks :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+<%   else -%>
+      sub_block  :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+<%   end -%>
+<% end -%>
+    end
+  end
+end

data/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block_controller.rb

@@ -0,0 +1,5 @@
+module <%= @namespace %>
+  class ATDController
+    include Origen::Controller
+  end
+end

data/templates/app_generators/test_engineering/stand_alone_application/lib/top_level.rb

@@ -0,0 +1,33 @@
+module <%= @namespace %>
+  class <%= @options[:name] || "TopLevel" %>
+    include Origen::TopLevel
+
+    def initialize(options = {})
+      instantiate_pins(options)
+      instantiate_registers(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_pins(options = {})
+      add_pin :tclk
+      add_pin :tdi
+      add_pin :tdo
+      add_pin :tms
+      add_pin :resetb
+      add_pins :port_a, size: 8
+    end
+
+    def instantiate_registers(options = {})
+    end
+
+    def instantiate_sub_blocks(options = {})
+<% @options[:sub_blocks].each do |name, attrs| -%>
+<%   if attrs[:instances] -%>
+      sub_blocks :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+<%   else -%>
+      sub_block  :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+<%   end -%>
+<% end -%>
+    end
+  end
+end

data/templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb

@@ -0,0 +1,21 @@
+module <%= @namespace %>
+  class <%= @options[:name] || "TopLevel" %>Controller
+    include Origen::Controller
+
+    def startup(options)
+      pp "Enter test mode" do
+        $tester.set_timeset("func_25mhz", 40)   # Where 40 is the period in ns
+        pin(:tclk).drive!(1)
+        pin(:resetb).drive!(1)
+        $tester.wait time_in_us: 100
+      end
+    end
+
+    def shutdown(options)
+      pp "Reset the device" do
+        pin(:resetb).drive!(0)
+        pin(:tclk).drive!(0)
+      end
+    end
+  end
+end

data/templates/app_generators/test_engineering/stand_alone_application/pattern/example.rb

@@ -0,0 +1,4 @@
+Pattern.create do
+  # Call controller methods from here...
+  # $dut.atd.convert
+end

data/templates/app_generators/test_engineering/stand_alone_application/target/top_level.rb

@@ -0,0 +1,8 @@
+# The target file is run before *every* Origen operation and is used to instantiate
+# the runtime environment - usually this means instantiating a top-level SoC or
+# IP model.
+#
+# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
+# global variable in Ruby, and this is required in order for the objects instantiated
+# here to be visible throughout your application code.
+$dut = <%= @namespace %>::<%= @options[:name] || "TopLevel" %>.new   # Instantiate a DUT instance

data/templates/web/origen_app_generators/test_engineering/generic_stand_alone_application.md.erb

@@ -0,0 +1,9 @@
+% render "templates/web/layouts/basic.html" do
+
+### OrigenAppGenerators
+
+## Stand Alone Test Engineering Application
+
+This generates a customized version of the [Generic Application](<%= path 'origen_app_generators/application' %>).
+
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.4.1
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -43,61 +43,48 @@ files:
 - lib/origen_app_generators/generic_plugin.rb
 - lib/origen_app_generators/new.rb
 - lib/origen_app_generators/plugin.rb
-- lib/origen_app_generators/test_engineering/generic_test_block.rb
+- lib/origen_app_generators/sub_block_parser.rb
+- lib/origen_app_generators/test_engineering/stand_alone_application.rb
+- lib/origen_app_generators/test_engineering/test_block.rb
 - lib/tasks/app_generators.rake
 - lib/tasks/boot.rb
 - templates/app_generators/application/Gemfile
 - templates/app_generators/application/Rakefile
 - templates/app_generators/application/config/application.rb
+- templates/app_generators/application/config/boot.rb
 - templates/app_generators/application/config/commands.rb
-- templates/app_generators/application/config/environment.rb
-- templates/app_generators/application/config/users.rb
 - templates/app_generators/application/config/version.rb
 - templates/app_generators/application/doc/history
 - templates/app_generators/application/lib/app.rake
 - templates/app_generators/application/lib/module.rb
 - templates/app_generators/application/lib/top_level.rb
+- templates/app_generators/application/origen_core_session
 - templates/app_generators/application/spec/spec_helper.rb
 - templates/app_generators/application/target/debug.rb
 - templates/app_generators/application/target/production.rb
-- templates/app_generators/application/templates/web/archive.md.erb
-- templates/app_generators/application/templates/web/contact.md.erb
-- templates/app_generators/application/templates/web/docs/environment/definitions.md.erb
-- templates/app_generators/application/templates/web/docs/environment/installation.md.erb
-- templates/app_generators/application/templates/web/docs/environment/introduction.md.erb
-- templates/app_generators/application/templates/web/index.md.erb
-- templates/app_generators/application/templates/web/layouts/_basic.html.erb
-- templates/app_generators/application/templates/web/layouts/_doc.html.erb
-- templates/app_generators/application/templates/web/partials/_navbar.html.erb
-- templates/app_generators/application/templates/web/references.md.erb
-- templates/app_generators/application/templates/web/release_notes.md.erb
 - templates/app_generators/new/generator.rb
 - templates/app_generators/new/info.md.erb
 - templates/app_generators/plugin/Gemfile
-- templates/app_generators/plugin/config/development.rb
+- templates/app_generators/plugin/Rakefile
+- templates/app_generators/plugin/config/boot.rb
 - templates/app_generators/plugin/gemspec.rb
-- templates/app_generators/plugin/templates/web/index.md.erb
-- templates/app_generators/plugin/templates/web/partials/_navbar.html.erb
-- templates/app_generators/test_engineering/generic_test_block/lib/interface.rb
-- templates/app_generators/test_engineering/generic_test_block/program/prb1.rb
-- templates/app_generators/test_engineering/generic_test_block/target/j750.rb
-- templates/app_generators/test_engineering/generic_test_block/target/ultraflex.rb
-- templates/app_generators/test_engineering/generic_test_block/target/v93k.rb
-- templates/web/_history.md
-- templates/web/archive.md.erb
-- templates/web/contact.md.erb
-- templates/web/docs/developers/creating.md.erb
-- templates/web/docs/environment/installation.md.erb
-- templates/web/docs/environment/introduction.md.erb
-- templates/web/example.md.erb
-- templates/web/index.md.erb
-- templates/web/layouts/_basic.html.erb
-- templates/web/layouts/_doc.html.erb
-- templates/web/origen_app_generators/application.md.erb
-- templates/web/origen_app_generators/plugin.md.erb
-- templates/web/origen_app_generators/test_engineering/generic_test_block.md.erb
-- templates/web/partials/_navbar.html.erb
-- templates/web/release_notes.md.erb
+- templates/app_generators/test_engineering/stand_alone_application/Gemfile
+- templates/app_generators/test_engineering/stand_alone_application/environment/j750.rb
+- templates/app_generators/test_engineering/stand_alone_application/environment/jlink.rb
+- templates/app_generators/test_engineering/stand_alone_application/environment/uflex.rb
+- templates/app_generators/test_engineering/stand_alone_application/environment/v93k.rb
+- templates/app_generators/test_engineering/stand_alone_application/lib/ip_block.rb
+- templates/app_generators/test_engineering/stand_alone_application/lib/ip_block_controller.rb
+- templates/app_generators/test_engineering/stand_alone_application/lib/top_level.rb
+- templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb
+- templates/app_generators/test_engineering/stand_alone_application/pattern/example.rb
+- templates/app_generators/test_engineering/stand_alone_application/target/top_level.rb
+- templates/app_generators/test_engineering/test_block/lib/interface.rb
+- templates/app_generators/test_engineering/test_block/program/prb1.rb
+- templates/app_generators/test_engineering/test_block/target/j750.rb
+- templates/app_generators/test_engineering/test_block/target/ultraflex.rb
+- templates/app_generators/test_engineering/test_block/target/v93k.rb
+- templates/web/origen_app_generators/test_engineering/generic_stand_alone_application.md.erb
 homepage: http://origen-sdk.org/origen_app_generators
 licenses:
 - LGPL-3