Starting move back to running e2e specs right in Crystal

Author: jwoertink

spec/end_to_end/api_no_auth_spec.cr

@@ -0,0 +1,22 @@
+require "../spec_helper"
+
+include WithProjectCleanup
+include ShouldRunSuccessfully
+
+describe "Lucky CLI", tags: "end_to_end" do
+  describe "building an API app without authentication" do
+    it "generates the app and runs the included specs" do
+      with_project_cleanup do
+        should_run_successfully "crystal run src/lucky.cr -- init.custom test-project --api --no-auth"
+
+        FileUtils.cd "test-project" do
+          should_run_successfully "crystal tool format --check spec src config"
+          should_run_successfully "crystal script/setup.cr"
+          should_run_successfully "crystal build src/test_project.cr"
+          should_run_successfully "crystal spec"
+          should_run_successfully "crystal run ../src/lucky.cr -- tasks"
+        end
+      end
+    end
+  end
+end

spec/end_to_end/api_with_auth_spec.cr

@@ -0,0 +1,22 @@
+require "../spec_helper"
+
+include WithProjectCleanup
+include ShouldRunSuccessfully
+
+describe "Lucky CLI", tags: "end_to_end" do
+  describe "building an API app with authentication included" do
+    it "generates the app and runs the included specs" do
+      with_project_cleanup do
+        should_run_successfully "crystal run src/lucky.cr -- init.custom test-project --api"
+
+        FileUtils.cd "test-project" do
+          should_run_successfully "crystal tool format --check spec src config"
+          should_run_successfully "crystal script/setup.cr"
+          should_run_successfully "crystal build src/test_project.cr"
+          should_run_successfully "crystal spec"
+          should_run_successfully "crystal run ../src/lucky.cr -- tasks"
+        end
+      end
+    end
+  end
+end

spec/end_to_end/browser_no_auth_spec.cr

@@ -0,0 +1,22 @@
+require "../spec_helper"
+
+include WithProjectCleanup
+include ShouldRunSuccessfully
+
+describe "Lucky CLI", tags: "end_to_end" do
+  describe "building a full browser app without authentication" do
+    it "generates the app and runs the included specs" do
+      with_project_cleanup do
+        should_run_successfully "crystal run src/lucky.cr -- init.custom test-project --no-auth"
+
+        FileUtils.cd "test-project" do
+          should_run_successfully "crystal tool format --check spec src config"
+          should_run_successfully "crystal script/setup.cr"
+          should_run_successfully "crystal build src/test_project.cr"
+          should_run_successfully "crystal spec"
+          should_run_successfully "crystal run ../src/lucky.cr -- tasks"
+        end
+      end
+    end
+  end
+end

spec/end_to_end/browser_with_auth_spec.cr

@@ -0,0 +1,22 @@
+require "../spec_helper"
+
+include WithProjectCleanup
+include ShouldRunSuccessfully
+
+describe "Lucky CLI", tags: "end_to_end" do
+  describe "building a full browser app with authentication included" do
+    it "generates the app and runs the included specs" do
+      with_project_cleanup do
+        should_run_successfully "crystal run src/lucky.cr -- init.custom test-project"
+
+        FileUtils.cd "test-project" do
+          should_run_successfully "crystal tool format --check spec src config"
+          should_run_successfully "crystal script/setup.cr"
+          should_run_successfully "crystal build src/test_project.cr"
+          should_run_successfully "crystal spec"
+          should_run_successfully "crystal run ../src/lucky.cr -- tasks"
+        end
+      end
+    end
+  end
+end

spec/end_to_end/browser_with_security_spec.cr

@@ -0,0 +1,22 @@
+require "../spec_helper"
+
+include WithProjectCleanup
+include ShouldRunSuccessfully
+
+describe "Lucky CLI", tags: "end_to_end" do
+  describe "building a full browser app with authentication and sec tester included" do
+    it "generates the app and runs the included specs" do
+      with_project_cleanup do
+        should_run_successfully "crystal run src/lucky.cr -- init.custom test-project --with-sec-test"
+
+        FileUtils.cd "test-project" do
+          should_run_successfully "crystal tool format --check spec src config"
+          should_run_successfully "crystal script/setup.cr"
+          should_run_successfully "crystal build src/test_project.cr"
+          should_run_successfully "crystal spec"
+          should_run_successfully "crystal run ../src/lucky.cr -- tasks"
+        end
+      end
+    end
+  end
+end

spec/support/should_run_successfully.cr

@@ -0,0 +1,17 @@
+module ShouldRunSuccessfully
+  private def should_run_successfully(command) : Nil
+    result = Process.run(
+      command,
+      shell: true,
+      env: ENV.to_h,
+      output: STDOUT,
+      error: STDERR
+    )
+
+    result.exit_status.should be_successful
+  end
+
+  private def be_successful
+    eq 0
+  end
+end

spec/support/with_project_cleanup.cr

@@ -0,0 +1,18 @@
+module WithProjectCleanup
+  private def with_project_cleanup(project_directory = "test-project", skip_db_drop = false, &) : Nil
+    yield
+
+    FileUtils.cd(project_directory) {
+      output = IO::Memory.new
+      status = run_lucky(
+        args: %w[db.drop],
+        shell: true,
+        output: output,
+      )
+      status.exit_code.should eq(0)
+      output.to_s.should contain("Done dropping")
+    } unless skip_db_drop
+  ensure
+    FileUtils.rm_rf project_directory
+  end
+end

src/web_app_skeleton/config/server.cr.ecr

@@ -65,4 +65,4 @@ end
 private def raise_missing_secret_key_in_production
   puts "Please set the SECRET_KEY_BASE environment variable. You can generate a secret key with 'lucky gen.secret_key'".colorize.red
   exit(1)
-end
+end

src/web_app_skeleton/src/app.cr.ecr

@@ -38,4 +38,4 @@ require "./components/**"
 require "./pages/**"
 <%- end -%>
 require "../db/migrations/**"
-require "./app_server"
+require "./app_server"