tla-sbuilder 0.1.0

data/lib/cli/cli-text.rb

@@ -0,0 +1,226 @@
+module Sbuilder
+
+  class CliText
+
+    SBUILDER_RESOLVERS = <<-EOS
+
+    # Define how parameter names are mapped to domain
+    #
+    # SCHEMA:
+    #
+    # resolvers: 
+    #  - type: <resolver load type>
+    #    file: <file name in cnf-dir>
+    #    url:  <path or url>
+    #
+    # <resolver load type>: resolver loader type, valid values: [ 'resolver_yaml' ]
+    # <file name in cnf-dir>: file name in cnf-directory
+    # <path or url>: path relative to cwd, or http url
+    #
+    #
+    # COMMENTS:
+    # - give 'file' xor 'url' property
+    #
+
+    EOS
+
+    SBUILBER_INTERFACES = <<-EOS
+
+    # Define how to load interfaces configuration
+    #
+    # SCHEMA:
+    # 
+    # interfaces: 
+    #  - type: <interface loader type>
+    # 
+    #    file: <file name in cnf-dir>
+    #    infrastructureServices: <is infrastructureService>
+    #    url:  <path or url>
+    #    cache: <cache file path>
+    #
+    # <interface loader type>: interface loader type, valid values: [ 'swagger' ]
+    # <is infrastructureService>: true or false (default false)
+    # <file name in cnf-dir> : file name in cnf-directory
+    # <path or url>          : path relative to cwd, or http url, 
+    #                          e.g https://cdn.rawgit.com/swagger-api/swagger-spec/master/examples/v2.0/yaml/petstore-expanded.yaml
+    # <cache file path>      : path relative to cwd, where interface file is cached
+    # 
+    # COMMENTS:
+    # - give 'file' xor 'url' property
+    # - property 'cache' optional, useful when http access slow
+    # - infrastructureServices are modelled as procedures, which may modify state
+    #   or return values used in 'normal' interfaces
+    #      
+
+    EOS
+
+
+    SBUILER_SETUPS = <<-EOS
+
+    # Define environment setups
+    #
+    # SCHEMA:
+    # setups:
+    #   - setupDirectory: <setupname>
+    #     extensions:
+    #         file: <file name in cnf-dir>
+    #         url:  <path or url>
+    #     preferences:
+    #         <hash-values>
+    #
+    # <setupname>           : name of setup = sub directory under <gen_dir>
+    # <file name in cnf-dir>: name extension configurion file in cnf-directory
+    # <path or url>         : relative name or url of configurion file
+    # <hash-values>         : optional properties overriding global generate preferences
+    #
+    # COMMENTS:
+    # - preferences property is optional
+    EOS
+
+    SBUILDER_GENERATE = <<-EOS
+    # Generate definitions
+    #   
+    # SCHEMA:
+    # generate:
+    #   - output: <path>
+    #     inputs: 
+    #
+    #       - desc: <description text>
+    #         modelData: none
+    #         template: markdown-header.mustache
+    #            input: <name-of-template>
+    #
+    # <path>: relative path under <gen-directory>
+    # <description text>: text avaiblable for template in {{META.desc}} property
+    # <name-of-template>: name of file to output into <path>
+    #
+    # COMMENTS:
+    # - can be used to render also model data using mustache template 
+    #   in this case 
+    #    modelData : <model-data>, where
+    #                valid values for <model-data>: ['none', 'interfaces', 'steps',
+    #                'definitions','domains' ], 
+    #                see document   <gen_dir>/<setup>/doc/data-model.md for content
+    #  template: <mustache-template>, where
+    #            <mustache-template> is a file <src_dir>
+    #
+    EOS
+
+    SBUILDER_PREFERENCES = <<-EOS
+    # Generate preferences
+    #
+    # preferences:
+    #     <hash-values>
+    #
+    # <hash-values> optional properties passes to templates in 'PREFERENCES' -property
+    #
+    # Default templates use following propeties
+    #     debug-output: <true/false>, output call message in interface processes, default 'true'
+    #
+    EOS
+    
+
+    EXTENSION_HEADER_DOM = <<-EOS
+ 
+    # Define extension for domains
+    #
+    # SCHEMA:
+    # - domain-extension:
+    #    - domain: <domain-name>
+    #      cardinality: <cardinality>
+    #      values:
+    #         - <str-value>
+    #
+    # 
+    # <domain-name>: domain name resolved
+    # <cardinality>: integer value for domain, default 1
+    # <str-value>: fixed value for domain
+    #
+    # COMMENTS:
+    # - give 'cardinality' xor 'values' property
+    #
+
+    EOS
+    
+    EXTENSION_HEADER_IF = <<-EOS
+
+    # Define name of extension point for interface
+    #
+    # SCHEMA:
+    # - interface-extension:
+    #      - matcher: <string-or-regex>
+    #        implementation: <name-implmentation>
+    #
+    # <string-or-regex>: string or regexp matching inteface
+    #                    example regex !ruby/regexp /customer?\(post\)/ matches
+    #                    customers(post) and customer(post) 
+    # <name-of-implementation>: must define macro 'p_<name-of-implementation>'
+
+    EOS
+
+    EXTENSION_HEADER_SETUP = <<-EOS
+
+    # Define environment steps 
+    #
+    # SCHEMA:
+    # - step-extension:
+    #      - interface: <interface-name>
+    #        bindExact: true
+    #        input: 
+    #           <input> 
+    #        inputs:
+    #           - input:
+    #                <input>
+    #
+    # 
+    # <interface-name>: name of interface to call in step, e.g. customer(post)
+    # <input>: parameter bindings for interface. See 'sbuilder.rb example pet' 
+    # and `sbuilder.rb example customer` for examples.
+    # 
+    # 
+    # COMMENTS:
+    # - give 'inputs' xor 'input' (first level hash)
+    # - 'bindExact' optional, 
+    #     - use 'bindExact': true when input range for interface
+    #       becomes so big that TLA+ model checker slows down when 
+    #       evaluating the input domain range. 
+    #     - When 'bindExact': true all fields for 'input' property must 
+    #       be given value. Hint use '_default' property in <input>
+    #     - Hint: use 'inputs' when 'bindExact': true use 'inputs' to
+    #       allow non-determinism in process input .
+    #
+
+
+    EOS
+
+    
+    RESOLVER_HEADER = <<-EOS
+    # Example of an YAML resolver
+    #
+    # Contains array of hashes
+    # 
+    # - Name: <name of resolver>
+    #   Matcher: <string/regexp to match a paramset name to resolve>
+    #   Rules: <array of RULE-ELEMENTS>
+    # 
+    #   RULE-ELEMENT: MATCHER | INCLUDE-MAPPER
+    #
+    #   INCLUDE-MAPPER: hash with Include attribute
+    #      Include: <name of mapper>
+    # 
+    #   MATCHER: hash of with Matcher/Domain attributes
+    #      Matcher: <string/regexpp to match paramenter id>
+    #               use !ruby/regexp modifier for a value to make it
+    #               to a regular expression. For exapmle
+    #
+    #                Matcher: !ruby/regexp /.*/
+    #
+    #      Domain: domain to assign to parameter
+    #
+    EOS
+
+    
+
+  end
+
+end

data/lib/cli/cli.rb

@@ -0,0 +1,298 @@
+require 'thor'
+
+require_relative '../sbuilder'
+
+module Sbuilder
+
+  class Cli < Thor
+
+    
+    include Sbuilder::Utils::MyLogger    # mix logger
+    PROGNAME = "main"                   # logger progname
+
+    VERSION_BANNER =  <<-EOS.unindent
+    #{File.basename $0} - #{Sbuilder::version}   
+    EOS
+    
+    # ------------------------------------------------------------------
+    # make two thor tasks share options?
+    # http://stackoverflow.com/questions/14346285/how-to-make-two-thor-tasks-share-options
+
+    class << self
+      def add_shared_option(name, options = {})
+        @shared_options = {} if @shared_options.nil?
+        @shared_options[name] =  options
+      end
+
+      def shared_options(*option_names)
+        option_names.each do |option_name|
+          opt =  @shared_options[option_name]
+          raise "Tried to access shared option '#{option_name}' but it was not previously defined" if opt.nil?
+          yield option_name, opt if block_given?
+          option option_name, opt
+        end
+      end
+    end
+
+
+    # ------------------------------------------------------------------
+    # constructore
+
+    def initialize(*args)
+      super
+      @logger = getLogger( PROGNAME, options )
+    end
+
+    # ------------------------------------------------------------------
+    # class options
+
+    class_option :log, :aliases => "-l", :type =>:string, :default => nil, 
+                 :enum => [ "DEBUG", "INFO", "WARN", "ERROR" ],
+                 :desc => "Set debug level "
+
+    class_option :logfile, :type =>:string,
+                 :default => File.join(Dir.getwd, Sbuilder::Constants::LOGFILE), :desc => "Set file for log output"
+
+    
+    # ------------------------------------------------------------------
+    # shared options
+
+    add_shared_option :verbosity, :aliases => "-v", :type =>:numeric, :default => Sbuilder::Constants::OPT_VERBOSITY,
+                      :desc => "Output verbosity range 0-2 (nothing- a lot)"
+    add_shared_option :cnf_dir, :aliases => "-C", :type =>:string, :default => Sbuilder::Constants::CNF_DIR, 
+                      :desc => "Configuration directory"
+    add_shared_option :src_dir, :aliases => "-S", :type =>:string, :default => Sbuilder::Constants::SRC_DIR, 
+                      :desc => "Source directory for TLA+ snippets"
+    add_shared_option :gen_dir, :aliases => "-G", :type =>:string, :default => Sbuilder::Constants::GEN_DIR, 
+                      :desc => "Generation output directory"
+    add_shared_option :cache_dir, :aliases => "-T", :type =>:string, :default => Sbuilder::Constants::CACHE_DIR, 
+                      :desc => "Cache directory"
+    
+    add_shared_option :templates, :aliases => "-t", :type => :array, :default => [Sbuilder::Constants::SRC_PATH, Sbuilder::Constants::TEMPLATE_PATH],
+                      :desc => "Location of TLA+ snippets (accessible in template generation)"
+    
+    add_shared_option :default_templates, :aliases => "-d", :type => :array, :default => [Sbuilder::Constants::TEMPLATE_GEM],
+                      :desc => "Location of (default) GEM templates"
+    add_shared_option :cnf_file, :aliases => "-c", :type => :string, :default => Sbuilder::Constants::CNF_FILE,
+                      :desc => "Main configuration file (in [--cnf-dir])"
+
+    # ------------------------------------------------------------------
+    # require after shared options added, before subcommand
+
+    require_relative 'cli-example'
+
+    
+
+    # ------------------------------------------------------------------
+    # action 'config'
+    desc "example SUBCOMMAND", "Configuration instructions"
+    shared_options :cnf_dir
+    shared_options :src_dir
+    shared_options :verbosity
+    subcommand "example", Example
+
+    # # ------------------------------------------------------------------
+    # # 
+    # require_relative 'cli-unmustache'
+    
+    # desc "unmustache", "Preprocess mustache files"
+    # shared_options :src_dir
+    # shared_options :cache_dir
+    # subcommand "unmustache", Unmustache
+    
+    
+    # ------------------------------------------------------------------
+    # action load
+    # desc :load, "Load configurations"
+    # def load()
+    #   ctrl = getController( options )
+    #   ctrl.load
+    # end
+
+    # make default task to be version
+    default_task :version
+    
+    # ------------------------------------------------------------------
+    # action init - create directories
+    desc :extend, "Create TLA extension templates under '<src_dir>/extend' directory, and application templates into '<src>' directory"
+    shared_options :src_dir
+    option :benchmark,  :aliases => "-b", :type =>:string, :default => nil,
+           :desc => "Include mustache partial call to benchmark directories into TLA template"
+    def extend()
+      
+
+      Dir.glob( File.join File.dirname( __FILE__), "../../src-extend/extend/extend_*.*" ).each do |extendTemplate|
+        extend_files( "#{options[:src_dir]}/extend", extendTemplate, options[:benchmark] )
+      end
+      
+      Dir.glob( File.join File.dirname( __FILE__), "../../src-extend/extend_app/*" ).each do |extendTemplate|
+        extend_files( "#{options[:src_dir]}", extendTemplate )
+      end
+      
+    end
+
+    # ------------------------------------------------------------------
+    # action init - create directories
+    desc :version, "Output version"
+    def version()
+      puts VERSION_BANNER
+    end
+
+
+    
+    # ------------------------------------------------------------------
+    # action init - create directories
+    desc :init, "Init configuration directories"
+    shared_options :cnf_dir
+    shared_options :src_dir
+    shared_options :cache_dir
+    shared_options :gen_dir            
+    def init()
+
+      init_dirs( options )
+      init_files( options )
+      
+
+    end # init 
+    
+    desc "generate [SETUP]", "Generates specification for [SETUP], defaults all setups" 
+    shared_options :templates
+    shared_options :default_templates    
+    shared_options :verbosity
+    shared_options :cnf_dir
+    shared_options :cnf_file
+    # shared_options :src_dir
+    shared_options :cache_dir
+    shared_options :gen_dir
+
+    option :filter_src, :aliases => "-f", :type => :boolean, :default => false,
+           :desc => "Filter files TLA+ specification code, false-> no filter->include all snippets"
+    
+    
+    option :filter_list, :aliases => "-F", :type => :string, :default => nil,
+           :desc => "List of files to include in TLA+ specification code"
+    
+    def generate( setupDirectory=nil)
+      ctrl = getController( options )
+      ctrl.setup( setupDirectory )
+    end
+
+    # ------------------------------------------------------------------
+    # list
+
+    desc "list setups", "Lists setup"
+    shared_options :verbosity
+    shared_options :cnf_dir
+    def list( what )
+      whats = [ "setups", "setup" ]
+      raise <<-EOS unless whats.include?( what )
+      Unknown command 'list #{what}'
+
+      Valid list targets:  #{whats.join(',')}
+      EOS
+                                        
+      ctrl = getController( options )
+      ctrl.load
+      puts "#{ctrl.getSetups().map { |setup| setup['setupDirectory']}.join(' ')}"
+    end
+
+    
+    
+    # ------------------------------------------------------------------
+    # common routines
+    no_commands do
+
+      # Copy 'extendFile' file to 'dirPath', append {{>benchmark/basename(extendFile}}
+      # 
+      # @param dirPath [String] directory where extension file created
+      # @param extendFile [String] path to file, which copy to 'dirPath'
+      # @param benchmark [String] optional benchmark directory where load partial templates
+      def extend_files( dirPath, extendFile, benchmark=nil )
+        
+        raise "No such directory <src_dir>/extend (#{dirPath})" unless File.exist?( dirPath )
+        
+        @logger.info( "#{__method__} extend file=#{File.basename( extendFile )}" )
+        targetPath = "#{dirPath}/#{File.basename( extendFile )}"
+        msg = "Extension template #{targetPath}"
+        if File.exists?( targetPath) then
+          msg += " already exists - not created"
+        else
+          msg += " does not exist - created"          
+          FileUtils.cp( extendFile, targetPath )
+          
+          if benchmark then
+            partial_call = <<-EOS
+
+            {{! Benchmark option in extend command defined --> added call to partial in benchmark directory }}
+            {{>#{benchmark}/benchmark-#{File.basename(extendFile)} }}
+
+            EOS
+            
+            # append mustache partitial call
+            open( targetPath, 'a' ) { |f|
+              f.puts( partial_call )
+            }
+          end
+        end
+        
+        @logger.info( "#{__method__} #{msg}" )
+        puts msg
+
+      end
+
+      # ------------------------------------------------------------------
+      
+      def init_files( options )
+
+        [
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::Constants::CNF_FILE }.example", :content => [ Sbuilder::CliCustomer::SBUILDER_YAML_CUSTOMER] },
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::CliCustomer::FILE_RESOLVER_CUSTOMER}.example", :content => [ Sbuilder::CliCustomer::RESOLVER_CUSTOMER] },
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::CliCustomer::FILE_EXTENSIONS_CUSTOMER_COMMON}.exmaple", :content => [Sbuilder::CliCustomer::EXTENSIONS_CUSTOMER_COMMON] },
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::CliCustomer::FILE_EXTENSIONS_CUSTOMER_RUN1}.example", :content => [Sbuilder::CliCustomer::EXTENSIONS_CUSTOMER_RUN1] },
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::CliCustomer::FILE_EXTENSIONS_CUSTOMER_RUN2}.example", :content => [Sbuilder::CliCustomer::EXTENSIONS_CUSTOMER_RUN2] },                    
+          { :file => "#{options[:cnf_dir]}/#{Sbuilder::CliCustomer::FILE_INTERFACE_CUSTOMER}.example", :content => [Sbuilder::CliCustomer::INTERFACE_CUSTOMER_SWAGGER] },
+
+        ].each do |example|
+          puts "File #{example[:file]} - created"
+          File.open( example[:file] ,'w' ) { |f| example[:content].each { |lines| f.write( lines )} }
+        end
+        
+      end # init files
+
+      # ------------------------------------------------------------------
+      # 
+      def init_dirs( options )
+        [
+          options[:cnf_dir],
+          options[:cache_dir],                        
+          options[:src_dir],
+          "#{options[:src_dir]}/extend",        
+          options[:gen_dir],
+          
+        ].each do |dir|
+          if ! File.exists?( dir ) then
+            puts "Directory #{dir} - created"
+            Dir.mkdir( dir )
+          else
+            puts "Directory #{dir} - already exists - no need to create"          
+          end
+          
+        end
+      end # init dirs
+
+      # DRY method to get controller
+      def getController( opts )
+        Sbuilder::Controller.new( getFactory( opts ), opts )
+      end
+
+      # DRY method to get factory
+      def getFactory( opts )
+        Sbuilder::Factory.getFactory( opts )
+      end
+      
+    end # no_command
+    
+  end # class Cli
+
+end # module
+