geb 0.1.11

data/test/command tests/test_geb_init.rb

@@ -0,0 +1,312 @@
+# frozen_string_literal: true
+#
+# Tests the init command class
+#
+# @title Geb - Test - Init Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+require "test_helper"
+require "fileutils"
+require "tmpdir"
+require 'webmock/minitest'
+
+class TestGebCommandInit < Geb::CliTest
+
+  test "that the CLI api call works" do
+
+    # initialize new command instance
+    command = Geb::CLI::Commands::Init.new
+
+    site_path = "path/to/site"
+    command_options = { template: "default", skip_template: false, skip_git: false, force: false }
+
+    site_mock = mock('site')
+    site_mock.expects(:validate)
+    site_mock.expects(:create)
+
+    Geb::Site.expects(:new).returns(site_mock)
+    Geb::Git.expects(:validate_git_repo)
+    Geb::Git.expects(:create_git_repo)
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    command.call(site_path: site_path, **command_options)
+
+    assert_empty $stderr.string
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works"
+
+  test "that the CLI api call works and handles exceptions" do
+
+    # initialize new command instance
+    command = Geb::CLI::Commands::Init.new
+
+    site_path = "path/to/site"
+    command_options = { template: "default", skip_template: false, skip_git: false, force: false }
+
+    site_mock = mock('site')
+    site_mock.expects(:validate).raises(Geb::Error.new("Test Error"))
+    site_mock.stubs(:create)
+
+    Geb::Site.stubs(:new).returns(site_mock)
+    Geb::Git.stubs(:validate_git_repo)
+    Geb::Git.stubs(:create_git_repo)
+
+    # setup a StringIO to capture standard output and error
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    command.call(site_path: site_path, **command_options)
+
+    refute_empty $stderr.string
+    assert_includes $stderr.string, "Test Error"
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works and handles exceptions"
+
+  test "that command default executes" do
+
+    new_site_path = "new_site"
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path}")
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "No template specified, using default: #{Geb::Defaults::DEFAULT_TEMPLATE}."
+    assert_includes stdout, "Validating template path #{Geb::Defaults::DEFAULT_TEMPLATE_DIR} ... done."
+    assert_includes stdout, "Validating proposed site path as a git repository ... done."
+    refute_includes stdout, "Skipping git repository validation as told."
+
+    assert_includes stdout, "Creating site folder: #{new_site_path} ... done."
+    assert File.directory?(new_site_path)
+
+    assert_includes stdout, "Loading template site from path #{Geb::Defaults::DEFAULT_TEMPLATE_DIR} ... done."
+    assert_includes stdout, "Resolving directories and files from template site to copy ... done."
+    assert_includes stdout, "copying directory and all sub-directories from #{Geb::Defaults::DEFAULT_TEMPLATE_DIR}"
+    assert_includes stdout, "copying directory and all sub-directories from"
+    assert_includes stdout, "Creating: local and release output folders ...done."
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::LOCAL_OUTPUT_DIR))
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR))
+
+    assert_includes stdout, "Initialising git repository ... done."
+    refute_includes stdout, "Skipping git repository creation as told."
+    assert File.directory?(File.join(new_site_path, ".git"))
+    assert File.exist?(File.join(new_site_path, ".gitignore"))
+
+  end # test "that command default executes"
+
+  test "that new site can ignore git creation" do
+
+    new_site_path = "new_site"
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --skip-git")
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "No template specified, using default: #{Geb::Defaults::DEFAULT_TEMPLATE}."
+    assert_match(/Validating template path.*#{Geb::Defaults::DEFAULT_TEMPLATE}.*\.\.\. done\./, stdout)
+    assert_includes stdout, "Skipping git repository validation as told."
+
+    assert_includes stdout, "Creating site folder: #{new_site_path} ... done."
+    assert File.directory?(new_site_path)
+
+
+    assert_includes stdout, "Loading template site from path #{Geb::Defaults::DEFAULT_TEMPLATE_DIR} ... done."
+    assert_includes stdout, "Resolving directories and files from template site to copy ... done."
+    assert_includes stdout, "copying directory and all sub-directories from #{Geb::Defaults::DEFAULT_TEMPLATE_DIR}"
+    assert_includes stdout, "copying directory and all sub-directories from"
+    assert_includes stdout, "Creating: local and release output folders ...done."
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::LOCAL_OUTPUT_DIR))
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR))
+
+    refute_includes stdout, "Initialising git repository ... done."
+    assert_includes stdout, "Skipping git repository creation as told."
+
+    refute File.directory?(File.join(new_site_path, ".git"))
+    refute File.exist?(File.join(new_site_path, ".gitignore"))
+
+  end # test "that new site can ignore git creation"
+
+  test "that new site can ignore template creation" do
+
+    new_site_path = "new_site"
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --skip-template")
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "Skipping template validation as told."
+    assert_includes stdout, "Validating proposed site path as a git repository ... done."
+    refute_includes stdout, "Skipping git repository validation as told."
+
+    assert_includes stdout, "Creating site folder: #{new_site_path} ... done."
+    assert File.directory?(new_site_path)
+
+    assert_includes stdout, "Skipping template creation as told."
+    assert_includes stdout, "Creating: local and release output folders ...done."
+
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::LOCAL_OUTPUT_DIR))
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR))
+
+    assert_includes stdout, "Initialising git repository ... done."
+    refute_includes stdout, "Skipping git repository creation as told."
+    assert File.directory?(File.join(new_site_path, ".git"))
+    assert File.exist?(File.join(new_site_path, ".gitignore"))
+
+  end # test "that new site can ignore template creation"
+
+  test "that new site can handle specified geb sample template" do
+
+    new_site_path = "new_site"
+    template = "bootstrap_jquery"
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --template #{template}")
+
+    assert status.success?
+    assert_empty stderr
+
+    template_full_path = File.join(Geb::Defaults::BUNDLED_TEMPLATES_DIR, template)
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "Specified template is a Geb sample: #{template}, using it as site template."
+    assert_includes stdout, "Validating template path #{template_full_path} ... done."
+    assert_includes stdout, "Validating proposed site path as a git repository ... done."
+    refute_includes stdout, "Skipping git repository validation as told."
+
+    assert_includes stdout, "Creating site folder: #{new_site_path} ... done."
+    assert File.directory?(new_site_path)
+
+    assert_includes stdout, "Loading template site from path #{template_full_path} ... done."
+    assert_includes stdout, "Resolving directories and files from template site to copy ... done."
+    assert_includes stdout, "copying directory and all sub-directories from #{template_full_path}"
+    assert_includes stdout, "copying directory and all sub-directories from"
+    assert_includes stdout, "Creating: local and release output folders ...done."
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::LOCAL_OUTPUT_DIR))
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR))
+
+    assert_includes stdout, "Initialising git repository ... done."
+    refute_includes stdout, "Skipping git repository creation as told."
+    assert File.directory?(File.join(new_site_path, ".git"))
+    assert File.exist?(File.join(new_site_path, ".gitignore"))
+
+  end # test "that new site can handle specified geb sample template"
+
+  test "that invalid specified template is handled correctly" do
+
+    new_site_path = "new_site"
+    template = "invalid_template_just_to_make_sure_3_for_sure"
+
+    _, stderr, status = Open3.capture3("geb init #{new_site_path} --template #{template}")
+
+    assert status.success?
+    assert_includes stderr, "Invalid template site. Make sure the specified path is a directory and contains a valid geb.config.yml file."
+    refute File.directory?(new_site_path)
+
+  end # test "that invalid specified template is handled correctly"
+
+  test "that template url is used correctly" do
+
+    http_proxy = start_proxy
+
+    new_site_path = "new_site"
+    template_url = "#{http_proxy.base_url}/geb-template.tar.gz"
+
+    http_proxy.stub_request(template_url, { 'Content-Type' => 'application/x-gzip' }) do
+      File.read(File.join(File.dirname(__FILE__), "../files", "geb-template.tar.gz"))
+    end
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --template #{template_url}")
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "Validating template URL #{template_url} ... done."
+    assert_includes stdout, "Found a gzip archive at template url #{template_url}."
+    assert_includes stdout, "Downloading template from URL #{template_url} ... done."
+
+    assert_includes stdout, "Validating proposed site path as a git repository ... done."
+    refute_includes stdout, "Skipping git repository validation as told."
+
+    assert_includes stdout, "Creating site folder: #{new_site_path} ... done."
+    assert File.directory?(new_site_path)
+
+    assert_match(/Loading template site from path .*\.\.\. done\./, stdout)
+    assert_includes stdout, "Creating: local and release output folders ...done."
+    assert_includes stdout, "Resolving directories and files from template site to copy ... done."
+    assert_match(/copying directory and all sub-directories from .*\.\.\. done\./, stdout)
+    assert_match(/copying file from .*\.\.\. done\./, stdout)
+
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::LOCAL_OUTPUT_DIR))
+    assert File.directory?(File.join(new_site_path, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR))
+
+    assert_includes stdout, "Initialising git repository ... done."
+    refute_includes stdout, "Skipping git repository creation as told."
+
+    assert File.directory?(File.join(new_site_path, ".git"))
+    assert File.exist?(File.join(new_site_path, ".gitignore"))
+
+  end # test "that template url is used correctly"
+
+  test "that invalid template url is handled correctly" do
+
+    new_site_path = "new_site"
+    template_url = "http://www.examplexyz7y.com/geb-template.tar.gz"
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --template #{template_url}")
+
+    assert status.success?
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+    assert_includes stdout, "Validating template URL #{template_url}"
+    assert_includes stderr, "HTTP error"
+
+    refute File.directory?(new_site_path)
+
+  end # test "that invalid template url is handled correctly"
+
+  test "that template url not being an archive is handled correctly" do
+
+    http_proxy = start_proxy
+
+    new_site_path = "new_site"
+    template_url = "#{http_proxy.base_url}/geb-template.tar.gz"
+
+    http_proxy.stub_request(template_url, { 'Content-Type' => 'text/plain' }, "This is not a tar.gz file")
+
+    stdout, stderr, status = Open3.capture3("geb init #{new_site_path} --template #{template_url}")
+
+    assert status.success?
+
+    assert_includes stdout, "Validating site path #{new_site_path} ... done."
+
+    assert_includes stdout, "Validating template URL #{template_url} ... done."
+    assert_includes stderr, "Specified template is not a gzip archive"
+
+    refute File.directory?(new_site_path)
+
+  end # test "that template url not being an archive is handled correctly"
+
+end # class TestGebCommandInit < Minitest::Test

data/test/command tests/test_geb_release.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+#
+# Tests the release command class
+#
+# @title Geb - Test - Release Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+require "test_helper"
+
+class TestGebCommandRelease < Geb::CliTest
+
+  test "that the CLI api call works" do
+
+    copy_test_site()
+
+    command = Geb::CLI::Commands::Release.new
+
+    command_options = { with_template: false }
+
+    site_mock = mock('site')
+    site_mock.expects(:load).with(Dir.pwd)
+    site_mock.expects(:release)
+
+    Geb::Site.expects(:new).returns(site_mock)
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    command.call(**command_options)
+
+    assert_empty $stderr.string
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works"
+
+  test "that the CLI api call works and handles exceptions" do
+
+    # initialize new command instance
+    command = Geb::CLI::Commands::Release.new
+
+    command_options = { with_template: false }
+
+    Geb::Site.expects(:new).raises(Geb::Error.new("Test Error"))
+
+    # setup a StringIO to capture standard output and error
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    command.call(**command_options)
+
+    refute_empty $stderr.string
+    assert_includes $stderr.string, "Test Error"
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works and handles exceptions"
+
+  test "that command default executes" do
+
+    copy_test_site()
+
+    # call geb auto command and capture output and error
+    _, stderr, status = Open3.capture3('geb release')
+
+    # assert that the output contains the expected string
+    assert status.success?
+    assert_empty stderr
+
+  end # test "command line"
+
+  test "that command handles being executed in a non-site directory" do
+
+    # create a temporary directory
+    Dir.mktmpdir do |dir|
+
+      # change the current directory to the temporary directory
+      Dir.chdir(dir)
+
+      # call geb auto command and capture output and error
+      _, stderr, status = Open3.capture3('geb release')
+
+      # assert that the output contains the expected string
+      assert status.success?
+      refute_empty stderr
+
+    end # Dir.mktmpdir
+
+  end # test "that command handles being executed in a non-site directory"
+
+  test "that the command actually builds and releases the site" do
+
+    copy_test_site()
+
+    stdout, stderr, status = Open3.capture3('geb release')
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Loading site from path #{Dir.pwd} ... done."
+    assert_includes stdout, "Found geb site at path #{Dir.pwd}"
+    assert_match(/Building \d* pages for/, stdout)
+    assert_includes stdout, "loading page"
+    assert_includes stdout, "loading template"
+    assert_includes stdout, "loading partial"
+    assert_includes stdout, "building page"
+    assert_match(/Done building \d* pages for/, stdout)
+    assert_includes stdout, "Clearing site output folder"
+    assert_match(/Outputting site to.*done/, stdout)
+    assert_includes stdout, "Building assets for"
+    assert_includes stdout, "Done building assets for"
+    assert_match(/Clearing site release folder.*done/, stdout)
+    assert_match(/Releasing site to.*done/, stdout)
+    refute_match(/Resolving directories and files to include in the template archive.*done/, stdout)
+    refute_match(/Creating template archive in.*done/, stdout)
+
+  end # test "that the command actually builds the site"
+
+  test "that the command actually builds and releases the site with a template" do
+
+    copy_test_site()
+
+    output_archive_filename = File.join(Dir.pwd, Geb::Defaults::OUTPUT_DIR, Geb::Defaults::RELEASE_OUTPUT_DIR, Geb::Defaults::TEMPLATE_ARCHIVE_FILENAME)
+
+    stdout, stderr, status = Open3.capture3('geb release --with_template')
+
+    assert status.success?
+    assert_empty stderr
+
+    assert_includes stdout, "Loading site from path #{Dir.pwd} ... done."
+    assert_includes stdout, "Found geb site at path #{Dir.pwd}"
+    assert_match(/Building \d* pages for/, stdout)
+    assert_includes stdout, "loading page"
+    assert_includes stdout, "loading template"
+    assert_includes stdout, "loading partial"
+    assert_includes stdout, "building page"
+    assert_match(/Done building \d* pages for/, stdout)
+    assert_includes stdout, "Clearing site output folder"
+    assert_match(/Outputting site to.*done/, stdout)
+    assert_includes stdout, "Building assets for"
+    assert_includes stdout, "Done building assets for"
+    assert_match(/Clearing site release folder.*done/, stdout)
+    assert_match(/Releasing site to.*done/, stdout)
+    assert_match(/Resolving directories and files to include in the template archive.*done/, stdout)
+    assert_match(/copying directory and all sub-directories from.*to.*done/, stdout)
+    assert_match(/copying file from.*to.*done/, stdout)
+    assert_includes stdout, "Done copying directories and files to the template archive directory."
+    assert_match(/Creating template archive in.*done/, stdout)
+
+    assert File.exist?(output_archive_filename)
+
+  end # test "that the command actually builds the site with a template"
+
+end # class TestGebCommandRelease < Minitest::Test

data/test/command tests/test_geb_remote.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+#
+# Tests the remote command class
+#
+# @title Geb - Test - Remote Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+require "test_helper"
+
+class TestGebCommandRemote < Geb::CliTest
+
+  test "that the CLI api call works" do
+
+    copy_test_site()
+
+    command = Geb::CLI::Commands::Remote.new
+
+    command_options = { }
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    Open3.expects(:capture3).with("ssh", "user@server.com").returns(["", "", ""])
+
+    command.call(**command_options)
+
+    assert_empty $stderr.string
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works"
+
+  test "that the CLI api call works with an error" do
+
+    copy_test_site()
+
+    command = Geb::CLI::Commands::Remote.new
+
+    command_options = { }
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    Geb::Site.expects(:new).raises(Geb::Error.new("Site not loaded"))
+
+    command.call(**command_options)
+
+    assert_match(/Site not loaded/, $stderr.string)
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works with an error"
+
+end # class TestGebCommandRemote < Minitest::Test

data/test/command tests/test_geb_server.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+#
+# Tests the server command class
+#
+# @title Geb - Test - Server Command
+# @author Edin Mustajbegovic <edin@actiontwelve.com>
+# @copyright 2024 Edin Mustajbegovic
+# @license MIT
+#
+# @see https://github.com/mainfram-work/geb for more information
+
+require "test_helper"
+
+class TestGebCommandServer < Geb::CliTest
+
+  test "that the CLI api call works" do
+
+    copy_test_site()
+
+    command = Geb::CLI::Commands::Server.new
+    server_port  = Geb::Test::WebServerProxy.find_available_port()
+
+    command_options = { port: server_port, skip_build: false, skip_auto_build: false }
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    server_thread = Thread.new do
+      command.call(**command_options)
+    end
+
+    sleep 2
+
+    command.force_shutdown()
+    server_thread.join
+
+    assert_includes($stdout.string, "Loading site from path #{Dir.pwd}")
+    assert_includes($stdout.string, "Server running on http://localhost:#{@port}")
+    assert_includes($stdout.string, "Watching for changes in [#{Dir.pwd}]")
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works"
+
+  test "that the CLI api call works when an error is thrown" do
+
+    # copy_test_site() # no site, so it should fail
+
+    command = Geb::CLI::Commands::Server.new
+    server_port  = Geb::Test::WebServerProxy.find_available_port()
+
+    command_options = { port: server_port, skip_build: false, skip_auto_build: false }
+
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    server_thread = Thread.new do
+      command.call(**command_options)
+    end
+
+    sleep 2
+
+    command.force_shutdown()
+    server_thread.join
+
+    refute_empty $stderr.string
+    assert_includes($stdout.string, "Loading site from path #{Dir.pwd}")
+    refute_includes($stdout.string, "Server running on http://localhost:#{@port}")
+    refute_includes($stdout.string, "Watching for changes in [#{Dir.pwd}]")
+
+    $stdout = original_stdout
+    $stderr = original_stderr
+
+  end # test "that the CLI api call works when an error is thrown"
+
+  test "that command default executes" do
+
+    copy_test_site()
+    server_port  = Geb::Test::WebServerProxy.find_available_port()
+    geb_command = "geb server --port #{server_port}"
+
+    server_up = lambda do |output, error_output|
+      output.include?("Server running on http://localhost:#{server_port}")
+    end
+
+    run_command_with_timeout(geb_command, break_condition: server_up) do |output, error_output|
+
+      assert_includes output, "Loading site from path #{Dir.pwd}"
+      assert_includes output, "Server running on http://localhost:#{server_port}"
+      assert_includes output, "Watching for changes in [#{Dir.pwd}]"
+
+    end # run_command_with_timeout
+
+  end # test "that command default executes"
+
+  test "that command handles being executed in a non-site directory" do
+
+    # create a temporary directory
+    Dir.mktmpdir do |dir|
+
+      # change the current directory to the temporary directory
+      Dir.chdir(dir)
+
+      # call geb auto command and capture output and error
+      _, stderr, status = Open3.capture3('geb server')
+
+      # assert that the output contains the expected string
+      assert status.success?
+      assert_includes stderr, "is not and is not in a geb site. Could not find geb config file."
+
+    end # Dir.mktmpdir
+
+  end # test "that command handles being executed in a non-site directory"
+
+end # class TestGebCommandServer < Minitest::Test