bard 1.0.1 → 1.0.2

data/lib/bard/cli.rb

@@ -1,17 +1,9 @@
 # this file gets loaded in the CLI context, not the Rails boot context
 
 require "thor"
-require "bard/git"
-require "bard/ci"
-require "bard/copy"
-require "bard/github"
-require "bard/ping"
 require "bard/config"
 require "bard/command"
-require "bard/provision"
 require "term/ansicolor"
-require "open3"
-require "uri"
 
 module Bard
   class CLI < Thor
@@ -19,244 +11,24 @@ module Bard
 
     class_option :verbose, type: :boolean, aliases: :v
 
-    desc "data --from=production --to=local", "copy database and assets from from to to"
-    option :from, default: "production"
-    option :to, default: "local"
-    def data
-      from = config[options[:from]]
-      to = config[options[:to]]
-
-      if to.key == :production
-        url = to.ping.first
-        puts yellow "WARNING: You are about to push data to production, overwriting everything that is there!"
-        answer = ask("If you really want to do this, please type in the full HTTPS url of the production server:")
-        if answer != url
-          puts red("!!! ") + "Failed! We expected #{url}. Is this really where you want to overwrite all the data?"
-          exit 1
-        end
-      end
-
-      puts "Dumping #{from.key} database to file..."
-      from.run! "bin/rake db:dump"
-
-      puts "Transfering file from #{from.key} to #{to.key}..."
-      from.copy_file "db/data.sql.gz", to: to, verbose: true
-
-      puts "Loading file into #{to.key} database..."
-      to.run! "bin/rake db:load"
-
-      config.data.each do |path|
-        puts "Synchronizing files in #{path}..."
-        from.copy_dir path, to: to, verbose: true
-      end
-    end
-
-    desc "master_key --from=production --to=local", "copy master key from from to to"
-    option :from, default: "production"
-    option :to, default: "local"
-    def master_key
-      from = config[options[:from]]
-      to = config[options[:to]]
-      from.copy_file "config/master.key", to:
-    end
-
-    desc "stage [branch=HEAD]", "pushes current branch, and stages it"
-    def stage branch=Git.current_branch
-      unless config.servers.key?(:production)
-        raise Thor::Error.new("`bard stage` is disabled until a production server is defined. Until then, please use `bard deploy` to deploy to the staging server.")
-      end
-
-      run! "git push -u origin #{branch}", verbose: true
-      config[:staging].run! "git fetch && git checkout -f origin/#{branch} && bin/setup"
-      puts green("Stage Succeeded")
-
-      ping :staging
-    end
-
-    option :"skip-ci", type: :boolean
-    option :"local-ci", type: :boolean
-    desc "deploy [TO=production]", "checks that current branch is a ff with master, checks with ci, merges into master, deploys to target, and then deletes branch."
-    def deploy to=:production
-      branch = Git.current_branch
-
-      if branch == "master"
-        if !Git.up_to_date_with_remote?(branch)
-          run! "git push origin #{branch}:#{branch}"
-        end
-        invoke :ci, [branch], options.slice("local-ci") unless options["skip-ci"]
-
-      else
-        run! "git fetch origin master:master"
-
-        unless Git.fast_forward_merge?("origin/master", branch)
-          puts "The master branch has advanced. Attempting rebase..."
-          run! "git rebase origin/master"
-        end
-
-        run! "git push -f origin #{branch}:#{branch}"
-
-        invoke :ci, [branch], options.slice("local-ci") unless options["skip-ci"]
-
-        run! "git push origin #{branch}:master"
-        run! "git fetch origin master:master"
-      end
-
-      if `git remote` =~ /\bgithub\b/
-        run! "git push github"
-      end
-
-      config[to].run! "git pull origin master && bin/setup"
-
-      puts green("Deploy Succeeded")
-
-      if branch != "master"
-        puts "Deleting branch: #{branch}"
-        run! "git push --delete origin #{branch}"
-
-        if branch == Git.current_branch
-          run! "git checkout master"
-        end
-
-        run! "git branch -D #{branch}"
-      end
-
-      ping to
-    end
-
-    option :"local-ci", type: :boolean
-    option :status, type: :boolean
-    desc "ci [branch=HEAD]", "runs ci against BRANCH"
-    def ci branch=Git.current_branch
-      ci = CI.new(project_name, branch, local: options["local-ci"])
-      if ci.exists?
-        return puts ci.status if options["status"]
-
-        puts "Continuous integration: starting build on #{branch}..."
-
-        success = ci.run do |elapsed_time, last_time|
-          if last_time
-            percentage = (elapsed_time.to_f / last_time.to_f * 100).to_i
-            output = "  Estimated completion: #{percentage}%"
-          else
-            output = "  No estimated completion time. Elapsed time: #{elapsed_time} sec"
-          end
-          print "\x08" * output.length
-          print output
-          $stdout.flush
-        end
-
-        if success
-          puts
-          puts "Continuous integration: success!"
-          puts "Deploying..."
-        else
-          puts
-          puts ci.last_response
-          puts ci.console
-          puts red("Automated tests failed!")
-          exit 1
-        end
-
-      else
-        puts red("No CI found for #{project_name}!")
-        puts "Re-run with --skip-ci to bypass CI, if you absolutely must, and know what you're doing."
-        exit 1
-      end
-    end
-
-    desc "open [server=production]", "opens the url in the web browser."
-    def open server=:production
-      exec "xdg-open #{config[server].ping.first}"
-    end
-
-    option :home, type: :boolean
-    desc "ssh [to=production]", "logs into the specified server via SSH"
-    def ssh to=:production
-      config[to].exec! "exec $SHELL -l", home: options[:home]
-    end
-
-    desc "install", "copies bin/setup and bin/ci scripts into current project."
-    def install
-      install_files_path = File.expand_path(File.join(__dir__, "../../install_files/*"))
-      system "cp -R #{install_files_path} bin/"
-      github_files_path = File.expand_path(File.join(__dir__, "../../install_files/.github"))
-      system "cp -R #{github_files_path} ./"
-    end
-
-    desc "provision [ssh_url]", "takes an ssh url to a raw ubuntu 22.04 install, and readies it in the shape of :production"
-    def provision ssh_url
-      Provision.call(config, ssh_url.dup) # dup unfreezes the string for later mutation
-    end
-
-    desc "setup", "installs app in nginx"
-    def setup
-      path = "/etc/nginx/sites-available/#{project_name}"
-      dest_path = path.sub("sites-available", "sites-enabled")
-      server_name = case ENV["RAILS_ENV"]
-      when "production"
-        (config[:production].ping.map do |str|
-          "*.#{URI.parse(str).host}"
-        end + ["_"]).join(" ")
-      when "staging" then "#{project_name}.botandrose.com"
-      else "#{project_name}.localhost"
-      end
-
-      system "sudo tee #{path} >/dev/null <<-EOF
-server {
-  listen 80;
-  server_name #{server_name};
-
-  root #{Dir.pwd}/public;
-  passenger_enabled on;
-
-  location ~* \\.(ico|css|js|gif|jp?g|png|webp) {
-    access_log off;
-    if (\\$request_filename ~ \"-[0-9a-f]{32}\\.\") {
-      expires max;
-      add_header Cache-Control public;
-    }
-  }
-  gzip_static on;
-}
-EOF"
-      system "sudo ln -sf #{path} #{dest_path}" if !File.exist?(dest_path)
-      system "sudo service nginx restart"
-    end
-
-    desc "ping [server=production]", "hits the server over http to verify that its up."
-    def ping server=:production
-      server = config[server]
-      down_urls = Bard::Ping.call(config[server])
-      down_urls.each { |url| puts "#{url} is down!" }
-      exit 1 if down_urls.any?
-    end
-
-    # HACK: we don't use Thor::Base#run, so its okay to stomp on it here
-    original_verbose, $VERBOSE = $VERBOSE, nil
-    Thor::THOR_RESERVED_WORDS -= ["run"]
-    $VERBOSE = original_verbose
-
-    desc "run <command>", "run the given command on production"
-    def run *args
-      server = config[:production]
-      server.run! *args, verbose: true
-    end
-
-    desc "hurt <command>", "reruns a command until it fails"
-    def hurt *args
-      1.upto(Float::INFINITY) do |count|
-        puts "Running attempt #{count}"
-        system *args
-        unless $?.success?
-          puts "Ran #{count-1} times before failing"
-          break
-        end
-      end
-    end
-
-    desc "vim [branch=master]", "open all files that have changed since master"
-    def vim branch="master"
-      exec "vim -p `git diff #{branch} --name-only | grep -v sass$ | tac`"
+    {
+      data: "Data",
+      stage: "Stage",
+      deploy: "Deploy",
+      ci: "CI",
+      master_key: "MasterKey",
+      setup: "Setup",
+      run: "Run",
+      open: "Open",
+      ssh: "SSH",
+      install: "Install",
+      provision: "Provision",
+      ping: "Ping",
+      hurt: "Hurt",
+      vim: "Vim",
+    }.each do |command, klass|
+      require "bard/cli/#{command}"
+      include const_get(klass)
     end
 
     def self.exit_on_failure? = true
@@ -273,6 +45,9 @@ EOF"
 
     def run!(...)
       Bard::Command.run!(...)
+    rescue Bard::Command::Error => e
+      puts red("!!! ") + "Running command failed: #{yellow(e.message)}"
+      exit 1
     end
   end
 end

data/lib/bard/command.rb

@@ -1,5 +1,9 @@
+require "open3"
+
 module Bard
   class Command < Struct.new(:command, :on, :home)
+    class Error < RuntimeError; end
+
     def self.run! command, on: :local, home: false, verbose: false, quiet: false
       new(command, on, home).run! verbose:, quiet:
     end
@@ -14,9 +18,7 @@ module Bard
 
     def run! verbose: false, quiet: false
       if !run(verbose:, quiet:)
-        raise "Running command failed: #{full_command}"
-        # puts red("!!! ") + "Running command failed: #{yellow(command)}"
-        # exit 1
+        raise Error.new(full_command)
       end
     end
 
@@ -49,7 +51,6 @@ module Bard
     end
 
     def remote_command quiet: false
-      uri = on.ssh_uri
       ssh_key = on.ssh_key ? "-i #{on.ssh_key} " : ""
       cmd = command
       if on.env
@@ -58,10 +59,11 @@ module Bard
       unless home
         cmd = "cd #{on.path} && #{cmd}"
       end
-      cmd = "ssh -tt #{ssh_key}#{"-p#{uri.port} " if uri.port}#{uri.user}@#{uri.host} '#{cmd}'"
+      uri = on.ssh_uri
+      cmd = "ssh -tt #{ssh_key} -p#{uri.port} #{uri.user}@#{uri.host} '#{cmd}'"
       if on.gateway
         uri = on.ssh_uri(:gateway)
-        cmd = "ssh -tt #{" -p#{uri.port} " if uri.port}#{uri.user}@#{uri.host} \"#{cmd}\""
+        cmd = "ssh -tt -p#{uri.port} #{uri.user}@#{uri.host} \"#{cmd}\""
       end
       cmd += " 2>&1" if quiet
       cmd

data/lib/bard/config.rb

@@ -12,13 +12,6 @@ module Bard
           "./",
           false,
         ),
-        theia: Server.new(
-          project_name,
-          :theia,
-          "gubito@gubs.pagekite.me",
-          "Sites/#{project_name}",
-          false,
-        ),
         gubs: Server.new(
           project_name,
           :gubs,
@@ -40,7 +33,7 @@ module Bard
         ),
       }
       if path && File.exist?(path)
-        source = File.read(File.expand_path(path))
+        source = File.read(path)
       end
       if source
         instance_eval source
@@ -51,9 +44,7 @@ module Bard
 
     def server key, &block
       key = key.to_sym
-      @servers[key] ||= Server.new(project_name, key)
-      @servers[key].instance_eval &block if block_given?
-      @servers[key]
+      @servers[key] = Server.define(project_name, key, &block)
     end
 
     def [] key

data/lib/bard/copy.rb

@@ -1,3 +1,6 @@
+require "uri"
+require "bard/command"
+
 module Bard
   class Copy < Struct.new(:path, :from, :to, :verbose)
     def self.file path, from:, to:, verbose: false
@@ -19,33 +22,20 @@ module Bard
     end
 
     def scp_using_local direction, server
-      uri = URI.parse("ssh://#{server.gateway}")
-      port = uri.port ? "-p#{uri.port}" : ""
-      gateway = server.gateway ? "-oProxyCommand='ssh #{port} #{uri.user}@#{uri.host} -W %h:%p'" : ""
+      gateway = server.gateway ? "-oProxyCommand='ssh #{server.ssh_uri(:gateway)} -W %h:%p'" : ""
 
       ssh_key = server.ssh_key ? "-i #{server.ssh_key}" : ""
 
-      uri = URI.parse("ssh://#{server.ssh}")
-      port = uri.port ? "-P#{uri.port}" : ""
-      from_and_to = [path, "#{uri.user}@#{uri.host}:#{server.path}/#{path}"]
-
+      from_and_to = [path, server.scp_uri(path)]
       from_and_to.reverse! if direction == :from
-      command = "scp #{gateway} #{ssh_key} #{port} #{from_and_to.join(" ")}"
 
+      command = ["scp", gateway, ssh_key, *from_and_to].join(" ")
       Bard::Command.run! command, verbose: verbose
     end
 
     def scp_as_mediator
       raise NotImplementedError if from.gateway || to.gateway || from.ssh_key || to.ssh_key
-
-      from_uri = URI.parse("ssh://#{from.ssh}")
-      from_str = "scp://#{from_uri.user}@#{from_uri.host}:#{from_uri.port || 22}/#{from.path}/#{path}"
-
-      to_uri = URI.parse("ssh://#{to.ssh}")
-      to_str = "scp://#{to_uri.user}@#{to_uri.host}:#{to_uri.port || 22}/#{to.path}/#{path}"
-
-      command = "scp -o ForwardAgent=yes #{from_str} #{to_str}"
-
+      command = "scp -o ForwardAgent=yes #{from.scp_uri(path)} #{to.scp_uri(path)}"
       Bard::Command.run! command, verbose: verbose
     end
 
@@ -55,46 +45,31 @@ module Bard
       elsif to.key == :local
         rsync_using_local :from, from
       else
-        rsync_as_mediator from, to
+        rsync_as_mediator
       end
     end
 
     def rsync_using_local direction, server
-      uri = URI.parse("ssh://#{server.gateway}")
-      port = uri.port ? "-p#{uri.port}" : ""
-      gateway = server.gateway ? "-oProxyCommand=\"ssh #{port} #{uri.user}@#{uri.host} -W %h:%p\"" : ""
+      gateway = server.gateway ? "-oProxyCommand=\"ssh #{server.ssh_uri(:gateway)} -W %h:%p\"" : ""
 
       ssh_key = server.ssh_key ? "-i #{server.ssh_key}" : ""
-      uri = URI.parse("ssh://#{server.ssh}")
-      port = uri.port ? "-p#{uri.port}" : ""
-      ssh = "-e'ssh #{ssh_key} #{port} #{gateway}'"
+      ssh = "-e'ssh #{gateway} -p#{server.ssh_uri.port || 22}'"
 
-      dest_path = path.dup
-      dest_path = "./#{dest_path}"
-      from_and_to = [dest_path, "#{uri.user}@#{uri.host}:#{server.path}/#{path}"]
+      from_and_to = ["./#{path}", server.rsync_uri(path)]
       from_and_to.reverse! if direction == :from
       from_and_to[-1].sub! %r(/[^/]+$), '/'
 
       command = "rsync #{ssh} --delete --info=progress2 -az #{from_and_to.join(" ")}"
-
       Bard::Command.run! command, verbose: verbose
     end
 
-    def rsync_as_mediator from, to
+    def rsync_as_mediator
       raise NotImplementedError if from.gateway || to.gateway || from.ssh_key || to.ssh_key
 
-      dest_path = path.dup
-      dest_path = "./#{dest_path}"
-
-      from_uri = URI.parse("ssh://#{from.ssh}")
-      from_str = "-p#{from_uri.port || 22} #{from_uri.user}@#{from_uri.host}"
-
-      to_uri = URI.parse("ssh://#{to.ssh}")
-      to_str = "#{to_uri.user}@#{to_uri.host}:#{to.path}/#{path}"
-      to_str.sub! %r(/[^/]+$), '/'
-
-      command = %(ssh -A #{from_str} 'rsync -e \"ssh -A -p#{to_uri.port || 22} -o StrictHostKeyChecking=no\" --delete --info=progress2 -az #{from.path}/#{path} #{to_str}')
+      from_str = "-p#{from.ssh_uri.port || 22} #{from.ssh_uri.user}@#{from.ssh_uri.host}"
+      to_str = to.rsync_uri(path).sub(%r(/[^/]+$), '/')
 
+      command = %(ssh -A #{from_str} 'rsync -e \"ssh -A -p#{to.ssh_uri.port || 22} -o StrictHostKeyChecking=no\" --delete --info=progress2 -az #{from.path}/#{path} #{to_str}')
       Bard::Command.run! command, verbose: verbose
     end
   end

data/lib/bard/git.rb

@@ -8,10 +8,6 @@ module Bard
       ref.sub(/refs\/heads\//, '') # refs/heads/master ... we want "master"
     end
 
-    def current_sha
-      sha_of("HEAD")
-    end
-
     def fast_forward_merge?(root, branch)
       root_head = sha_of(root)
       branch_head = sha_of(branch)
@@ -23,6 +19,8 @@ module Bard
       sha_of(branch) == sha_of("origin/#{branch}")
     end
 
+    private
+
     def sha_of ref
       `git rev-parse #{ref}`.chomp
     end

data/lib/bard/ping.rb

@@ -9,7 +9,6 @@ module Bard
 
     def call
       server.ping.reject do |url|
-        next true if url == false
         response = get_response_with_redirect(url) rescue nil
         response.is_a?(Net::HTTPSuccess)
       end

data/lib/bard/provision/ssh.rb

@@ -27,7 +27,7 @@ class Bard::Provision::SSH < Bard::Provision
     ssh_url << ":#{target_port}"
     puts " ✓"
   end
-  
+ 
   private
 
   def target_port

data/lib/bard/provision.rb

@@ -3,17 +3,10 @@ module Bard
     def self.call(...) = new(...).call
 
     def call
-      SSH.call(*values)
-      User.call(*values)
-      Apt.call(*values)
-      MySQL.call(*values)
-      Repo.call(*values)
-      MasterKey.call(*values)
-      RVM.call(*values)
-      App.call(*values)
-      Passenger.call(*values)
-      Data.call(*values)
-      HTTP.call(*values)
+      %w[SSH User Apt MySQL Repo MasterKey RVM App Passenger Data HTTP].each do |step|
+        require "bard/provision/#{step.downcase}"
+        self.class.const_get(step).call(*values)
+      end
     end
 
     private
@@ -28,15 +21,3 @@ module Bard
   end
 end
 
-require "bard/provision/ssh"
-require "bard/provision/user"
-require "bard/provision/apt"
-require "bard/provision/mysql"
-require "bard/provision/repo"
-require "bard/provision/master_key"
-require "bard/provision/rvm"
-require "bard/provision/app"
-require "bard/provision/passenger"
-require "bard/provision/data"
-require "bard/provision/http"
-

data/lib/bard/server.rb

@@ -3,7 +3,13 @@ require "bard/command"
 require "bard/copy"
 
 module Bard
-  class Server < Struct.new(:project_name, :key, :ssh, :path, :ping, :gateway, :ssh_key, :env, :provision)
+  class Server < Struct.new(:project_name, :key, :ssh, :path, :ping, :gateway, :ssh_key, :env)
+    def self.define project_name, key, &block
+      new(project_name, key).tap do |server|
+        server.instance_eval &block
+      end
+    end
+
     def self.setting *fields
       fields.each do |field|
         define_method field do |*args|
@@ -18,20 +24,19 @@ module Bard
       end
     end
 
-    setting :ssh, :path, :ping, :gateway, :ssh_key, :env, :provision
+    setting :ssh, :path, :ping, :gateway, :ssh_key, :env
 
     def ping(*args)
       if args.length == 0
-        (super() || [nil]).map(&method(:normalize_ping))
+        (super() || [nil]).map(&method(:normalize_ping)).flatten
       else
         self.ping = args
       end
     end
 
     private def normalize_ping value
-      return value if value == false
-      uri = URI.parse("ssh://#{ssh}")
-      normalized = "https://#{uri.host}" # default if none specified
+      return [] if value == false
+      normalized = "https://#{ssh_uri.host}" # default if none specified
       if value =~ %r{^/}
         normalized += value
       elsif value.to_s.length > 0
@@ -55,7 +60,24 @@ module Bard
 
     def ssh_uri which=:ssh
       value = send(which)
-      URI.parse("ssh://#{value}")
+      URI("ssh://#{value}")
+    end
+
+    def scp_uri file_path=nil
+      ssh_uri.dup.tap do |uri|
+        uri.scheme = "scp"
+        uri.path = "/#{path}"
+        uri.path += "/#{file_path}" if file_path
+      end
+    end
+
+    def rsync_uri file_path=nil
+      ssh_uri.dup.tap do |uri|
+        uri.scheme = nil
+        uri.port = nil
+        uri.path = ":#{path}"
+        uri.path += "/#{file_path}" if file_path
+      end.to_s[2..]
     end
 
     def with(attrs)

data/lib/bard/version.rb

@@ -1,4 +1,4 @@
 module Bard
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end
 

data/spec/bard/ci_spec.rb

@@ -0,0 +1,10 @@
+require "bard/ci"
+
+describe Bard::CI do
+  subject { described_class.new("tracker", "master") }
+
+  describe "#exists?"
+  describe "#status"
+  describe "#console"
+  describe "#run"
+end