software_smithy 1.1

data/etc/templates/web/machine_version_table.html.erb

@@ -0,0 +1,35 @@
+<h2>Available Versions</h2>
+
+<table class="kb-table kb-table-bordered">
+  <thead>
+    <tr>
+      <td style="text-align:center;"><b>System</b></td>
+      <td style="text-align:center;"><b>Application/Version</b></td>
+      <td style="text-align:center;"><b>Build</b></td>
+      <!-- <%# ModuleFile::Environments.reject{|e| e[:human_name]=="pathscale"}.each do |e| %> -->
+      <!-- <td style="text-align:center;"> -->
+      <!--   <b> -->
+      <!--     <%#= e[:human_name].upcase %> -->
+      <!--   </b> -->
+      <!-- </td> -->
+      <!-- <%# end %> -->
+    </tr>
+  </thead>
+
+  <tbody>
+  <% @machine_table.each do |machine, version_table| %>
+    <% version_table.each do |version, builds| %>
+      <% builds.each do |build| %>
+        <tr>
+          <td style="text-align:center;"><%= machine.humanize %></td>
+          <td style="text-align:center;"><%= "#{@name}/#{version}" %></td>
+          <td style="text-align:center;"><%= build %></td>
+        </tr>
+      <% end %>
+    <% end %>
+  <% end %>
+  </tbody>
+</table>
+
+
+

data/etc/templates/web/package.html.erb

@@ -0,0 +1,53 @@
+<h1>Git</h1>
+
+<p> Category: Program Dev-Tools
+
+<h2>Description</h2>
+
+<p> <a href="http://git.or.cz/">Git</a> is an open source version
+control system designed to handle very large projects with speed and
+efficiency, but just as well suited for small personal repositories;
+it is especially popular in the open source community, serving as a
+development platform for projects like the Linux Kernel, Ruby on
+Rails, WINE or X.org.
+
+<p>Git falls in the category of distributed source code management tools,
+similar to e.g. Mercurial or Bazaar. Every Git working directory is a
+full-fledged repository with complete history and full revision
+tracking capabilities, not dependent on network access or a central
+server. Still, Git stays extremely fast and space efficient.
+
+<h2>Use</h2>
+
+<pre>
+module avail git
+module load git
+git
+</pre>
+
+
+<h2>Support</h2><p>This package has the following support level : Unsupported
+<br>
+<h2>Available Versions</h2>
+
+<table class="inline">
+<tr>
+	<th rowspan = "2">Version</th>
+	<th colspan = "6">Available Builds</th> </tr><tr>
+	<th>pgi</th>
+	<th>pathscale</th>
+	<th>gnu</th>
+	<th>intel</th>
+	<th>cray</th>
+	<th>Other</th>
+<tr>
+	<th>1.7.8</th>
+	<td></td>
+	<td></td>
+	<td><table class="inline"><tr><td class="hidden">gnu4.3.4</td><td class="hidden2">?</td></tr></table></td>
+	<td></td>
+	<td></td>
+	<td><table class="inline"></table></td>
+</tr>
+
+</table>

data/etc/templates/web/version_list.html.erb

@@ -0,0 +1,7 @@
+<h2>Available Versions</h2>
+
+<ul>
+  <% @version_table.each do |version, builds| %>
+  <li><%= "#{@name}/#{version}" %></li>
+  <% end %>
+</ul>

data/etc/templates/web/version_table.html.erb

@@ -0,0 +1,24 @@
+<h2>Available Versions</h2>
+
+Checkmarks indicate a given version is available for the compiler specified in each column.
+
+<table class="kb-table kb-table-bordered">
+  <thead>
+    <tr>
+      <td style="text-align:center;"><b>Version</b></td>
+      <% ModuleFile::Environments.reject{|e| e[:human_name]=="pathscale"}.each do |e| %>
+      <td style="text-align:center;"><b><%= e[:human_name].upcase %></b></td>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+  <% @version_table.each do |version, builds| %>
+  <tr>
+    <td style="text-align:center;"><b><%= "#{@name}/#{version}" %></b></td>
+    <% ModuleFile::Environments.reject{|e| e[:human_name]=="pathscale"}.each do |e| %>
+    <td style="text-align:center;"><% if builds.select{|b|b=~e[:regex]}.size > 0 %><img width="23" height="18" style="margin:0;" title="checkmark" alt="" src="http://www.olcf.ornl.gov/wp-content/uploads/2011/03/checkmark.png"><% end %></td>
+    <% end %>
+  </tr>
+  <% end %>
+  </tbody>
+</table>

data/lib/smithy/config.rb

@@ -0,0 +1,167 @@
+# Smithy is freely available under the terms of the BSD license given below. {{{
+#
+# Copyright (c) 2012. UT-BATTELLE, LLC. All rights reserved.
+#
+# Produced by the National Center for Computational Sciences at Oak Ridge
+# National Laboratory. Smithy is a based on SWTools, more information on SWTools
+# can be found at: http://www.olcf.ornl.gov/center-projects/swtools/
+#
+# This product includes software produced by UT-Battelle, LLC under Contract No.
+# DE-AC05-00OR22725 with the Department of Energy.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - Neither the name of the UT-BATTELLE nor the names of its contributors may
+#   be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# }}}
+
+module Smithy
+  class Config
+    class << self
+      attr_accessor :config_file_name, :config_file_hash, :global, :hostname,
+        :arch, :root, :full_root, :web_root, :file_group, :descriptions_root,
+        :web_architecture_names
+
+      def group_writeable?
+        @global[:"disable-group-writable"] ? false : true
+      end
+
+      def load_configuration(gli_options = {})
+        @global = gli_options
+        options_to_merge = {}
+        load_config_yaml
+
+        return nil unless @config_file_hash
+
+        # Pick some values from the config file
+        options_to_merge[:"software-root"]   = @config_file_hash.try(:[], "software-root")
+        options_to_merge[:"web-root"]        = @config_file_hash.try(:[], "web-root")
+        options_to_merge[:"file-group-name"] = @config_file_hash.try(:[], "file-group-name")
+        options_to_merge[:"descriptions-root"] = @config_file_hash.try(:[], "descriptions-root")
+        options_to_merge[:"web-architecture-names"] = @config_file_hash.try(:[], "web-architecture-names")
+
+        set_hostname_and_arch
+        options_to_merge[:arch] = @arch
+        options_to_merge[:"prgenv-prefix"] = get_prgenv_prefix
+
+        # Merge the config file values with command line values,
+        # options on the command line take precedence.
+        @global.merge!(options_to_merge) do |key, values_command_line, values_config|
+          if values_command_line.nil?
+            values_config
+          else
+            values_command_line
+          end
+        end
+
+        @arch = @global[:arch]
+        @root = @global[:"software-root"]
+        @file_group = @global[:"file-group-name"]
+        @full_root = get_software_root
+        @web_root = @global[:"web-root"]
+        @descriptions_root = @global[:"descriptions-root"]
+        @web_architecture_names = @global[:"web-architecture-names"]
+
+        # Add new info
+        @global[:full_software_root_path] = @full_root
+        @global[:"file-group-id"]   = Etc.getgrnam(options_to_merge[:"file-group-name"]).try(:gid) if @global[:"file-group-name"]
+      end
+
+      def load_config_yaml
+        config_path = File.expand_path(ENV['SMITHY_CONFIG']) if ENV['SMITHY_CONFIG']
+        config_path = File.expand_path(global[:"config-file"]) if global[:"config-file"]
+        config_path = File.expand_path(@config_file_name) if config_path.blank?
+
+        if File.exists? config_path
+          @config_file_name = config_path
+          @config_file_hash = YAML.load_file(config_path).stringify_keys
+        else
+          raise """warning: Cannot read config file: #{@config_file_name}
+          Please update the file or set SMITHY_CONFIG """
+        end
+      end
+
+      def architectures
+        notice_command "Current Hostname: ", @hostname, 30
+        notice_command "Current Architecture: ", @arch, 30
+        notice_command "All Architectures: ", @config_file_hash["hostname-architectures"].values.uniq.sort.join(", "), 30
+      end
+
+      def get_prgenv_prefix
+        default_prefix = "PrgEnv-"
+
+        default_prefix_from_config = @config_file_hash.try(:[], "programming-environment-prefix").try(:[], "default")
+        default_prefix = default_prefix_from_config unless default_prefix_from_config.blank?
+
+        prefix_from_config = @config_file_hash.try(:[], "programming-environment-prefix").try(:[], @arch)
+
+        return prefix_from_config unless prefix_from_config.blank?
+
+        return default_prefix
+      end
+
+      def set_hostname_and_arch
+        @hostname ||= ENV.try(:[], 'HOSTNAME').try(:dup)
+        @hostname ||= `hostname -s`.try(:dup)
+        @hostname.chomp!
+        # Remove trailing numbers (if they exist) and a possible single trailing period
+        @hostname.gsub!(/\.?$/,'')
+        machine = @hostname.gsub(/(\d*)$/,'')
+
+        @arch = global[:arch] if @arch.nil?
+        @arch = @config_file_hash.try(:[], "hostname-architectures").try(:[], machine) if @arch.nil?
+        @arch = @config_file_hash.try(:[], "hostname-architectures").try(:[], @hostname) if @arch.nil?
+      end
+
+      def get_software_root
+        if @root.blank? || @arch.blank?
+          raise """Cannot determine which architecture we are using.
+           Please specify using --arch or add a '#{@hostname}' hostname entry to:
+           #{@config_file_name}"""
+        end
+
+        s = File.join(@root, @arch)
+        raise "The software-root directory '#{s}' does not exist" unless Dir.exist?(s)
+        return s
+      end
+
+      def last_prefix
+        rc_file = File.join(ENV['HOME'], '.smithyrc')
+        if File.exists?(rc_file)
+          h = YAML.load_file(rc_file).stringify_keys rescue nil
+          return h["last"]
+        else
+          return nil
+        end
+      end
+
+      def save_last_prefix(prefix)
+        rc_file = File.join(ENV['HOME'], '.smithyrc')
+        h = {:last => prefix}
+        File.open(rc_file, "w+") do |f|
+          f.write(h.to_yaml)
+        end
+      end
+    end
+  end
+end

data/lib/smithy/description.rb

@@ -0,0 +1,276 @@
+# Smithy is freely available under the terms of the BSD license given below. {{{
+#
+# Copyright (c) 2012. UT-BATTELLE, LLC. All rights reserved.
+#
+# Produced by the National Center for Computational Sciences at Oak Ridge
+# National Laboratory. Smithy is a based on SWTools, more information on SWTools
+# can be found at: http://www.olcf.ornl.gov/center-projects/swtools/
+#
+# This product includes software produced by UT-Battelle, LLC under Contract No.
+# DE-AC05-00OR22725 with the Department of Energy.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - Neither the name of the UT-BATTELLE nor the names of its contributors may
+#   be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# }}}
+
+module Smithy
+  class Description
+    attr_accessor :path, :package, :root, :arch, :www_root, :name, :content,
+      :categories, :versions, :builds, :global_description
+
+    def initialize(args = {})
+      @www_root = Smithy::Config.web_root
+      @package = args[:package]
+      @global_description = true if Smithy::Config.descriptions_root
+
+      if @package.class == Package
+        @root = @package.root
+        @arch = @package.arch
+        @name = @package.name
+        @path = args[:package].application_directory
+        @path = File.join(Smithy::Config.descriptions_root, @name) if @global_description
+      else
+        @root = Smithy::Config.root
+        @arch = Smithy::Config.arch
+
+        if @global_description
+          @name = @package.gsub(/#{Smithy::Config.descriptions_root}\/?/, "")
+          @path = @package
+        else
+          if @package == 'last'
+            @name = last_prefix.split('/').try(:first)
+          else
+            @name = Package.normalize_name :name => args[:package], :root => @root, :arch => @arch
+          end
+          @path = File.join @root, @arch, @name
+        end
+      end
+      @categories = []
+    end
+
+    def description_file_path
+      File.join(@path, "description.markdown")
+    end
+
+    def valid?
+      raise "Cannot find the package #{@path}" unless Dir.exists? @path
+      return true
+    end
+
+    def exceptions_file
+      File.join(@path, Package::PackageFileNames[:exception])
+    end
+
+    def self.publishable?(path)
+      exceptions_file = File.join(path, Package::PackageFileNames[:exception])
+      description_file = File.join(path, "description")
+      publishable = true
+      if File.exists?(exceptions_file) && ( File.exists?(description_file) || File.exists?(description_file+".markdown") )
+        File.open(exceptions_file).readlines.each do |line|
+          publishable = false if line =~ /^\s*noweb\s*$/
+        end
+      end
+      return publishable
+    end
+
+    def publishable?
+      Description.publishable?(path)
+    end
+
+    def remove_ptag_linebreaks!
+      # Find paragraph tag contents
+      results = []
+      @content.scan(/<p>(.*?)<\/p>/m) {|m| results << [m.first, Regexp.last_match.offset(0)[0]] }
+      newlines = []
+      # For each paragraph
+      results.each do |string, index|
+        # Find newlines and save their index
+        # index + 3 to accomodate '<p>'
+        string.scan(/\n/) {|m| newlines << index+3+Regexp.last_match.offset(0)[0] }
+      end
+      # Replace the newlines with spaces
+      newlines.each {|i| @content[i] = ' '}
+    end
+
+    def sanitize_content!
+      # Increment h tags by 2
+      @content.gsub!(/<h(\d)>/)   {|m| "<h#{$1.to_i+1}>"}
+      @content.gsub!(/<\/h(\d)>/) {|m| "</h#{$1.to_i+1}>"}
+
+      # Don't use <code> inside a <pre>
+      @content.gsub!(/<pre(.*?)><code>/) {|m| "<pre#{$1}>"}
+      @content.gsub!(/<\/code><\/pre>/, "</pre>")
+    end
+
+    def add_system_info!
+      system_string = @machine_table.keys.reject{|m| @machine_table[m].empty?}.collect{|m| m.humanize}.sort.join(', ')
+      @content.sub!(/(<h\d>.*?<\/h\d>\n)/) do
+        "#{$&}\n<p>Systems: #{system_string}</p>\n"
+      end
+    end
+
+    def parse_categories
+      if @content =~ /Categor(y|ies):\s+(.*?)(<\/p>)$/i
+        @categories = $2.split(',')
+        @categories.map do |t|
+          t.downcase!
+          t.strip!
+        end
+      end
+    end
+
+    def render_version_table
+      if Smithy::Config.descriptions_root
+        @machine_table = {}
+        web_arches = Smithy::Config.web_architecture_names.keys
+        web_arches.each do |a|
+          architecture_path = File.join( Smithy::Config.root, a, @name )
+          next unless Dir.exists? architecture_path
+          web_machine_name = Smithy::Config.web_architecture_names[a]
+          @machine_table[web_machine_name] = {}
+          Package.alternate_versions(architecture_path).each do |v|
+            @machine_table[web_machine_name][v] = Package.alternate_builds(File.join(architecture_path, v))
+          end
+        end
+        erb_file = File.join(@@smithy_bin_root, "/etc/templates/web/machine_version_table.html.erb")
+
+      else
+        @version_table = {}
+        universal = false
+        Package.alternate_versions(@path).each do |v|
+          @version_table[v] = Package.alternate_builds(File.join(@path, v))
+          universal = true if @version_table[v].select{|b| b =~ /(universal|binary)/}.size > 0
+        end
+        if universal
+          erb_file = File.join(@@smithy_bin_root, "/etc/templates/web/version_list.html.erb")
+        else
+          erb_file = File.join(@@smithy_bin_root, "/etc/templates/web/version_table.html.erb")
+        end
+
+      end
+
+      erb = ERB.new(File.read(erb_file), nil, "<>")
+      return erb.result(binding)
+    end
+
+    def deploy(args = {})
+      options = {:verbose => false, :noop => false}
+      options = {:verbose => true, :noop => true} if args[:dry_run]
+
+      www_arch = File.join(www_root, "/#{arch.downcase}")
+      www_arch = File.join(www_root, "all") if global_description
+
+      FileUtils.mkdir_p www_root, options                  unless Dir.exists? www_root
+      raise "Cannot access web-root directory #{www_root}" unless Dir.exists? www_root
+      FileUtils.mkdir_p www_arch, options                  unless Dir.exists? www_arch
+      raise "Cannot create web-root directory #{www_arch}" unless Dir.exists? www_arch
+
+      description_file = File.join(path, "description.markdown")
+
+      begin
+        if File.exist? description_file
+          f = File.open description_file
+          d = Kramdown::Document.new(f.read, :auto_ids => false)
+          @content = d.to_html
+          remove_ptag_linebreaks!
+        else
+          description_file = File.join(path, "description")
+          f = File.open description_file
+          @content = f.read
+        end
+      rescue => exception
+        raise "#{exception}\nCannot read #{description_file}"
+      end
+
+      @content += render_version_table
+      sanitize_content!
+      parse_categories
+      add_system_info! if global_description
+
+      description_output  = File.join(www_arch, "/#{name.downcase}.html")
+      unless args[:dry_run]
+        d = File.open(description_output, "w+")
+        d.write(@content)
+        d.close
+      end
+      puts "updated ".rjust(12).bright + description_output
+
+      #TODO update category list
+
+      #notice_success "SUCCESS #{path} published to web"
+    end
+
+    def self.update_page(file = 'alphabetical', args = {})
+      root = Smithy::Config.root
+      arch = Smithy::Config.arch
+      if Smithy::Config.descriptions_root
+        www_arch = File.join(Smithy::Config.web_root, "all")
+      else
+        www_arch = File.join(Smithy::Config.web_root, arch)
+      end
+
+      unless args[:descriptions].nil?
+        @descriptions = args[:descriptions]
+        @descriptions.sort! {|x,y| x.name <=> y.name}
+
+        #tags.each do |tag|
+          #t = tag.gsub(/^ *| *$|"/, '').downcase
+          #@packages[@last_package][:tags] << t
+          #@tags[t] = [] unless @tags.has_key?(t)
+          #@tags[t] << name
+        #end
+        #@max_tag_count = 0
+        #@min_tag_count = 1000000
+        #@tags.each do |tag|
+          #@max_tag_count = tag[1].size if tag[1].size > @max_tag_count
+          #@min_tag_count = tag[1].size if tag[1].size < @min_tag_count
+        #end
+      end
+
+      @packages = Package.all_web :root => File.join(root,arch)
+      @packages.collect! do |p|
+        if Smithy::Config.descriptions_root
+          File.basename(p)
+        else
+          Package.normalize_name(:name => p, :root => root, :arch => arch)
+        end
+      end
+      @packages.sort!
+
+      erb_file = File.join(@@smithy_bin_root, "/etc/templates/web/#{file}.html.erb")
+      output = File.join(www_arch, "/#{file}.html")
+
+      erb = ERB.new(File.read(erb_file), nil, "<>")
+      unless args[:dry_run]
+        File.open(output, "w+") do |f|
+          f.write erb.result(binding)
+        end
+      end
+
+      puts "updated ".rjust(12).bright + output
+    end
+
+  end
+end