origen 0.34.3 → 0.52.0

data/origen_app_generators/templates/app_generators/new/info.md.erb

@@ -0,0 +1,9 @@
+% render "templates/web/layouts/basic.html" do
+
+### OrigenAppGenerators
+
+## TITLE_GOES_HERE
+
+INTRO_GOES_HERE
+
+% end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/application.rb

@@ -0,0 +1,54 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your application generators, it provides a place
+  # to add anything that you want to be added to all of your applications
+  class Application < OrigenAppGenerators::Application
+    include Base
+
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your application generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your application
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your applications.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # 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(:web_doc_layout)
+        # 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[:config_shared_commands] = { source: 'config/shared_commands.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 recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/base.rb

@@ -0,0 +1,55 @@
+module <%= @namespace %>
+  # This is a mixin that is included in both the application and plugin
+  # generators, it provides a place to add things that should apply to
+  # all of your applications and plugins
+  module Base
+    # Any helper methods added to this base module will not be automatically invoked,
+    # you must call them from either the top-level application or plugin generators,
+    # or from a child generator.
+
+    protected
+
+    # Here you can modify the default list of files that are included in all of your
+    # applications AND plugins.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # If the child generator is a plugin, then this list is then modified by the base plugin generator which
+    # you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generators, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # 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(:web_doc_layout)
+        # 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[:config_shared_commands] = { source: 'config/shared_commands.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 recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/module.rb

@@ -0,0 +1,28 @@
+require 'origen_app_generators'
+require '<%= @name %>/base'
+require '<%= @name %>/application'
+require '<%= @name %>/plugin'
+
+module <%= @namespace %>
+  # Define test sets of inputs to test your generators. The last item in each array is
+  # required and always indicates what action should be taken once the application has
+  # been built. nil means take no action, :default means to run a default set of test
+  # operations, and an array of Origen command strings gives you control of exactly
+  # what to run.
+  #
+  # These inputs can be executed individually by running 'origen app_gen:test -i INDEX',
+  # where INDEX is the index number of the set you want to execute from the TEST_INPUTS
+  # array.
+  #
+  # You can also execute all sets of test inputs by running: 'origen app_gen:test -r'
+  TEST_INPUTS = [
+  ] # END_OF_TEST_INPUTS Don't remove this comment, it is used by the app_gen:new command!
+
+  # As you add new generators to this app they will be entered here, this enables the
+  # mechanism to register them with the 'origen new' command.
+  # You should generally not modify this by hand, instead use the 'origen app_gen:new'
+  # command every time you want to create a new generator, and this will be filled in
+  # for you.
+  AVAILABLE = {
+  }
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/plugin.rb

@@ -0,0 +1,64 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your plugin generators, it provides a place
+  # to add anything that you want to be added to all of your plugins
+  class Plugin < OrigenAppGenerators::Plugin
+    include Base
+
+    def initialize(*args)
+      # This makes all of your plugins be configured for internal distribution, i.e. rather
+      # than via rubygems.org
+      @audience = :internal
+      super
+    end
+
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your plugin generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your plugin
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your plugins.
+    #
+    # Since this is a plugin generator, the default list of files comprises the application list,
+    # which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # And this is then modified by the base plugin generator which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new plugin.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generators will automatically stay up
+    # to date with the latest conventions.
+    #
+    # 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(:web_doc_layout)
+        # 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[:config_shared_commands] = { source: 'config/shared_commands.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 recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                          dest:   'target/default.rb', # Relative to destination_root
+        #                          type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb

@@ -0,0 +1,6 @@
+# This file is used to hook the generators defined in this plugin into the
+# 'origen new' command, it must not be removed or modified
+require 'origen_app_generators'
+require "<%= @name %>"
+template_dir = File.expand_path('../../app/templates/app_generators', __FILE__)
+OrigenAppGenerators.add_generators(<%= @namespace %>::AVAILABLE, template_dir: template_dir)

data/origen_app_generators/templates/app_generators/plugin/Gemfile

@@ -0,0 +1,32 @@
+<% 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'
+<% end -%>
+
+# Only development dependencies (things your plugin needs only when it is running in its own workspace)
+# should be listed here in the Gemfile
+<% if @audience == :external -%>
+# This gem provides integration with https://coveralls.io/ to monitor
+# your application's test coverage
+gem 'coveralls', require: false
+<% end -%>
+gem 'byebug', '~>8'  # You can remove this version constraint if you don't care about your app
+                     # supporting earlier versions of Ruby 2
+gem 'ripper-tags'
+gem 'origen_doc_helpers'
+<% if (@audience != :external) && Origen.site_config.gem_push_plugins -%>
+<%   Array(Origen.site_config.gem_push_plugins).each do |plugin| -%>
+gem <%= 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'
+#gem 'debase'
+
+# Specify your gem's runtime dependencies in <%= @name %>.gemspec
+# THIS LINE SHOULD BE LEFT AT THE END
+gemspec

data/origen_app_generators/templates/app_generators/plugin/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/<%= @name %>.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/origen_app_generators/templates/app_generators/plugin/app/templates/web/index.md.erb

@@ -0,0 +1,37 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# formatting like this, but in most cases that is not required.
+<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Purpose
+
+This plugin...
+
+### How To Install
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>"
+~~~
+
+or if your application is a plugin, then add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__  In the case of a plugin, you will also need to <code>require '<%= Origen.app.name %>'</code> somewhere in your environment.
+
+
+### How To Use
+
+Add quickstart documentation here...
+
+
+### How To Setup a Development Environment
+
+Describe how a developer would setup a new workspace for this plugin...
+
+% end

data/origen_app_generators/templates/app_generators/plugin/app/templates/web/partials/_navbar_external.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/origen_app_generators/templates/app_generators/plugin/app/templates/web/partials/_navbar_internal.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

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

@@ -0,0 +1,24 @@
+# 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 %>"
+
+module <%= @namespace %>Dev
+  # Example of how to explicitly require a file
+  # require "<%= @name %>_dev/my_file"
+    
+  # Load all files in the lib/<%= @name %>_dev directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/../lib/<%= @name %>_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/origen_app_generators/templates/app_generators/plugin/gemspec.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+config = File.expand_path('../config', __FILE__)
+require "#{config}/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= @name %>"
+  spec.version       = <%= @namespace %>::VERSION
+  spec.authors       = ["<%= User.current.name %>"]
+  spec.email         = ["<%= User.current.email %>"]
+  spec.summary       = "<%= @summary %>"
+<% if @audience == :external -%>
+  #spec.homepage      = "http://origen-sdk.org/<%= @name %>"
+<% else -%>
+  #spec.homepage      = "http://origen.mycompany.net/<%= @name %>"
+<% end -%>
+
+  spec.required_ruby_version     = '>= 2'
+  spec.required_rubygems_version = '>= 1.8.11'
+
+  # Only the files that are hit by these wildcards will be included in the
+  # packaged gem, the default should hit everything in most cases but this will
+  # need to be added to if you have any custom directories
+  spec.files         = Dir["lib/<%= @name %>.rb", "lib/<%= @name %>/**/*.rb", "templates/**/*", "config/**/*.rb",
+                           "bin/*", "lib/tasks/**/*.rake", "pattern/**/*.rb", "program/**/*.rb",
+                           "app/lib/**/*.rb", "app/templates/**/*",
+                           "app/patterns/**/*.rb", "app/flows/**/*.rb", "app/blocks/**/*.rb"
+                          ]
+  spec.executables   = []
+  spec.require_paths = ["lib", "app/lib"]
+
+  # Add any gems that your plugin needs to run within a host application
+  spec.add_runtime_dependency "origen", ">= <%= @latest_origen_version %>"
+<% if @runtime_dependencies -%>  
+  <% @runtime_dependencies.each do |dep| -%>
+spec.add_runtime_dependency <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+  <% end -%>
+<% end -%>
+<% if @post_runtime_dependency_comments -%>  
+  <% @post_runtime_dependency_comments.each do |line| -%>
+# <%= line %>
+  <% end -%>
+<% end -%>
+end

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

@@ -0,0 +1 @@
+OrigenTesters::J750.new

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

@@ -0,0 +1 @@
+OrigenTesters::UltraFLEX.new

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

@@ -0,0 +1 @@
+OrigenTesters::V93K.new

data/origen_site_config.yml

@@ -1,3 +1,15 @@
+# BROADCAST MESSAGES
+
+# All broadcast messages will output to the console for all users every time Origen is invoked
+#broadcast_info:
+# - These lines will be output to the console in regular text
+#broadcast_warning:
+# - These lines will be output to the console in amber text
+#broadcast_danger:
+# - These lines will be output to the console in red text
+#broadcast_success:
+# - These lines will be output to the console in green text
+
 # GENERAL SETUP
 
 # Application generator plugins can be used to extend the available new application templates
@@ -12,10 +24,43 @@
 #  # Or a reference to a plugin's Git repository can be used
 #  - "http://bitbucket.mycompany.net/origen/my_app_generators.git"
 
+# Centralized Site Config
+# Origen +0.36 (versions after 36.0) supports a centralized site config. This site config will be implicitly read and 
+# injected into the site config following the default site configs from Origen.
+# To surpress the number of requests and possible load time delays, the site config can be cached and read on each
+# startup for :centralized_site_config_refresh number of hours.
+centralized_site_config_cache_dir: '~/.origen/cache/site_config'
+
+# Indicates how many hours should pass before the cached site config is refreshed (refetched, redownloaded)
+# The default is to refresh once per day (every 24 hours). Decimal values can be used here to get more granularity
+# if needed.
+# 0 indidcates 'always refresh' (cache will still occur though)
+# -1 indicates never refresh.
+centralized_site_config_refresh: 24
+
+# Indicates whether the SSL certificate should be verified when pulling the centralized site config
+centralized_site_config_verify_ssl: true
+
 # GEM SETUP
 
-# If your company has an internal gem server enter it here
-#gem_server: http://gems.company.net:9292
+# If your company has an internal gem server enter it here:
+#gem_server: https://gems.company.net:9292
+# or here, if you need to use different urls for push and pull (write and read):
+#gem_server_push: https://gems.company.net:9292
+#gem_server_pull: https://gems.company.net:9292
+
+# By default, the Origen 'rake gem:release' task (called by the 'origen rc tag' command), will use
+# the standard Ruby 'gem push' command to push gems to your company gem server.
+# If you need to use a different command, define it here as a string using, +GEM+ where you want
+# the gem name to be referenced, and +URL+ to reference your company gem server.
+#gem_push_cmd: "gem inabox --host +URL+ +GEM+"
+#gem_push_cmd: "gem nexus +GEM+ --url +URL+ --clear-repo --ignore-ssl-errors"
+
+# If your custom gem_push_cmd requires a gem plugin(s), add the gem names here and they will be
+# included in new applications generated via the 'origen new' command.
+#gem_push_plugins:
+#  - geminabox
+#  - nexus
 
 # When true Origen will configure and run Bundler in a consistent way for every
 # user (recommended)
@@ -62,9 +107,8 @@ gems_use_tool_repo: true
 # it fresh for each user.
 # Note that this option will only be applied if gem_manage_bundler is set to true.
 gem_use_from_system:
-  - [nokogiri, 1.6.4.1] # Only required for earlier versions of Origen
-  - [nokogiri, 1.6.7.2] # Only required for earlier versions of Origen
   - [nokogiri, 1.7.2]
+  - [nokogiri, 1.8.5]
 
 # Additionally any build switches/options that are required to build specific gems
 # in your user environment can be defined here.
@@ -81,10 +125,16 @@ gem_use_from_system:
 #   User.new("ax1234").email  # => "ax1234@company.com"  
 #
 #   # Without email_domain specified
-#   User.new("ax1234@company.com").email  # => "ax1234@company.com"  
+#   User.new("ax1234@company.com").email  # => "ax1234@company.com"
+# If authentication is needed to use the given server, email_authentication can be set to login.
+# If a service user is used to access this account on behalf of the sending users, email_auth_user and email_auth_password
+# can be set. If authentication is indicated but no auth user is given, the current user's email and password are used instead.
 #email_domain: company.com
 #email_server: smtp.company.net
 #email_port: 25
+#email_authentication: login
+#email_auth_user: service_email
+#email_auth_password: service_password
 
 # Required parameters to connect to your company's LDAP system
 #ldap_username: cn=manager,dc=example,dc=com