fig 1.1.0 → 1.2.0

data/lib/fig/protocol/file.rb

@@ -28,7 +28,7 @@ class Fig::Protocol::File
 
   # Determine whether we need to update something.  Returns nil to indicate
   # "don't know".
-  def path_up_to_date?(uri, path)
+  def path_up_to_date?(uri, path, prompt_for_login)
     begin
       unescaped_path = CGI.unescape uri.path
       if ::File.mtime(unescaped_path) <= ::File.mtime(path)
@@ -43,7 +43,7 @@ class Fig::Protocol::File
 
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
-  def download(uri, path)
+  def download(uri, path, prompt_for_login)
     begin
       unescaped_path = CGI.unescape uri.path
       FileUtils.cp(unescaped_path, path)

data/lib/fig/protocol/ftp.rb

@@ -17,11 +17,12 @@ class Fig::Protocol::FTP
 
   def initialize(login)
     @login = login
+    initialize_netrc
   end
 
   def download_list(uri)
     ftp = Net::FTP.new(uri.host)
-    ftp_login(ftp, uri.host)
+    ftp_login(ftp, uri.host, :prompt_for_login)
     ftp.chdir(uri.path)
     dirs = ftp.nlst
     ftp.close
@@ -31,10 +32,10 @@ class Fig::Protocol::FTP
 
   # Determine whether we need to update something.  Returns nil to indicate
   # "don't know".
-  def path_up_to_date?(uri, path)
+  def path_up_to_date?(uri, path, prompt_for_login)
     begin
       ftp = Net::FTP.new(uri.host)
-      ftp_login(ftp, uri.host)
+      ftp_login(ftp, uri.host, prompt_for_login)
 
       if ftp.mtime(uri.path) <= ::File.mtime(path)
         return true
@@ -52,10 +53,10 @@ class Fig::Protocol::FTP
 
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
-  def download(uri, path)
+  def download(uri, path, prompt_for_login)
     begin
       ftp = Net::FTP.new(uri.host)
-      ftp_login(ftp, uri.host)
+      ftp_login(ftp, uri.host, prompt_for_login)
 
       if ::File.exist?(path) && ftp.mtime(uri.path) <= ::File.mtime(path)
         Fig::Logging.debug "#{path} is up to date."
@@ -87,7 +88,7 @@ class Fig::Protocol::FTP
     # to, i.e. [1,2,3] - [2,3,4] = [1]
     remote_project_dirs = remote_publish_dirs - ftp_root_dirs
     Net::FTP.open(uri.host) do |ftp|
-      ftp_login(ftp, uri.host)
+      ftp_login(ftp, uri.host, :prompt_for_login)
       # Assume that the FIG_REMOTE_URL path exists.
       ftp.chdir(ftp_root_path)
       remote_project_dirs.each do |dir|
@@ -105,11 +106,15 @@ class Fig::Protocol::FTP
 
   private
 
-  def ftp_login(ftp, host)
+  def ftp_login(ftp, host, prompt_for_login)
     begin
       if @login
-        load_authentication_for host
-        ftp.login get_username, get_password
+        authentication = get_authentication_for host, prompt_for_login
+        if authentication
+          ftp.login authentication.username, authentication.password
+        else
+          ftp.login
+        end
       else
         ftp.login
       end
@@ -131,7 +136,7 @@ class Fig::Protocol::FTP
       threads << Thread.new do
         packages = all_packages[num]
         ftp = Net::FTP.new(uri.host)
-        ftp_login(ftp, uri.host)
+        ftp_login(ftp, uri.host, :prompt_for_login)
         ftp.chdir(uri.path)
         pos = num
         while pos < dirs.length

data/lib/fig/protocol/http.rb

@@ -15,7 +15,7 @@ class Fig::Protocol::HTTP
 
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
-  def download(uri, path)
+  def download(uri, path, prompt_for_login)
     log_download(uri, path)
     ::File.open(path, 'wb') do |file|
       file.binmode

data/lib/fig/protocol/netrc_enabled.rb

@@ -10,33 +10,46 @@ module Fig::Protocol; end
 module Fig::Protocol::NetRCEnabled
   private
 
-  def get_username()
-    @username ||= HighLine.new.ask('Username: ') { |q| q.echo = true }
-    return @username
-  end
+  NetRCEntry = Struct.new :username, :password
 
-  def get_password()
-    @password ||= HighLine.new.ask('Password: ') { |q| q.echo = false }
-    return @password
-  end
+  def initialize_netrc()
+    @netrc_entries_by_host = {}
 
-  def load_authentication_for(host)
-    return if @username || @password
+    return
+  end
 
-    @username ||= ENV['FIG_USERNAME']
-    @password ||= ENV['FIG_PASSWORD']
-    return if @username || @password
+  def get_authentication_for(host, prompt_if_missing)
+    if @netrc_entries_by_host.include? host
+      return @netrc_entries_by_host[host]
+    end
 
+    entry = nil
     begin
       login_data = Net::Netrc.locate host
       if login_data
-        @username = login_data.login
-        @password = login_data.password
+        entry = NetRCEntry.new login_data.login, login_data.password
+      elsif prompt_if_missing
+        entry = get_authentication_from_user(host)
       end
     rescue SecurityError => error
       raise Fig::UserInputError.new error.message
     end
 
-    return
+    @netrc_entries_by_host[host] = entry
+
+    return entry
+  end
+
+  def get_authentication_from_user(host)
+    username =
+      ENV['FIG_USERNAME'] ||
+      HighLine.new.ask("Username for #{host}: ") { |q| q.echo = true }
+    password =
+      ENV['FIG_PASSWORD'] ||
+      HighLine.new.ask("Password for #{username}@#{host}: ") {
+        |q| q.echo = false
+      }
+
+    return NetRCEntry.new username, password
   end
 end

data/lib/fig/protocol/sftp.rb

@@ -14,10 +14,14 @@ class Fig::Protocol::SFTP
   include Fig::Protocol
   include Fig::Protocol::NetRCEnabled
 
+  def initialize()
+    initialize_netrc
+  end
+
   def download_list(uri)
     package_versions = []
 
-    sftp_run(uri) do
+    sftp_run(uri, :prompt_for_login) do
       |connection|
 
       connection.dir.foreach uri.path do
@@ -48,11 +52,11 @@ class Fig::Protocol::SFTP
 
   # Determine whether we need to update something.  Returns nil to indicate
   # "don't know".
-  def path_up_to_date?(uri, path)
-    sftp_run(uri) do
+  def path_up_to_date?(uri, path, prompt_for_login)
+    sftp_run(uri, prompt_for_login) do
       |connection|
 
-      return connection.stat!(uri.path).mtime <= ::File.mtime(path)
+      return connection.stat!(uri.path).mtime.to_f <= ::File.mtime(path).to_f
     end
 
     return nil
@@ -60,8 +64,8 @@ class Fig::Protocol::SFTP
 
   # Returns whether the file was not downloaded because the file already
   # exists and is already up-to-date.
-  def download(uri, path)
-    sftp_run(uri) do
+  def download(uri, path, prompt_for_login)
+    sftp_run(uri, prompt_for_login) do
       |connection|
 
       begin
@@ -70,7 +74,7 @@ class Fig::Protocol::SFTP
         # when the remote path does not exist.
         stat = connection.stat!(uri.path)
 
-        if ::File.exist?(path) && stat.mtime <= ::File.mtime(path)
+        if ::File.exist?(path) && stat.mtime.to_f <= ::File.mtime(path).to_f
           Fig::Logging.debug "#{path} is up to date."
           return false
         else
@@ -91,7 +95,7 @@ class Fig::Protocol::SFTP
   end
 
   def upload(local_file, uri)
-    sftp_run(uri) do
+    sftp_run(uri, :prompt_for_login) do
       |connection|
 
       ensure_directory_exists connection, ::File.dirname(uri.path)
@@ -103,19 +107,22 @@ class Fig::Protocol::SFTP
 
   private
 
-  def sftp_run(uri, &block)
+  def sftp_run(uri, prompt_for_login, &block)
     host = uri.host
 
-    load_authentication_for host
+    authentication = get_authentication_for host, prompt_for_login
+    if ! authentication
+      raise Fig::NetworkError.new "No authentication information for #{host}."
+    end
 
     begin
-      options = {:password => get_password}
+      options = {:password => authentication.password}
       port = uri.port
       if port
         options[:port] = port
       end
 
-      Net::SFTP.start(host, get_username, options, &block)
+      Net::SFTP.start(host, authentication.username, options, &block)
     rescue Net::SSH::Exception => error
       raise Fig::NetworkError.new error.message
     rescue Net::SFTP::Exception => error

data/lib/fig/repository.rb

@@ -8,6 +8,7 @@ require 'fig'
 require 'fig/at_exit'
 require 'fig/file_not_found_error'
 require 'fig/logging'
+require 'fig/not_yet_parsed_package'
 require 'fig/package_cache'
 require 'fig/package_descriptor'
 require 'fig/parser'
@@ -28,19 +29,22 @@ class Fig::Repository
   REMOTE_VERSION_SUPPORTED  = 1
 
   def initialize(
-    os,
+    application_configuration,
+    options,
+    operating_system,
     local_repository_directory,
-    application_config,
-    publish_listeners,
-    check_include_versions
+    remote_repository_url,
+    parser,
+    publish_listeners
   )
-    @operating_system             = os
+    @application_configuration    = application_configuration
+    @options                      = options
+    @operating_system             = operating_system
     @local_repository_directory   = local_repository_directory
-    @application_config           = application_config
+    @remote_repository_url        = remote_repository_url
+    @parser                       = parser
     @publish_listeners            = publish_listeners
 
-    @parser = Fig::Parser.new(application_config, check_include_versions)
-
     initialize_local_repository()
     reset_cached_data()
   end
@@ -134,6 +138,8 @@ class Fig::Repository
     end
 
     publisher = Fig::RepositoryPackagePublisher.new
+    publisher.application_configuration    = @application_configuration
+    publisher.options                      = @options
     publisher.operating_system             = @operating_system
     publisher.publish_listeners            = @publish_listeners
     publisher.package_statements           = package_statements
@@ -165,6 +171,8 @@ class Fig::Repository
 
   private
 
+  attr_reader :remote_repository_url
+
   def initialize_local_repository()
     FileUtils.mkdir_p(@local_repository_directory)
 
@@ -237,7 +245,9 @@ class Fig::Repository
       )
       local_version_file = File.join(temp_dir, "remote-#{VERSION_FILE_NAME}")
       begin
-        @operating_system.download(remote_version_file, local_version_file)
+        @operating_system.download(
+          remote_version_file, local_version_file, :prompt_for_login
+        )
       rescue Fig::FileNotFoundError
         # The download may create an empty file, so get rid of it.
         if File.exist?(local_version_file)
@@ -268,10 +278,6 @@ class Fig::Repository
     return version_string.to_i()
   end
 
-  def remote_repository_url()
-    return @application_config.remote_repository_url()
-  end
-
   def should_update?(descriptor)
     return true if @update_condition == :unconditionally
 
@@ -308,7 +314,9 @@ class Fig::Repository
     package_directory = local_directory_for_package(descriptor)
     local_fig_file    = fig_file_for_package_download(package_directory)
 
-    if @operating_system.path_up_to_date? remote_fig_file, local_fig_file
+    if @operating_system.path_up_to_date?(
+      remote_fig_file, local_fig_file, :prompt_for_login
+    )
       Fig::Logging.debug \
         "Skipping update of #{descriptor.to_string} because it looks like #{local_fig_file} is up-to-date."
       return
@@ -328,7 +336,9 @@ class Fig::Repository
       FileUtils.mkdir_p temporary_package
     end
 
-    return if ! @operating_system.download(remote_fig_file, temp_fig_file)
+    return if ! @operating_system.download(
+      remote_fig_file, temp_fig_file, :prompt_for_login
+    )
 
     package = read_package_from_directory(temporary_package, descriptor)
 
@@ -402,12 +412,14 @@ class Fig::Repository
     end
     content = File.read(file_name)
 
-    package = @parser.parse_package(
-      descriptor,
-      runtime_for_package(descriptor),
-      descriptor.to_string(),
-      content
-    )
+    unparsed_package = Fig::NotYetParsedPackage.new
+    unparsed_package.descriptor         = descriptor
+    unparsed_package.working_directory  = unparsed_package.base_directory =
+      runtime_for_package(descriptor)
+    unparsed_package.source_description = descriptor.to_string()
+    unparsed_package.unparsed_text      = content
+
+    package = @parser.parse_package(unparsed_package)
 
     @package_cache.add_package(package)
 

data/lib/fig/repository_package_publisher.rb

@@ -4,11 +4,12 @@ require 'socket'
 require 'sys/admin'
 require 'tmpdir'
 
-require 'fig/statement/synthetic_raw_text'
 require 'fig'
 require 'fig/at_exit'
+require 'fig/external_program'
 require 'fig/file_not_found_error'
 require 'fig/logging'
+require 'fig/not_yet_parsed_package'
 require 'fig/package_cache'
 require 'fig/package_definition_text_assembler'
 require 'fig/package_descriptor'
@@ -19,12 +20,16 @@ require 'fig/repository_error'
 require 'fig/statement/archive'
 require 'fig/statement/grammar_version'
 require 'fig/statement/resource'
+require 'fig/statement/synthetic_raw_text'
 require 'fig/url'
+require 'fig/user_input_error'
 
 module Fig; end
 
 # Handles package publishing for the Repository.
 class Fig::RepositoryPackagePublisher
+  attr_writer :application_configuration
+  attr_writer :options
   attr_writer :operating_system
   attr_writer :publish_listeners
   attr_writer :descriptor
@@ -123,12 +128,15 @@ class Fig::RepositoryPackagePublisher
 
     published_package = nil
     begin
-      published_package = Fig::Parser.new(nil, false).parse_package(
-        @descriptor,
-        @runtime_for_package,
-        '<package to be published>',
-        file_content
-      )
+      unparsed_package = Fig::NotYetParsedPackage.new
+      unparsed_package.descriptor         = @descriptor
+      unparsed_package.working_directory  = unparsed_package.base_directory =
+        @runtime_for_package
+      unparsed_package.source_description = '<package to be published>'
+      unparsed_package.unparsed_text      = file_content
+
+      published_package =
+        Fig::Parser.new(nil, false).parse_package(unparsed_package)
     rescue Fig::PackageParseError => error
       raise \
         "Bug in code! Could not parse package definition to be published.\n" +
@@ -152,11 +160,124 @@ class Fig::RepositoryPackagePublisher
     @text_assembler.add_header %Q<#     Host: #{@publish_host}>
     @text_assembler.add_header %Q<#     Args: "#{ARGV.join %q[", "]}">
     @text_assembler.add_header %Q<#     Fig:  v#{Fig::VERSION}>
+
+    add_environment_variables_to_package_metadata
+    add_version_control_to_package_metadata
+
     @text_assembler.add_header %Q<\n>
 
     return
   end
 
+  def add_environment_variables_to_package_metadata()
+    variables = @application_configuration[
+      'environment variables to include in comments in published packages'
+    ]
+    return if ! variables || variables.empty?
+
+    @text_assembler.add_header %q<#>
+    @text_assembler.add_header %q<# Values of some environment variables at time of publish:>
+    @text_assembler.add_header %q<#>
+    variables.each do
+      |variable|
+
+      value = ENV[variable]
+      if value.nil?
+        value = ' was unset.'
+      else
+        value = "=#{value}"
+      end
+
+      @text_assembler.add_header %Q<#     #{variable}#{value}>
+    end
+
+    return
+  end
+
+  def add_version_control_to_package_metadata()
+    return if @options.suppress_vcs_comments_in_published_packages?
+
+    add_subversion_url_to_package_metadata()
+    add_git_url_to_package_metadata()
+
+    return
+  end
+
+  def add_subversion_url_to_package_metadata()
+    output = get_subversion_working_directory_info
+    return if not output =~ /^URL: +(.*\S)\s*$/
+    url = $1
+
+    @text_assembler.add_header %q<#>
+    @text_assembler.add_header(
+      %Q<# Publish happened in a Subversion working directory from\n# #{url}.>
+    )
+
+    return
+  end
+
+  def get_subversion_working_directory_info()
+    executable =
+      get_version_control_executable('FIG_SVN_EXECUTABLE', 'svn') or return
+    return run_version_control_command(
+      [executable, 'info'], 'Subversion', 'FIG_SVN_EXECUTABLE'
+    )
+  end
+
+  def run_version_control_command(command, version_control_name, variable)
+    begin
+      output, errors, result = Fig::ExternalProgram.capture command
+    rescue Errno::ENOENT => error
+      Fig::Logging.warn(
+        %Q<Could not run "#{command.join ' '}": #{error.message}. Set #{variable} to the path to use for #{version_control_name} or to the empty string to suppress #{version_control_name} support.>
+      )
+      return
+    end
+
+    if result && ! result.success?
+      Fig::Logging.debug(
+        %Q<Could not run "#{command.join ' '}": #{result}: #{errors}>
+      )
+
+      return
+    end
+
+    return output
+  end
+
+  def get_version_control_executable(variable, default)
+    executable = ENV[variable]
+    if ! executable || executable.empty?
+      return if ENV.include? variable
+      return default
+    end
+
+    return executable
+  end
+
+  def add_git_url_to_package_metadata()
+    url = get_git_origin_url or return
+    url.strip!
+    return if url.empty?
+
+    @text_assembler.add_header %q<#>
+    @text_assembler.add_header(
+      %Q<# Publish happened in a Git working directory from\n# #{url}.>
+    )
+
+    return
+  end
+
+  def get_git_origin_url()
+    executable =
+      get_version_control_executable('FIG_GIT_EXECUTABLE', 'git') or return
+    return run_version_control_command(
+      [executable, 'config', '--get', 'remote.origin.url'],
+      'Git',
+      'FIG_GIT_EXECUTABLE'
+    )
+  end
+
   # Deals with Archive and Resource statements.  It downloads any remote
   # files (those where the statement references a URL as opposed to a local
   # file) and then copies all files into the local repository and the remote
@@ -256,7 +377,7 @@ class Fig::RepositoryPackagePublisher
       asset_local = File.join(publish_temp_dir(), asset_name)
 
       begin
-        @operating_system.download(asset_statement.location, asset_local)
+        @operating_system.download(asset_statement.location, asset_local, false)
       rescue Fig::FileNotFoundError
         Fig::Logging.fatal "Could not download #{asset_statement.location}."
         raise Fig::RepositoryError.new