software_smithy 1.1 → 1.6

data/etc/completion/zsh/_smithy

@@ -4,30 +4,46 @@ _smithy_packages() {
 	packages=(`smithy search --format=name`)
 }
 
+_smithy_formulas() {
+	formulas=(`smithy formula list`)
+}
+
+_smithy_architectures() {
+	arches=(`smithy show arch --all`)
+  _wanted packages expl 'architectures' compadd -a arches
+}
+
 local -a _1st_arguments
 _1st_arguments=(
-	'build:Build software'
-  'deploy:Deploy a package'
+  'build:Build software'
   'edit:Edit package support files'
-  'help:Shows list of commands or help for one command'
+  'formula:Install software from predefined formulas'
+  'help:Shows a list of commands or help for one command'
   'module:Manage modulefiles for a package'
-	'new:Generate a new build and all necessary files'
-	'repair:Repair a package'
-	'search:Search currently installed software'
-	'test:Test software'
+  'new:Generate a new build and all necessary files'
+  'publish:Publish packages to web'
+  'repair:Repair a package'
+  'search:Search currently installed software'
+  'show:Display internal smithy values'
+  'test:Test software'
 )
 
 local expl
 local -a formulae
 
 _arguments \
-  '(--arch=)--arch=[Machine architecture to operate on]' \
+  '(--arch=)--arch=[Machine architecture to operate on]:architecture:_smithy_architectures' \
+  '(--no-color)--no-color[Disable colored output]' \
+  '(--color)--color[Enable colored output]' \
   '(--config-file=)--config-file=[Alternate config file]:file:_files' \
+  '(--descriptions-root=)--descriptions-root=[The root level directory for global description files]:directory:_files -/' \
   '(--disable-group-writeable)--disable-group-writeable[Disable group writable file creation]' \
+  '(-f --force)'{-f,--force}'[Always overwrite existing files]' \
   '(--file-group-name=)--file-group-name=[Group name for files created by smithy]' \
   '(--help)--help[Show help]' \
-  '(--no-color)--no-color[Hide coloring]' \
+  '(--prgenv-prefix=)--prgenv-prefix=[The prefix of programming environments for this machine]' \
   '(--software-root=)--software-root=[The root level directory for software]:directory:_files -/' \
+  '(-v --verbose)'{-v,--verbose}'[Be more verbose]' \
   '(--web-root=)--web-root=[The root level directory for web files]:directory:_files -/' \
   '*:: :->subcmds' && return 0
 #[[ "$PREFIX" = --* ]] && _arguments -- \
@@ -41,10 +57,15 @@ if (( CURRENT == 1 )); then
 	return
 fi
 
+# echo $words >/dev/ttys004
+# echo $CURRENT >/dev/ttys004
+
 # completion for each sub command
 case "$words[1]" in
   help)
-    _describe -t commands "smithy subcommand" _1st_arguments ;;
+    _describe -t commands "smithy subcommand" _1st_arguments
+    ;;
+
   build|test)
     _arguments \
       '(--disable-log)--disable-log[Disable logging]' \
@@ -57,21 +78,14 @@ case "$words[1]" in
     if [[ "$state" == forms ]]; then
       _smithy_packages
       _wanted packages expl 'packages' compadd -a packages
-    fi ;;
-  deploy)
-    _arguments \
-      '(-n --dry-run)'{-n,--dry-run}'[See what files will be created without creating them]' \
-      '1: :->forms' &&  return 0
+    fi
+    ;;
 
-    if [[ "$state" == forms ]]; then
-      _smithy_packages
-      _wanted packages expl 'packages' compadd -a packages
-    fi ;;
   edit)
     _subsub_commands=(
       'build:Edit a build script'
       'test:Edit a test script'
-      'environment:Edit modules loaded for the build script'
+      'env:Edit modules loaded for the build script'
       'modulefile:Edit modulefile'
     )
     # Match subsub-command
@@ -88,12 +102,15 @@ case "$words[1]" in
     if [[ "$state" == forms ]]; then
       _smithy_packages
       _wanted packages expl 'packages' compadd -a packages
-    fi ;;
+    fi
+    ;;
+
   module)
     _subsub_commands=(
       'create:Generate a modulefile for a given package'
-      'use:Add a modulefile to the MODULEPATH'
       'deploy:Copy a modulefile to the system MODULEPATH'
+      'edit:Alias for "smithy edit modulefile"'
+      'use:Add a modulefile to the MODULEPATH'
     )
     # Match subsub-command
     if (( CURRENT == 2 )); then
@@ -103,18 +120,23 @@ case "$words[1]" in
 
     _arguments \
       '(-n --dry-run)'{-n,--dry-run}'[See what files will be created without creating them]' \
-      '2: :->forms' &&  return 0
+      '1: :->forms' &&  return 0
 
     if [[ "$state" == forms ]]; then
       _smithy_packages
       _wanted packages expl 'packages' compadd -a packages
-    fi ;;
+    fi
+    ;;
+
   new)
     _arguments \
+      '(--existing-scripts)--existing-scripts[Use an existing softwares build scripts]' \
       '(--skip-modulefile)--skip-modulefile[Skip modulefile generation]' \
       '(--web-description)--web-description[Create description file for website]' \
       '(-n --dry-run)'{-n,--dry-run}'[See what files will be created without creating them]' \
-      '(-t --tarball=)'{-t,--tarball=}'[Provide a source tarball to unpack (optional)]:file:_files' ;;
+      '(-t --tarball=)'{-t,--tarball=}'[Provide a source tarball to unpack (optional)]:file:_files'
+    ;;
+
   repair)
     _arguments \
       '(-n --dry-run)'{-n,--dry-run}'[Verify permissions only]' \
@@ -123,8 +145,80 @@ case "$words[1]" in
     if [[ "$state" == forms ]]; then
       _smithy_packages
       _wanted packages expl 'packages' compadd -a packages
-    fi ;;
+    fi
+    ;;
+
   search)
     _arguments \
-      '(--format=)--format=[Format of the output]:format:(path name table csv)' ;;
+      '(--format=)--format=[Format of the output]:format:(path name table csv dokuwiki)'
+    ;;
+
+  show)
+    _subsub_commands=(
+      'arch:List all architectures know to smithy.'
+      'example_config:Display an example config file.'
+      'last:Display the package name used in the last smithy command. This is stored in the ~/.smithyrc file.'
+    )
+    # Match subsub-command
+    if (( CURRENT == 2 )); then
+      _describe -t subcommands "show subcommand" _subsub_commands
+      return
+    fi
+    ;;
+
+  publish)
+    _arguments \
+      '(-n --dry-run)'{-n,--dry-run}'[See what files will be created without creating them]' \
+      '1: :->forms' &&  return 0
+
+    if [[ "$state" == forms ]]; then
+      _smithy_packages
+      _wanted packages expl 'packages' compadd -a packages
+    fi
+    ;;
+
+  formula)
+    # echo $words[$CURRENT] > /dev/ttys004
+
+    _subsub_commands=(
+      'create_modulefile:Create a modulefile for a given package'
+      'display:Display a formula'
+      'install:Install a package using a formula'
+      'list:List known formulas'
+      'new:Create a new formula'
+      'which:Display a formula location'
+    )
+
+    # not sure how to make this work right
+    # _arguments \
+    #   '(-d --directories=)'{-d,--directories=}'[Specify one or more additional formula directories separated with commas]:directory:_files -/' \
+    #   '1: :->forms' &&  return 0
+
+    # Match subsub-command
+    if (( CURRENT == 2 )); then
+      _describe -t subcommands "formula subcommand" _subsub_commands
+      return
+    fi
+
+    # Match subsub-command arguments
+    if (( CURRENT == 3 )); then
+      case "$words[2]" in
+        install)
+          _arguments \
+            '(--clean)--clean[clean existing install prefix]' \
+            '(--no-clean)--no-clean[leave existing install prefix files intact]' \
+            '(-f --formula-name)'{-f,--formula-name}'[Formula name]' \
+            '(-m --modulefile)'{-m,--modulefile}'[Create modulefiles as well]' \
+            '1: :->forms' &&  return 0
+          if [[ "$state" == forms ]]; then
+            _smithy_formulas
+            _wanted packages expl 'formulas' compadd -a formulas
+          fi
+          ;;
+      esac
+
+      return
+    fi
+
+    ;;
 esac

data/etc/templates/formula.rb.erb

@@ -0,0 +1,11 @@
+class <%= @formula_name %>Formula < Formula
+  homepage "<%= @formula_homepage %>"
+  url "<%= @formula_url %>"
+
+  def install
+    module_list
+    system "./configure --prefix=#{prefix}"
+    system "make"
+    system "make install"
+  end
+end

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

@@ -6,13 +6,6 @@
       <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>
 

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

@@ -6,7 +6,7 @@ Checkmarks indicate a given version is available for the compiler specified in e
   <thead>
     <tr>
       <td style="text-align:center;"><b>Version</b></td>
-      <% ModuleFile::Environments.reject{|e| e[:human_name]=="pathscale"}.each do |e| %>
+      <% ModuleFile::compilers.reject{|e| e[:human_name]=="pathscale"}.each do |e| %>
       <td style="text-align:center;"><b><%= e[:human_name].upcase %></b></td>
       <% end %>
     </tr>
@@ -15,7 +15,7 @@ Checkmarks indicate a given version is available for the compiler specified in e
   <% @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| %>
+    <% ModuleFile::compilers.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>

data/lib/smithy/config.rb

@@ -42,7 +42,7 @@ module Smithy
         :arch, :root, :full_root, :web_root, :file_group, :descriptions_root,
         :web_architecture_names
 
-      def group_writeable?
+      def group_writable?
         @global[:"disable-group-writable"] ? false : true
       end
 
@@ -59,6 +59,9 @@ module Smithy
         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")
+        options_to_merge[:"download-cache"] = @config_file_hash.try(:[], "download-cache")
+        options_to_merge[:"formula-directories"] = @config_file_hash.try(:[], "formula-directories")
+        options_to_merge[:"global-error-log"] = @config_file_hash.try(:[], "global-error-log")
 
         set_hostname_and_arch
         options_to_merge[:arch] = @arch
@@ -90,21 +93,34 @@ module Smithy
       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
+        if config_path.present? && File.exists?(config_path)
           @config_file_name = config_path
-          @config_file_hash = YAML.load_file(config_path).stringify_keys
+          begin
+            @config_file_hash = YAML.load_file(config_path).stringify_keys
+          rescue
+            raise """Cannot interpret smithy config file. This is probably caused by malformed YAML.
+       #{config_path}"""
+          end
+        else
+          raise """Cannot read config file: #{@config_file_name}
+       Please set the $SMITHY_CONFIG variable to a config file location
+       Or use the --config-file=FILE option"""
+        end
+      end
+
+      def architectures(options)
+        if options[:all]
+          puts @config_file_hash["hostname-architectures"].values.uniq.sort.join(" ")
         else
-          raise """warning: Cannot read config file: #{@config_file_name}
-          Please update the file or set SMITHY_CONFIG """
+          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
       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
+      def compilers
+        config_file_hash.try(:[], "compilers")
       end
 
       def get_prgenv_prefix
@@ -136,8 +152,8 @@ module Smithy
       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}"""
+       Please specify using --arch or add a '#{@hostname}' hostname entry to:
+       #{@config_file_name}"""
         end
 
         s = File.join(@root, @arch)
@@ -157,11 +173,52 @@ module Smithy
 
       def save_last_prefix(prefix)
         rc_file = File.join(ENV['HOME'], '.smithyrc')
-        h = {:last => prefix}
+        h = {:last => prefix.encode('UTF-8')}
         File.open(rc_file, "w+") do |f|
           f.write(h.to_yaml)
         end
       end
+
+      def example_config
+        example = {}
+        example["software-root"]       = "/sw"
+        example["download-cache"]      = "/sw/sources"
+        example["formula-directories"] = [
+          "/sw/tools/smithy/formulas",
+          "/sw/tools/smithy/another_formula_directory"
+        ]
+        example["global-error-log"]    = "/sw/tools/smithy/exceptions.log"
+        example["file-group-name"]        = "ccsstaff"
+        example["descriptions-root"]      = "/sw/descriptions"
+        example["web-root"]               = "/sw/descriptions_in_html"
+        example["web-architecture-names"] = {
+          "xk6"          => "titan",
+          "xk7"          => "titan",
+          "analysis-x64" => "lens",
+          "smoky"        => "smoky"
+        }
+        example["programming-environment-prefix"] = {
+          "default" => "PrgEnv-",
+          "smoky"   => "PE-",
+          "sith"    => "PE-"
+        }
+        example["hostname-architectures"] = {
+          "everest-login" => "redhat6",
+          "everest"       => "redhat6",
+          "lens"          => "analysis-x64",
+          "sith-login"    => "redhat6",
+          "sith"          => "redhat6",
+          "smoky-login"   => "smoky",
+          "titan-login"   => "xk6",
+          "titan-ext"     => "xk6",
+          "yona-login"    => "yona",
+          "yona"          => "yona"
+        }
+        example["compilers"] = ModuleFile::Environments
+
+        return example.to_yaml
+      end
+
     end
   end
 end

data/lib/smithy/description.rb

@@ -43,7 +43,7 @@ module Smithy
     def initialize(args = {})
       @www_root = Smithy::Config.web_root
       @package = args[:package]
-      @global_description = true if Smithy::Config.descriptions_root
+      @global_description = Smithy::Config.descriptions_root if Smithy::Config.descriptions_root
 
       if @package.class == Package
         @root = @package.root
@@ -57,12 +57,12 @@ module Smithy
 
         if @global_description
           @name = @package.gsub(/#{Smithy::Config.descriptions_root}\/?/, "")
-          @path = @package
+          @path = File.join(Smithy::Config.descriptions_root, @name) if @global_description
         else
           if @package == 'last'
             @name = last_prefix.split('/').try(:first)
           else
-            @name = Package.normalize_name :name => args[:package], :root => @root, :arch => @arch
+            @name = Package.normalize_name(args[:package])
           end
           @path = File.join @root, @arch, @name
         end
@@ -254,7 +254,7 @@ module Smithy
         if Smithy::Config.descriptions_root
           File.basename(p)
         else
-          Package.normalize_name(:name => p, :root => root, :arch => arch)
+          Package.normalize_name(p)
         end
       end
       @packages.sort!

data/lib/smithy/download_cache.rb

@@ -0,0 +1,120 @@
+module Smithy
+  class DownloadCache
+    attr_accessor :url, :name, :version, :checksums
+
+    def initialize(p, fname = nil)
+      @url = ''
+      @checksums = {}
+      if p.is_a? Formula
+        @url = p.try(:url)
+        @checksums.merge!(:md5 => p.md5) if p.try(:md5)
+        @checksums.merge!(:sha1 => p.sha1) if p.try(:sha1)
+        @checksums.merge!(:sha256 => p.sha256) if p.try(:sha256)
+        @name = p.try(:package).try(:name)
+        @version = p.try(:package).try(:version)
+      elsif p.is_a? Package
+        @name = p.name
+        @version = p.version
+      end
+
+      @name = fname unless fname.blank?
+    end
+
+    def download_cache_dir
+      dir = Smithy::Config.global[:"download-cache"]
+      dir = File.join(ENV['HOME'], '.smithy/cache') if dir.blank?
+      dir
+    end
+
+    def downloaded_file_name
+      url_filename(url)
+    end
+
+    def downloaded_file_dir
+      File.join(download_cache_dir, name, version)
+    end
+
+    def downloaded_file_path
+      File.join(downloaded_file_dir, downloaded_file_name)
+    end
+
+    def downloaded?
+      File.exists?(downloaded_file_path)
+    end
+
+    def checksum_download
+      return true if checksums.empty?
+      return false unless downloaded?
+
+      checksums.keys.each do |type|
+        checksum = checksums[type]
+        digest = ''
+        case type
+        when :md5
+          require 'digest/md5'
+          digest = Digest::MD5.hexdigest(File.read(downloaded_file_path))
+        when :sha1
+          require 'digest/sha1'
+          digest = Digest::SHA1.hexdigest(File.read(downloaded_file_path))
+        when :sha256
+          require 'digest/sha2'
+          digest = Digest::SHA256.hexdigest(File.read(downloaded_file_path))
+        end
+
+        if checksum != digest
+          raise <<-EOF.strip_heredoc
+            file does not match expected #{type.to_s.upcase} checksum
+              expected: #{checksum}
+              got:      #{digest}
+          EOF
+        else
+          return true
+        end
+      end
+    end
+
+    def download
+      curl = '/usr/bin/curl'
+      curl = `which curl` unless File.exist? curl
+      raise "curl cannot be located, without it files cannot be downloaded" if curl.blank?
+
+      if downloaded?
+        puts "downloaded ".rjust(12).color(:green).bright + downloaded_file_path
+        return true
+      else
+        puts "download ".rjust(12).color(:green).bright + url
+      end
+
+      args = ['-qf#L']
+      args << "--silent" unless $stdout.tty?
+      args << '-o'
+      args << downloaded_file_path
+      args << url
+
+      FileUtils.mkdir_p downloaded_file_dir
+      [downloaded_file_dir, File.join(downloaded_file_dir, '..')].each do |dir|
+        FileOperations.set_group(dir, Smithy::Config.global[:"file-group-name"])
+        FileOperations.make_group_writable(dir) unless Smithy::Config.global[:"disable-group-writable"]
+      end
+
+      if system(curl, *args)
+        FileOperations.set_group(downloaded_file_path, Smithy::Config.global[:"file-group-name"])
+        FileOperations.make_group_writable(downloaded_file_path) unless Smithy::Config.global[:"disable-group-writable"]
+        return true
+      else
+        return false
+      end
+    end
+
+    def get(passed_url= nil)
+      @url = passed_url if passed_url
+      if download && checksum_download
+        return downloaded_file_path
+      else
+        return false
+      end
+    end
+
+  end
+end
+