bookbindery 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f6a8e4eb39aa0fd160b3172ba64ea6b9235cf00
-  data.tar.gz: 336570ec41b4e7ba131acab5565a9c210e122227
+  metadata.gz: f7877178e76465b0d9ad6b4f1564da1bba88d6b2
+  data.tar.gz: bf482ea5acec272fcb583378bdb526bc3f5a17e1
 SHA512:
-  metadata.gz: e6b3d8dbd2a9b312574024ff56ed8669de906b7290b1de9a5de3e2bb1ea372fc2b6d11bdf7f7f8239153dac485135e4c8993ed814ca3ef6ebe5d62e1ae815848
-  data.tar.gz: a6bcdfcc72d5a57a090a88bc60cddcd74d2f0bb5715b34db798310104181843c25feb50089aaf5d2e7b6f06169226c02dfb2e36a40f80ae0aced02a663c622bf
+  metadata.gz: 4971a06ce3b96ed50633d2ac3d2da19d0d31da0a7bdea5c4d5474e4e4fc58a4dbf687abf1711bb07988651a55fdb60db4e8e9d511cac3bcfcb47f3cb60f129bc
+  data.tar.gz: 1c90657d87387b98c1158ab14a7ebb5554ea72db268773adea9ac480b6c2eedcb85c6464cb58ae004d27e812b30303cd1d65366b7300b5320530197655c1c840

data/lib/bookbinder/cf_command_runner.rb

@@ -1,10 +1,9 @@
-require 'open3'
-require_relative 'values/blue_green_app'
+require_relative 'deploy/blue_green_app'
 
 module Bookbinder
   class CfCommandRunner
-    def initialize(logger, sheller, cf_credentials, trace_file)
-      @logger = logger
+    def initialize(streams, sheller, cf_credentials, trace_file)
+      @streams = streams
       @sheller = sheller
       @creds = cf_credentials
       @trace_file = trace_file
@@ -18,37 +17,39 @@ module Bookbinder
       space = creds.space
       creds_string = (username && password) ? "-u '#{username}' -p '#{password}'" : ''
 
-      success = Kernel.system("#{cf_binary_path} login #{creds_string} -a '#{api_endpoint}' -o '#{organization}' -s '#{space}'")
-      raise "Could not log in to #{creds.api_endpoint}" unless success
+      result = sheller.run_command(
+        "#{cf_binary_path} login #{creds_string} -a '#{api_endpoint}' -o '#{organization}' -s '#{space}'",
+        streams
+      )
+      raise "Could not log in to #{creds.api_endpoint}" unless result.success?
     end
 
     def cf_routes_output
-      output, status = Open3.capture2("CF_COLOR=false #{cf_binary_path} routes")
-      raise 'failure executing cf routes' unless status.success?
-      output
+      sheller.get_stdout("CF_COLOR=false #{cf_binary_path} routes").tap do |output|
+        raise 'failure executing cf routes' if output == ''
+      end
     end
 
     def new_app
-      BlueGreenApp.new([creds.app_name, 'blue'].join('-'))
+      Deploy::BlueGreenApp.new([creds.app_name, 'blue'].join('-'))
     end
 
     def start(deploy_target_app)
       # Theoretically we shouldn't need this (and corresponding "stop" below), but we've seen CF pull files from both
       # green and blue when a DNS redirect points to HOST.cfapps.io
       # Also, shutting down the unused app saves $$
-      sheller.run_command("#{cf_binary_path} start #{deploy_target_app}",
-                          out: $stdout,
-                          err: $stderr)
+      sheller.run_command("#{cf_binary_path} start #{deploy_target_app}", streams)
     end
 
     def push(deploy_target_app)
       # Currently --no-routes is used to blow away all existing routes from a newly deployed app.
       # The routes will then be recreated from the creds repo.
-      status = sheller.run_command(environment_variables,
-                                   "#{cf_binary_path} push #{deploy_target_app} -s cflinuxfs2 --no-route -m 256M -i 3",
-                                   out: $stdout,
-                                   err: $stderr)
-      raise "Could not deploy app to #{deploy_target_app}" unless status.success?
+      result = sheller.run_command(
+        environment_variables,
+        "#{cf_binary_path} push #{deploy_target_app} -s cflinuxfs2 --no-route -m 256M -i 3",
+        streams
+      )
+      raise "Could not deploy app to #{deploy_target_app}" unless result.success?
     end
 
     def unmap_routes(app)
@@ -73,9 +74,9 @@ module Bookbinder
 
     def takedown_old_target_app(app)
       # Routers flush every 10 seconds (but not guaranteed), so wait a bit longer than that.
-      @logger.log "waiting 15 seconds for routes to remap...\n\n"
+      streams[:out].puts "waiting 15 seconds for routes to remap...\n\n"
       (1..15).to_a.reverse.each do |seconds|
-        @logger.log_print "\r\r#{seconds}...    "
+        streams[:out] << "\r\r#{seconds}...    "
         Kernel.sleep 1
       end
       stop(app)
@@ -84,33 +85,35 @@ module Bookbinder
 
     private
 
-    attr_reader :creds, :sheller
+    attr_reader :creds, :sheller, :streams
 
     def stop(app)
-      success = Kernel.system("#{cf_binary_path} stop #{app}")
-      raise "Failed to stop application #{app}" unless success
+      result = sheller.run_command("#{cf_binary_path} stop #{app}", streams)
+      raise "Failed to stop application #{app}" unless result.success?
     end
 
     def map_route(deploy_target_app, domain, host)
       map_route_command = "#{cf_binary_path} map-route #{deploy_target_app} #{domain}"
       map_route_command += " -n #{host}" unless host.empty?
 
-      success = Kernel.system(map_route_command)
-      raise "Deployed app to #{deploy_target_app} but failed to map hostname #{host}.#{domain} to it." unless success
+      result = sheller.run_command(map_route_command, streams)
+      raise "Deployed app to #{deploy_target_app} but failed to map hostname #{host}.#{domain} to it." unless result.success?
     end
 
     def unmap_route(deploy_target_app, domain, host)
       unmap_route_command = "#{cf_binary_path} unmap-route #{deploy_target_app} #{domain}"
       unmap_route_command += " -n #{host}" unless host.empty?
 
-      success = Kernel.system(unmap_route_command)
-      raise "Failed to unmap route #{host} on #{deploy_target_app}." unless success
+      result = sheller.run_command(unmap_route_command, streams)
+      raise "Failed to unmap route #{host} on #{deploy_target_app}." unless result.success?
     end
 
     def cf_binary_path
-      @cf_binary_path ||= `which cf`.chomp!
-      raise "CF CLI could not be found in your PATH. Please make sure cf cli is in your PATH." if @cf_binary_path.nil?
-      @cf_binary_path
+      @cf_binary_path ||= sheller.get_stdout("which cf").tap do |path|
+        if path == ''
+          raise "CF CLI could not be found in your PATH. Please make sure cf cli is in your PATH."
+        end
+      end
     end
 
     def environment_variables

data/lib/bookbinder/cli.rb

@@ -1,8 +1,8 @@
-require_relative 'colorizer'
 require_relative 'command_runner'
 require_relative 'command_validator'
 require_relative 'commands/collection'
 require_relative 'config/cf_credentials'
+require_relative 'streams/colorized_stream'
 require_relative 'terminal'
 
 module Bookbinder
@@ -17,7 +17,7 @@ module Bookbinder
       logger = DeprecatedLogger.new
       commands = Commands::Collection.new(
         logger,
-        {out: $stdout, err: $stderr},
+        colorized_streams,
         version_control_system
       )
 
@@ -39,19 +39,19 @@ module Bookbinder
         command_runner.run command_name, command_arguments
 
       rescue Config::RemoteBindConfiguration::VersionUnsupportedError => e
-        logger.error "config.yml at version '#{e.message}' has an unsupported API."
+        colorized_streams[:err].puts "config.yml at version '#{e.message}' has an unsupported API."
         1
       rescue Config::CfCredentials::CredentialKeyError => e
-        logger.error "#{e.message}, in credentials.yml"
+        colorized_streams[:err].puts "#{e.message}, in credentials.yml"
         1
       rescue KeyError => e
-        logger.error "#{e.message} from your configuration."
+        colorized_streams[:err].puts "#{e.message} from your configuration."
         1
       rescue CliError::UnknownCommand => e
-        logger.log e.message
+        colorized_streams[:out].puts e.message
         1
       rescue RuntimeError => e
-        logger.error e.message
+        colorized_streams[:err].puts e.message
         1
       end
     end
@@ -60,5 +60,13 @@ module Bookbinder
 
     attr_reader :version_control_system
 
+    def colorized_streams
+      {
+        err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr),
+        out: $stdout,
+        success: Streams::ColorizedStream.new(Colorizer::Colors.green, $stdout),
+        warn: Streams::ColorizedStream.new(Colorizer::Colors.yellow, $stdout),
+      }
+    end
   end
 end

data/lib/bookbinder/code_example_reader.rb

@@ -1,15 +1,13 @@
-require_relative '../../lib/bookbinder/deprecated_logger'
-
 module Bookbinder
   class CodeExampleReader
     class InvalidSnippet < StandardError
       def initialize(repo, marker)
-        super "Error with marker #{marker.cyan} #{'in'.red} #{repo.cyan}#{'.'.red}"
+        super "Error with marker #{marker} in #{repo}."
       end
     end
 
-    def initialize(logger)
-      @logger = logger
+    def initialize(out: out)
+      @out = out
     end
 
     def get_snippet_and_language_at(marker, working_copy)
@@ -19,7 +17,7 @@ module Bookbinder
       elsif snippet.available?
         [snippet.content, snippet.language]
       else
-        logger.log '  skipping (not found) '.magenta + working_copy.full_name
+        out << "  skipping (not found) #{working_copy.full_name}"
         ''
       end
     end
@@ -73,6 +71,6 @@ module Bookbinder
 
     private
 
-    attr_reader :logger
+    attr_reader :out
   end
 end

data/lib/bookbinder/commands/bind/directory_preparer.rb

@@ -15,7 +15,7 @@ module Bookbinder
 
         def prepare_directories(config, gem_root, output_locations, layout_repo_dir)
           file_system_accessor.remove_directory(output_locations.output_dir)
-          file_system_accessor.remove_directory(output_locations.final_app_dir)
+          file_system_accessor.empty_directory(output_locations.final_app_dir)
 
           copy_directory_from_gem(gem_root, 'template_app', output_locations.final_app_dir)
           copy_directory_from_gem(gem_root, 'master_middleman', output_locations.site_generator_home)

data/lib/bookbinder/commands/build_and_push_tarball.rb

@@ -1,11 +1,15 @@
-require_relative '../archive'
+require_relative '../deploy/archive'
 require_relative '../ingest/destination_directory'
-require_relative 'bookbinder_command'
 require_relative 'naming'
 
 module Bookbinder
   module Commands
-    class BuildAndPushTarball < BookbinderCommand
+    class BuildAndPushTarball
+      def initialize(streams, configuration_fetcher)
+        @success = streams[:success]
+        @configuration_fetcher = configuration_fetcher
+      end
+
       include Commands::Naming
 
       def usage
@@ -16,11 +20,19 @@ module Bookbinder
       def run(_)
         config = configuration_fetcher.fetch_config
         aws_credentials = configuration_fetcher.fetch_credentials[:aws]
-        archive = Archive.new(logger: @logger, key: aws_credentials.access_key, secret: aws_credentials.secret_key)
-        archive.create_and_upload_tarball(build_number: ENV['BUILD_NUMBER'], bucket: aws_credentials.green_builds_bucket,
-                                          namespace: Ingest::DestinationDirectory.new(config.book_repo))
+        archive = Deploy::Archive.new(key: aws_credentials.access_key, secret: aws_credentials.secret_key)
+        result = archive.create_and_upload_tarball(
+          build_number: ENV.fetch('BUILD_NUMBER', Time.now.strftime("%Y%m%d_%H%M")),
+          bucket: aws_credentials.green_builds_bucket,
+          namespace: Ingest::DestinationDirectory.new(config.book_repo)
+        )
+        success.puts(result.reason)
         0
       end
+
+      private
+
+      attr_reader :configuration_fetcher, :success
     end
   end
 end

data/lib/bookbinder/commands/collection.rb

@@ -15,9 +15,9 @@ require_relative '../ingest/cloner_factory'
 require_relative '../ingest/section_repository_factory'
 require_relative '../local_file_system_accessor'
 require_relative '../middleman_runner'
-require_relative '../post_production/sitemap_writer'
-require_relative '../preprocessing/copy_to_site_gen_dir'
+require_relative '../postprocessing/sitemap_writer'
 require_relative '../preprocessing/dita_preprocessor'
+require_relative '../preprocessing/link_to_site_gen_dir'
 require_relative '../preprocessing/preprocessor'
 require_relative '../sheller'
 require_relative '../subnav_formatter'
@@ -28,9 +28,9 @@ module Bookbinder
     class Collection
       include Enumerable
 
-      def initialize(logger, base_streams, version_control_system)
+      def initialize(logger, streams, version_control_system)
         @logger = logger
-        @base_streams = base_streams
+        @streams = streams
         @version_control_system = version_control_system
       end
 
@@ -47,7 +47,7 @@ module Bookbinder
 
       private
 
-      attr_reader :logger, :base_streams, :version_control_system
+      attr_reader :logger, :streams, :version_control_system
 
       def list
         standard_commands + flags
@@ -63,17 +63,17 @@ module Bookbinder
             local_file_system_accessor,
             Sheller.new,
             Dir.pwd,
-            colored_streams
+            streams
           ),
           build_and_push_tarball,
           bind,
-          Commands::PushFromLocal.new(logger, configuration_fetcher, 'acceptance'),
+          Commands::PushFromLocal.new(streams, logger, configuration_fetcher, 'acceptance'),
           push_local_to_staging,
-          Commands::PushToProd.new(logger, configuration_fetcher),
+          Commands::PushToProd.new(streams, logger, configuration_fetcher, Dir.mktmpdir),
           Commands::RunPublishCI.new(bind, push_local_to_staging, build_and_push_tarball),
-          Commands::Tag.new(logger, configuration_fetcher, version_control_system),
+          Commands::Tag.new(streams, configuration_fetcher, version_control_system),
           Commands::UpdateLocalDocRepos.new(
-            colored_streams,
+            streams,
             configuration_fetcher,
             version_control_system
           ),
@@ -86,13 +86,13 @@ module Bookbinder
 
       def bind
         @bind ||= Commands::Bind.new(
-          colored_streams,
+          streams,
           OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
           Config::BindConfigFactory.new(version_control_system, configuration_fetcher),
           Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           local_file_system_accessor,
           MiddlemanRunner.new(logger, version_control_system),
-          PostProduction::SitemapWriter.build(logger, final_app_directory, sitemap_port),
+          Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
           Preprocessing::Preprocessor.new(
             Preprocessing::DitaPreprocessor.new(
               DitaHtmlToMiddlemanFormatter.new(local_file_system_accessor, subnav_formatter, html_document_manipulator),
@@ -100,9 +100,9 @@ module Bookbinder
               DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY']),
               Sheller.new
             ),
-            Preprocessing::CopyToSiteGenDir.new(local_file_system_accessor),
+            Preprocessing::LinkToSiteGenDir.new(local_file_system_accessor),
           ),
-          Ingest::ClonerFactory.new(logger, local_file_system_accessor, version_control_system),
+          Ingest::ClonerFactory.new(streams, local_file_system_accessor, version_control_system),
           Ingest::SectionRepositoryFactory.new(logger),
           Commands::BindComponents::DirectoryPreparer.new(logger, local_file_system_accessor, version_control_system)
         )
@@ -110,6 +110,7 @@ module Bookbinder
 
       def push_local_to_staging
         @push_local_to_staging ||= Commands::PushFromLocal.new(
+          streams,
           logger,
           configuration_fetcher,
           'staging'
@@ -118,17 +119,11 @@ module Bookbinder
 
       def build_and_push_tarball
         @build_and_push_tarball ||= Commands::BuildAndPushTarball.new(
-          logger,
+          streams,
           configuration_fetcher
         )
       end
 
-      def colored_streams
-        { out: base_streams[:out],
-          success: Streams::ColorizedStream.new(Colorizer::Colors.green, base_streams[:out]),
-          err: Streams::ColorizedStream.new(Colorizer::Colors.red, base_streams[:err]) }
-      end
-
       def configuration_fetcher
         @configuration_fetcher ||= Config::Fetcher.new(
           Config::Validator.new(local_file_system_accessor),

data/lib/bookbinder/commands/push_from_local.rb

@@ -1,5 +1,5 @@
-require_relative '../distributor'
-require_relative 'bookbinder_command'
+require_relative '../deploy/deployment'
+require_relative '../deploy/distributor'
 require_relative 'naming'
 
 module Bookbinder
@@ -11,7 +11,8 @@ module Bookbinder
       REQUIRED_AWS_KEYS = %w(access_key secret_key green_builds_bucket)
       REQUIRED_CF_KEYS = %w(username password api_endpoint organization app_name)
 
-      def initialize(logger, configuration_fetcher, environment)
+      def initialize(streams, logger, configuration_fetcher, environment)
+        @streams = streams
         @logger = logger
         @configuration_fetcher = configuration_fetcher
         @environment = environment
@@ -24,33 +25,40 @@ module Bookbinder
 
       def run(_)
         validate
-        Distributor.build(@logger, options).distribute
+        deployment = Deploy::Deployment.new(
+          app_dir: './final_app',
+          aws_credentials: credentials[:aws],
+          book_repo: config.book_repo,
+          build_number: ENV['BUILD_NUMBER'],
+          cf_credentials: credentials[:cloud_foundry]
+        )
+        archive = Deploy::Archive.new(
+          logger: @logger,
+          key: deployment.aws_access_key,
+          secret: deployment.aws_secret_key
+        )
+        Deploy::Distributor.build(
+          streams,
+          archive,
+          deployment
+        ).distribute
         0
       end
 
       private
 
-      attr_reader :configuration_fetcher, :environment
+      attr_reader :configuration_fetcher, :environment, :streams
 
       def config
-        @config ||= configuration_fetcher.fetch_config
+        configuration_fetcher.fetch_config
       end
 
-      def command_name
-        "push_local_to_#{environment}"
+      def credentials
+        configuration_fetcher.fetch_credentials(environment)
       end
 
-      def options
-        credentials = configuration_fetcher.fetch_credentials(environment)
-        {
-            app_dir: './final_app',
-            build_number: ENV['BUILD_NUMBER'],
-
-            aws_credentials: credentials[:aws],
-            cf_credentials: credentials[:cloud_foundry],
-
-            book_repo: config.book_repo,
-        }
+      def command_name
+        "push_local_to_#{environment}"
       end
 
       def error_message