bard 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d6d4352d9957502860997ea4c05c9df90cffd4eab76391041c913483892c7f
-  data.tar.gz: ad893862a2a2a3968f12c8c034a08c8c92d3f07aade157ba60ab676e39f10ae0
+  metadata.gz: a11cf0d4ee1ff435809dbe0e48beb1dcff72f2a4191fa39c40ef8932bbf64915
+  data.tar.gz: 4861d2109f0cb0d438dd281425865ac8c0496019c8529560464fab55c05b5da7
 SHA512:
-  metadata.gz: 7036c5b3d97b827c62905238d4cf66c53e56aeac82f847c29877ae7482dabeece807f6ffec6cf9bfbf9b2c4796ae33e40d2713509b906ee8754aa2f4cc1521be
-  data.tar.gz: 895b98dc68a3144eee0d4ad72a4a47d38bfffdbdf520d5f029a8484a356f57d80b447e7d335d2f67e49cae2e566e7e7601c4109fc2b6664be0078040b6224d35
+  metadata.gz: 53d527f268f68f7b5a61cae324e583f83c26246bd69f4717a37e10c2e1ae44ca53d7d3b194a60454a82c1471ba8588f1182177dd7994b41c193739889a0d5a36
+  data.tar.gz: 669b2ae00f5c9983fed2747e1426f48710c5da142b3d43cda7bb0c7c3c160dc9ee52385f606ea65dbf087803733461bf4ce71d15b3bb8ed5373737555dd441a8

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 group :test do
   gem "simplecov", require: false
   gem "webmock", require: false
-end
+end

data/bard.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "debug"
+  spec.add_development_dependency "cucumber"
   spec.add_development_dependency "testcontainers"
 end

data/features/podman_testcontainers.feature

@@ -0,0 +1,16 @@
+@podman
+Feature: bard run against a podman TestContainers host
+  Background:
+    Given a podman testcontainer is ready for bard
+
+  Scenario: Running ls via bard run
+    Given a remote file "test-file.txt" exists in the test container
+    When I run bard "ls" against the test container
+    Then the bard command should succeed
+    And the bard output should include "test-file.txt"
+
+  Scenario: Running commands in isolated containers
+    Given a remote file "another-file.txt" containing "content" exists in the test container
+    When I run bard "cat another-file.txt" against the test container
+    Then the bard command should succeed
+    And the bard output should include "content"

data/features/step_definitions/podman_steps.rb

@@ -0,0 +1,23 @@
+Given /^a podman testcontainer is ready for bard$/ do
+  raise "Podman testcontainer failed to start" unless @podman_container && @podman_ssh_port
+end
+
+Given /^a remote file "([^\"]+)" exists in the test container$/ do |filename|
+  run_ssh("touch testproject/#{filename}").should be_true
+end
+
+Given /^a remote file "([^\"]+)" containing "([^\"]+)" exists in the test container$/ do |filename, content|
+  run_ssh("echo #{Shellwords.escape(content)} > testproject/#{filename}").should be_true
+end
+
+When /^I run bard "([^\"]+)" against the test container$/ do |command|
+  run_bard_against_container(command)
+end
+
+Then /^the bard command should succeed$/ do
+  @status.success?.should be_true
+end
+
+Then /^the bard output should include "([^\"]+)"$/ do |expected|
+  @stdout.should include(expected)
+end

data/features/support/podman.rb

@@ -0,0 +1,153 @@
+require "fileutils"
+require "open3"
+require "securerandom"
+require "shellwords"
+require "testcontainers"
+
+module PodmanWorld
+  class << self
+    attr_accessor :podman_available, :podman_image_built
+  end
+
+  class PrerequisiteError < StandardError; end
+
+  def ensure_podman_available
+    return if @podman_available || PodmanWorld.podman_available
+
+    raise PrerequisiteError, "podman is not installed or not on PATH" unless system("command -v podman >/dev/null 2>&1")
+
+    configure_podman_socket
+    ensure_bard_test_image
+    FileUtils.chmod(0o600, podman_ssh_key_path)
+
+    PodmanWorld.podman_available = true
+    @podman_available = true
+  end
+
+  def configure_podman_socket
+    return if ENV["DOCKER_HOST"]
+
+    podman_socket = "/run/user/#{Process.uid}/podman/podman.sock"
+    unless File.exist?(podman_socket)
+      system("systemctl --user start podman.socket 2>/dev/null || podman system service --time=0 unix://#{podman_socket} &")
+      sleep 2
+    end
+
+    raise PrerequisiteError, "Podman socket not available at #{podman_socket}" unless File.exist?(podman_socket)
+
+    ENV["DOCKER_HOST"] = "unix://#{podman_socket}"
+  end
+
+  def ensure_bard_test_image
+    return if @podman_image_built || PodmanWorld.podman_image_built
+
+    raise PrerequisiteError, "Unable to pull ubuntu:22.04 image" unless system("podman pull ubuntu:22.04 >/dev/null 2>&1")
+
+    docker_dir = File.join(ROOT, "spec/acceptance/docker")
+    dockerfile = File.join(docker_dir, "Dockerfile")
+    unless system("podman build -t bard-test-server -f #{dockerfile} #{docker_dir} 2>&1")
+      raise PrerequisiteError, "Failed to build bard test image"
+    end
+
+    PodmanWorld.podman_image_built = true
+    @podman_image_built = true
+  end
+
+  def start_podman_container
+    ensure_podman_available
+
+    @podman_container = Testcontainers::DockerContainer
+      .new("localhost/bard-test-server:latest")
+      .with_exposed_port(22)
+      .with_name("bard-test-#{SecureRandom.hex(4)}")
+      .start
+
+    @podman_ssh_port = @podman_container.mapped_port(22)
+    wait_for_ssh
+    run_ssh("mkdir -p testproject")
+    write_bard_config
+  end
+
+  def wait_for_ssh
+    30.times do
+      return if run_ssh("echo ready", quiet: true)
+      sleep 0.5
+    end
+
+    raise PrerequisiteError, "SSH in podman container did not become ready"
+  end
+
+  def write_bard_config
+    FileUtils.mkdir_p(File.join(ROOT, "tmp"))
+    @bard_config_path = File.join(ROOT, "tmp", "test_bard_#{SecureRandom.hex(4)}.rb")
+
+    File.write(@bard_config_path, <<~RUBY)
+      server :production do
+        ssh "deploy@localhost:#{@podman_ssh_port}"
+        path "testproject"
+        ssh_key "#{podman_ssh_key_path}"
+        ping false
+      end
+    RUBY
+  end
+
+  def run_ssh(command, quiet: false)
+    escaped = Shellwords.escape(command)
+    ssh_command = [
+      "ssh",
+      "-o", "StrictHostKeyChecking=no",
+      "-o", "ConnectTimeout=1",
+      "-p", @podman_ssh_port.to_s,
+      "-i", podman_ssh_key_path,
+      "deploy@localhost",
+      "--",
+      "bash",
+      "-lc",
+      escaped
+    ].join(" ")
+
+    quiet ? system("#{ssh_command} >/dev/null 2>&1") : system(ssh_command)
+  end
+
+  def run_bard_against_container(command)
+    Dir.chdir(File.join(ROOT, "tmp")) do
+      FileUtils.cp(@bard_config_path, "bard.rb")
+      @stdout, @status = Open3.capture2e(@env || {}, "bard run #{command}")
+      @stderr = ""
+      FileUtils.rm_f("bard.rb")
+    end
+  end
+
+  def podman_ssh_key_path
+    @podman_ssh_key_path ||= File.expand_path(File.join(ROOT, "spec/acceptance/docker/test_key"))
+  end
+
+  def stop_podman_container
+    FileUtils.rm_f(@bard_config_path) if @bard_config_path
+    return unless @podman_container
+
+    @podman_container.stop
+    @podman_container.remove
+  rescue StandardError => e
+    warn "Failed to cleanup podman container: #{e.message}"
+  ensure
+    @podman_container = nil
+    @podman_ssh_port = nil
+  end
+end
+
+World(PodmanWorld)
+
+Before("@podman") do
+  @env ||= {}
+
+  begin
+    start_podman_container
+  rescue PodmanWorld::PrerequisiteError => e
+    pending(e.message)
+  end
+end
+
+After("@podman") do
+  stop_podman_container
+end

data/lib/bard/config.rb

@@ -2,6 +2,12 @@ require "bard/server"
 
 module Bard
   class Config
+    def self.current(working_directory: Dir.getwd)
+      project_name = File.basename(working_directory)
+      path = File.join(working_directory, "bard.rb")
+      new(project_name, path: path)
+    end
+
     def initialize project_name, path: nil, source: nil
       @project_name = project_name
       @servers = {
@@ -69,30 +75,23 @@ module Bard
       if block_given?
         @backup = BackupConfig.new(&block)
       elsif value == false
-        @backup = false
-      elsif value == true
-        # Backward compatibility: backup true
-        @backup = BackupConfig.new { bard }
-      elsif value.nil?
-        # Getter
-        return @backup if defined?(@backup)
-        @backup = BackupConfig.new { bard }  # Default
+        @backup = BackupConfig.new { disabled }
+      elsif value.nil? # Getter
+        @backup ||= BackupConfig.new { bard }
       else
-        raise ArgumentError, "backup accepts a block, true, or false"
+        raise ArgumentError, "backup accepts false or a block"
       end
     end
 
     # short-hand for michael
 
-    def github_pages url=nil
+    def github_pages url
       urls = []
-      if url.present?
-        uri = url.start_with?("http") ? URI.parse(url) : URI.parse("https://#{url}")
-        hostname = uri.hostname.sub(/^www\./, '')
-        urls = [hostname]
-        if hostname.count(".") < 2
-          urls << "www.#{hostname}"
-        end
+      uri = url.start_with?("http") ? URI.parse(url) : URI.parse("https://#{url}")
+      hostname = uri.hostname.sub(/^www\./, '')
+      urls = [hostname]
+      if hostname.count(".") < 2
+        urls << "www.#{hostname}"
       end
 
       server :production do
@@ -106,31 +105,41 @@ module Bard
   end
 
   class BackupConfig
-    attr_reader :bard_enabled, :destinations
+    attr_reader :destinations
 
     def initialize(&block)
-      @bard_enabled = false
       @destinations = []
       instance_eval(&block) if block_given?
     end
 
     def bard
-      @bard_enabled = true
+      @bard = true
+    end
+
+    def bard?
+      !!@bard
+    end
+
+    def disabled
+      @disabled = true
     end
 
-    def s3(name, credentials:, path:)
+    def disabled?
+      !!@disabled
+    end
+
+    def enabled?
+      !disabled?
+    end
+
+    def s3(name, **kwargs)
       @destinations << {
         name: name,
         type: :s3,
-        credentials: credentials,
-        path: path
+        **kwargs,
       }
     end
 
-    def bard?
-      @bard_enabled
-    end
-
     def self_managed?
       @destinations.any?
     end

data/lib/bard/version.rb

@@ -1,4 +1,4 @@
 module Bard
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end
 

data/spec/bard/config_spec.rb

@@ -78,7 +78,7 @@ describe Bard::Config do
 
     describe "#backup" do
       it "returns the backup setting" do
-        expect(subject.backup).to eq false
+        expect(subject.backup).to be_disabled
       end
     end
   end
@@ -97,7 +97,7 @@ describe Bard::Config do
     end
 
     describe "#backup with s3 directive" do
-      subject { described_class.new("test", source: "backup { s3 :primary, credentials: :backup, path: 'bucket/path' }") }
+      subject { described_class.new("test", source: "backup { s3 :primary, path: 'bucket/path' }") }
 
       it "returns a BackupConfig with s3 destination" do
         backup = subject.backup
@@ -109,13 +109,12 @@ describe Bard::Config do
         dest = backup.destinations.first
         expect(dest[:name]).to eq :primary
         expect(dest[:type]).to eq :s3
-        expect(dest[:credentials]).to eq :backup
         expect(dest[:path]).to eq 'bucket/path'
       end
     end
 
     describe "#backup with both bard and s3 directives" do
-      subject { described_class.new("test", source: "backup { bard; s3 :custom, credentials: :backup, path: 'bucket/path' }") }
+      subject { described_class.new("test", source: "backup { bard; s3 :custom, path: 'bucket/path' }") }
 
       it "returns a BackupConfig with bard and s3 destination" do
         backup = subject.backup
@@ -130,8 +129,8 @@ describe Bard::Config do
       subject do
         described_class.new("test", source: <<~SOURCE)
           backup do
-            s3 :primary, credentials: :backup1, path: 'bucket1/path'
-            s3 :secondary, credentials: :backup2, path: 'bucket2/path'
+            s3 :primary, path: 'bucket1/path'
+            s3 :secondary, path: 'bucket2/path'
           end
         SOURCE
       end
@@ -147,15 +146,23 @@ describe Bard::Config do
         expect(backup.destinations[1][:name]).to eq :secondary
       end
     end
+  end
 
-    describe "#backup true (backward compatibility)" do
-      subject { described_class.new("test", source: "backup true") }
+  context "with github_pages directive" do
+    subject { described_class.new("test", source: "github_pages 'example.com'") }
 
-      it "returns a BackupConfig with bard enabled" do
-        backup = subject.backup
-        expect(backup).to be_a(Bard::BackupConfig)
-        expect(backup.bard?).to eq true
-        expect(backup.destinations).to be_empty
+    describe "#backup" do
+      it "sets backup to false" do
+        expect(subject.backup).to be_disabled
+      end
+    end
+
+    describe "#server" do
+      it "creates a production server with github_pages enabled" do
+        production = subject[:production]
+        expect(production).not_to be_nil
+        expect(production.github_pages).to eq true
+        expect(production.ssh).to eq false
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bard
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Micah Geisel
 bindir: bin
 cert_chain: []
-date: 2025-12-06 00:00:00.000000000 Z
+date: 2025-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -121,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: testcontainers
   requirement: !ruby/object:Gem::Requirement
@@ -157,14 +171,17 @@ files:
 - features/bard_deploy.feature
 - features/bard_pull.feature
 - features/bard_push.feature
+- features/podman_testcontainers.feature
 - features/step_definitions/check_steps.rb
 - features/step_definitions/git_steps.rb
 - features/step_definitions/global_steps.rb
+- features/step_definitions/podman_steps.rb
 - features/step_definitions/rails_steps.rb
 - features/step_definitions/submodule_steps.rb
 - features/support/env.rb
 - features/support/grit_ext.rb
 - features/support/io.rb
+- features/support/podman.rb
 - install_files/.github/dependabot.yml
 - install_files/.github/workflows/cache-ci.yml
 - install_files/.github/workflows/ci.yml
@@ -228,7 +245,6 @@ files:
 - spec/acceptance/docker/Dockerfile
 - spec/acceptance/docker/test_key
 - spec/acceptance/docker/test_key.pub
-- spec/acceptance/podman_testcontainers_spec.rb
 - spec/bard/ci/github_actions_spec.rb
 - spec/bard/ci_spec.rb
 - spec/bard/cli/ci_spec.rb
@@ -301,19 +317,21 @@ test_files:
 - features/bard_deploy.feature
 - features/bard_pull.feature
 - features/bard_push.feature
+- features/podman_testcontainers.feature
 - features/step_definitions/check_steps.rb
 - features/step_definitions/git_steps.rb
 - features/step_definitions/global_steps.rb
+- features/step_definitions/podman_steps.rb
 - features/step_definitions/rails_steps.rb
 - features/step_definitions/submodule_steps.rb
 - features/support/env.rb
 - features/support/grit_ext.rb
 - features/support/io.rb
+- features/support/podman.rb
 - spec/acceptance/.gitignore
 - spec/acceptance/docker/Dockerfile
 - spec/acceptance/docker/test_key
 - spec/acceptance/docker/test_key.pub
-- spec/acceptance/podman_testcontainers_spec.rb
 - spec/bard/ci/github_actions_spec.rb
 - spec/bard/ci_spec.rb
 - spec/bard/cli/ci_spec.rb

data/spec/acceptance/podman_testcontainers_spec.rb

@@ -1,140 +0,0 @@
-# Acceptance test for Bard using Podman + TestContainers
-#
-# This test validates end-to-end functionality of `bard run ls` by:
-# 1. Starting an SSH server container using TestContainers
-# 2. Configuring Bard to connect to it
-# 3. Running bard commands against the container
-# 4. Automatically cleaning up when done
-#
-# Prerequisites:
-# - gem install testcontainers
-# - podman installed
-# - podman socket running (systemctl --user start podman.socket)
-# - Set DOCKER_HOST to podman socket
-
-require 'spec_helper'
-require 'testcontainers'
-require 'open3'
-
-RSpec.describe "Bard acceptance test with Podman + TestContainers", type: :acceptance do
-  # Disable WebMock for acceptance tests - we need real HTTP connections to Podman
-  before(:all) do
-    WebMock.allow_net_connect!
-  end
-
-  after(:all) do
-    WebMock.disable_net_connect!
-  end
-  # Configure TestContainers to use Podman
-  before(:all) do
-    # Set up podman socket for TestContainers
-    # Use existing DOCKER_HOST if set (e.g., in CI), otherwise use default location
-    unless ENV['DOCKER_HOST']
-      podman_socket = "/run/user/#{Process.uid}/podman/podman.sock"
-
-      # Start podman socket if not running
-      unless File.exist?(podman_socket)
-        system("systemctl --user start podman.socket 2>/dev/null || podman system service --time=0 unix://#{podman_socket} &")
-        sleep 2
-      end
-
-      # Configure TestContainers to use podman
-      ENV['DOCKER_HOST'] = "unix://#{podman_socket}"
-    end
-
-    # Ensure SSH key has correct permissions
-    system("chmod 600 spec/acceptance/docker/test_key")
-
-    # Check if we can pull images
-    unless system("podman pull ubuntu:22.04 >/dev/null 2>&1")
-      skip "Cannot pull images in this environment. Run in a network-enabled environment."
-    end
-
-    # Build the test image
-    unless system("podman build -t bard-test-server -f spec/acceptance/docker/Dockerfile spec/acceptance/docker 2>&1")
-      skip "Failed to build test image"
-    end
-  end
-
-  # TestContainers will automatically manage this container
-  let(:container) do
-    Testcontainers::DockerContainer.new("localhost/bard-test-server:latest")
-      .with_exposed_port(22)
-      .with_name("bard-test-#{SecureRandom.hex(4)}")
-      .start
-  end
-
-  let(:ssh_port) { container.mapped_port(22) }
-
-  before(:each) do
-    # Ensure container is started
-    container
-
-    # Wait for SSH to be ready
-    30.times do
-      break if system("ssh -o StrictHostKeyChecking=no -o ConnectTimeout=1 -p #{ssh_port} deploy@localhost -i spec/acceptance/docker/test_key 'echo ready' 2>/dev/null")
-      sleep 0.5
-    end
-
-    # Create test project directory
-    system("ssh -o StrictHostKeyChecking=no -p #{ssh_port} deploy@localhost -i spec/acceptance/docker/test_key 'mkdir -p testproject'")
-
-    # Create bard config for this container
-    @bard_config_path = "tmp/test_bard_#{SecureRandom.hex(4)}.rb"
-    FileUtils.mkdir_p("tmp")
-    ssh_key_path = File.expand_path("spec/acceptance/docker/test_key")
-    File.write(@bard_config_path, <<~RUBY)
-      server :production do
-        ssh "deploy@localhost:#{ssh_port}"
-        path "testproject"
-        ssh_key "#{ssh_key_path}"
-        ping false
-      end
-    RUBY
-  end
-
-  after(:each) do
-    # Clean up bard config
-    FileUtils.rm_f(@bard_config_path) if @bard_config_path
-
-    # TestContainers will automatically stop and remove the container
-    container.stop if container
-    container.remove if container
-  end
-
-  it "runs ls command via bard run" do
-    # Create a test file in the container
-    result = system("ssh -o StrictHostKeyChecking=no -p #{ssh_port} deploy@localhost -i spec/acceptance/docker/test_key 'touch testproject/test-file.txt'")
-    expect(result).to be true
-
-    # Run bard command
-    Dir.chdir("tmp") do
-      # Copy config to bard.rb
-      FileUtils.cp("../#{@bard_config_path}", "bard.rb")
-
-      output, status = Open3.capture2e("bard run ls")
-
-      # Clean up
-      FileUtils.rm_f("bard.rb")
-
-      # Verify the command succeeded
-      expect(status).to be_success, "bard run failed with output: #{output}"
-      expect(output).to include("test-file.txt")
-    end
-  end
-
-  it "runs multiple commands in isolated containers" do
-    # Each test gets its own container automatically!
-    result = system("ssh -o StrictHostKeyChecking=no -p #{ssh_port} deploy@localhost -i spec/acceptance/docker/test_key 'echo content > testproject/another-file.txt'")
-    expect(result).to be true
-
-    Dir.chdir("tmp") do
-      FileUtils.cp("../#{@bard_config_path}", "bard.rb")
-      output, status = Open3.capture2e("bard run 'cat another-file.txt'")
-      FileUtils.rm_f("bard.rb")
-
-      expect(status).to be_success, "bard run failed with output: #{output}"
-      expect(output).to include("content")
-    end
-  end
-end