bard 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbadd22fc4903fa9e779a515d0a7c9448392ac4fe2396ae2272bab7daeb4018
-  data.tar.gz: '068143adee00988e0506bb8e834ad5a15ebf65caf9e824d7a7f8e3923b9dbf18'
+  metadata.gz: 5827b2cb31e34dfbdf111fbdfd52226e5440c3c747de441b8c70bb24a4de9309
+  data.tar.gz: 4a8664eebd8bed4cfdd1fdb85938dbe1356817e5ea21f159c7919bb3be0a8f63
 SHA512:
-  metadata.gz: b12423bf86e5978f48a4864c0572585aa583af33d1b1d6cdcdfb3e466b511d00e7e887908720346b6b13e7f09baa4948e511d717dbea34f72883a27385f58d6b
-  data.tar.gz: 73451d824a62f1f8953f83d89055e87355018aebbf0b92d05741e17391db204be01d594afcedd113bbb347f065a3e42ed3dffc387ebcb94118670e9ce08f0316
+  metadata.gz: 04fc3e6e447298b74e73262a30bb188845ec86f39a63779437fb1a43d6b7a9bc2fbb9ced0e6c99df681704370f42526674d9c0d4cc83f12e0da09782c7bddd0a
+  data.tar.gz: 54c654366cb8400bd5a7549b586662617e236bd96f9c48f299776d0454eafeb6b9a75a468582999fc4d88cfddb3856637cb9f3e6973adec2342944bda5d63eb0

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 

data/features/bard_check.feature

@@ -17,7 +17,7 @@ Feature: Bard can check its environment for missing dependencies and potential p
     And the database is missing
     When I type "bard check"
     Then I should see the fatal error "missing database"
-  
+ 
   Scenario: Bard check detects pending migrations
     Given a shared rails project
     And a commit with a new migration

data/features/bard_push.feature

@@ -42,7 +42,7 @@ Feature: bard push
     Then on staging, there should be one new submodule
     And the submodule branch should match the submodule origin branch
     And on staging, the submodule working directory should be clean
-  
+ 
   Scenario: Pushing a change that includes a submodule update
     Given a submodule
     And a commit with a submodule update

data/features/step_definitions/global_steps.rb

@@ -3,11 +3,11 @@ Given /^a shared rails project$/ do
   Dir.foreach "#{ROOT}/tmp" do |file|
     FileUtils.rm_rf("#{ROOT}/tmp/#{file}") unless %w(fixtures . ..).include? file
   end
-  
+
   # SETUP
   Dir.chdir ROOT
   `cp -r tmp/fixtures/* tmp/`
-  
+
   Dir.chdir 'tmp'
   @repos = {}
   %w(development_a development_b staging production).each do |env|
@@ -44,11 +44,11 @@ Then /^I should see the fatal error "([^\"]*)"$/ do |error_message|
 end
 
 Then /^I should see the warning "([^\"]*)"$/ do |warning_message|
-  @stderr.should include(warning_message) 
+  @stderr.should include(warning_message)
 end
 
 Then /^I should see "([^\"]*)"$/ do |message|
-  @stdout.should include(message) 
+  @stdout.should include(message)
 end
 
 Then /^debug$/ do

data/features/support/env.rb

@@ -18,7 +18,7 @@ if File.exist?("/dev/shm")
   FileUtils.rm_rf tmp_dir
   FileUtils.mkdir tmp_dir
   `ln -s #{tmp_dir} tmp`
-else 
+else
   FileUtils.rm_rf "tmp"
   FileUtils.mkdir "tmp"
 end

data/features/support/io.rb

@@ -18,7 +18,7 @@ end
 
 def file_inject(file_name, sentinel, string, before_after=:after)
   gsub_file file_name, /(#{Regexp.escape(sentinel)})/mi do |match|
-    if before_after == :after 
+    if before_after == :after
       "#{match}\n#{string}"
     else
       "#{string}\n#{match}"

data/lib/bard/ci/github_actions.rb

@@ -27,17 +27,14 @@ module Bard
         @run.console
       end
 
-      def last_response
-      end
-
       def status
         last_run = api.last_run
         if last_run.building?
-          puts "Building..."
+          "Building..."
         elsif last_run.success?
-          puts "Succeeded!"
+          "Succeeded!"
         elsif last_run.failure?
-          puts "Failed!\n\n#{last_run.console}"
+          "Failed!\n\n#{last_run.console}"
         else
           raise "Unknown job status: #{last_run.inspect}"
         end

data/lib/bard/ci/local.rb

@@ -28,8 +28,6 @@ module Bard
         @console
       end
 
-      attr_accessor :last_response
-
       private
 
       def start

data/lib/bard/ci.rb

@@ -8,18 +8,10 @@ module Bard
       @local = !!local
     end
 
-    attr_reader :project_name, :branch, :runner
-
-    def sha
-      @sha ||= `git rev-parse #{branch}`.chomp
-    end
-
-    def runner
-      @runner ||= choose_runner_class.new(project_name, branch, sha)
-    end
-
     extend Forwardable
-    delegate [:run, :exists?, :console, :last_response, :status] => :runner
+    delegate [:run, :exists?, :console, :status] => :runner
+
+    private
 
     def local?
       @local
@@ -33,7 +25,13 @@ module Bard
       !local? && !github_actions?
     end
 
-    private
+    def runner
+      @runner ||= choose_runner_class.new(@project_name, @branch, sha)
+    end
+
+    def sha
+      @sha ||= `git rev-parse #{@branch}`.chomp
+    end
 
     def choose_runner_class
       if local?

data/lib/bard/cli/ci.rb

@@ -0,0 +1,51 @@
+require "bard/ci"
+require "bard/git"
+
+module Bard::CLI::CI
+  def self.included mod
+    mod.class_eval do
+
+      option :"local-ci", type: :boolean
+      option :status, type: :boolean
+      desc "ci [branch=HEAD]", "runs ci against BRANCH"
+      def ci branch=Bard::Git.current_branch
+        ci = Bard::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.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
+
+    end
+  end
+end
+

data/lib/bard/cli/data.rb

@@ -0,0 +1,45 @@
+require "bard/command"
+
+module Bard::CLI::Data
+  def self.included mod
+    mod.class_eval do
+
+      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
+      rescue Bard::Command::Error => e
+        puts red("!!! ") + "Running command failed: #{yellow(e.message)}"
+        exit 1
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/deploy.rb

@@ -0,0 +1,64 @@
+require "bard/git"
+require "bard/command"
+
+module Bard::CLI::Deploy
+  def self.included mod
+    mod.class_eval do
+
+      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 = Bard::Git.current_branch
+
+        if branch == "master"
+          if !Bard::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 Bard::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 == Bard::Git.current_branch
+            run! "git checkout master"
+          end
+
+          run! "git branch -D #{branch}"
+        end
+
+        ping to
+      rescue Bard::Command::Error => e
+        puts red("!!! ") + "Running command failed: #{yellow(e.message)}"
+        exit 1
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/hurt.rb

@@ -0,0 +1,20 @@
+module Bard::CLI::Hurt
+  def self.included mod
+    mod.class_eval do
+
+      desc "hurt <command>", "reruns a command until it fails"
+      def hurt *args
+        (1..).each do |count|
+          puts "Running attempt #{count}"
+          system *args
+          unless $?.success?
+            puts "Ran #{count-1} times before failing"
+            break
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/install.rb

@@ -0,0 +1,16 @@
+module Bard::CLI::Install
+  def self.included mod
+    mod.class_eval do
+
+      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
+
+    end
+  end
+end
+

data/lib/bard/cli/master_key.rb

@@ -0,0 +1,17 @@
+module Bard::CLI::MasterKey
+  def self.included mod
+    mod.class_eval do
+
+      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
+
+    end
+  end
+end
+

data/lib/bard/cli/open.rb

@@ -0,0 +1,13 @@
+module Bard::CLI::Open
+  def self.included mod
+    mod.class_eval do
+
+      desc "open [server=production]", "opens the url in the web browser."
+      def open server=:production
+        exec "xdg-open #{config[server].ping.first}"
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/ping.rb

@@ -0,0 +1,18 @@
+require "bard/ping"
+
+module Bard::CLI::Ping
+  def self.included mod
+    mod.class_eval do
+
+      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
+
+    end
+  end
+end
+

data/lib/bard/cli/provision.rb

@@ -0,0 +1,15 @@
+require "bard/provision"
+
+module Bard::CLI::Provision
+  def self.included mod
+    mod.class_eval do
+
+      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
+        Bard::Provision.call(config, ssh_url.dup) # dup unfreezes the string for later mutation
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/run.rb

@@ -0,0 +1,24 @@
+require "bard/command"
+
+module Bard::CLI::Run
+  def self.included mod
+    mod.class_eval do
+
+      # 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
+      rescue Bard::Command::Error => e
+        puts red("!!! ") + "Running command failed: #{yellow(e.message)}"
+        exit 1
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/setup.rb

@@ -0,0 +1,45 @@
+require "uri"
+
+module Bard::CLI::Setup
+  def self.included mod
+    mod.class_eval do
+
+      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
+
+    end
+  end
+end
+

data/lib/bard/cli/ssh.rb

@@ -0,0 +1,14 @@
+module Bard::CLI::SSH
+  def self.included mod
+    mod.class_eval do
+
+      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
+
+    end
+  end
+end
+

data/lib/bard/cli/stage.rb

@@ -0,0 +1,27 @@
+require "bard/git"
+require "bard/command"
+
+module Bard::CLI::Stage
+  def self.included mod
+    mod.class_eval do
+
+      desc "stage [branch=HEAD]", "pushes current branch, and stages it"
+      def stage branch=Bard::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
+      rescue Bard::Command::Error => e
+        puts red("!!! ") + "Running command failed: #{yellow(e.message)}"
+        exit 1
+      end
+
+    end
+  end
+end
+

data/lib/bard/cli/vim.rb

@@ -0,0 +1,13 @@
+module Bard::CLI::Vim
+  def self.included mod
+    mod.class_eval do
+
+      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`"
+      end
+
+    end
+  end
+end
+