hephaestus 0.8.11 → 0.8.12.1

data/templates/test/controllers/settings_controller_test.rb.tt

@@ -0,0 +1,125 @@
+# typed: false
+# frozen_string_literal: true
+
+require "test_helper"
+
+class SettingsControllerTest < ActionDispatch::IntegrationTest
+  include Hephaestus::API::TestHelpers
+
+  include Hephaestus::Webmocks::SlackWebmock
+  include Hephaestus::Webmocks::YettoWebmock
+  include Webmocks::<%= capital_plug_name %>Webmock
+
+  def setup
+    super
+    @valid_<%= plug_name %>_installations = JSON.parse(file_fixture_path("plug_installation_settings", "valid.json").read).deep_symbolize_keys
+    @response = create_installation
+  end
+
+  test "GET /settings without asking for JSON fails" do
+    api(:get, "/settings", headers: nil)
+
+    assert_response :not_acceptable
+  end
+
+  test "GET /settings asking for JSON without number works" do
+    settings_json = api(:get, "/settings")
+
+    assert_response :ok
+
+    settings = settings_json["settings"]
+
+    assert_equal "2023-03-06", settings_json["version"]
+    assert_equal 1, settings.length
+    assert settings.key?("step")
+  end
+
+  test "GET /settings asking for JSON with number works" do
+    settings_json = api(:get, "/settings?step=2")
+
+    assert_response :ok
+
+    settings = settings_json["settings"]
+
+    assert_equal "2023-03-06", settings_json["version"]
+    assert_equal 1, settings.length
+    assert settings.key?("step")
+  end
+
+  test "GET /edit does not panic if Yetto is unavailable" do
+    stub_post_access_token(@plug_installation_id)
+    stub_get_plug_installation(@plug_installation_id, status: 500)
+
+    stub_send_to_slack_log
+    api(:get, "/settings/org_id/inbox_id/#{@plug_installation_id}/edit")
+
+    assert_response :not_acceptable
+
+    assert_requested_send_to_slack_log
+    assert_requested_post_access_token(@plug_installation_id)
+  end
+
+  test "GET /edit does not panic if Yetto provides bad token data" do
+    stub_post_access_token(@plug_installation_id)
+
+    response = {
+      credentials: {},
+    }
+
+    stub_get_plug_installation(@plug_installation_id, response:)
+
+    stub_send_to_slack_log
+    api(:get, "/settings/org_id/inbox_id/#{@plug_installation_id}/edit")
+
+    # error page returned
+    assert_response :bad_request
+
+    assert_requested_send_to_slack_log
+    assert_requested_post_access_token(@plug_installation_id)
+  end
+
+  test "GET /edit works even if step is not provided" do
+    stub_post_access_token(@plug_installation_id)
+    stub_get_plug_installation(@plug_installation_id, response: @response)
+    stub_request_<%= plug_name %>_app_installations
+
+    api(:get, "/settings/org_id/#{@inbox_id}/#{@plug_installation_id}/edit")
+
+    assert_response :ok
+
+    assert_requested_post_access_token(@plug_installation_id)
+    assert_requested_get_plug_installation(@plug_installation_id)
+    assert_requested_<%= plug_name %>_app_installations
+  end
+
+  test "GET /edit works if step is explicitly provided" do
+    stub_post_access_token(@plug_installation_id)
+    stub_get_plug_installation(@plug_installation_id, response: @response)
+    stub_request_<%= plug_name %>_app_installation_repositories
+
+    api(:get, "/settings/org_id/inbox_id/#{@plug_installation_id}/edit?step=2")
+
+    assert_response :ok
+
+    assert_requested_post_access_token(@plug_installation_id)
+    assert_requested_get_plug_installation(@plug_installation_id)
+    assert_requested_<%= plug_name %>_app_installation_repositories
+  end
+
+  test "GET /edit does not panic if <%= capital_plug_name %> is down" do
+    stub_post_access_token(@plug_installation_id)
+    stub_get_plug_installation(@plug_installation_id, response: @response)
+    stub_request_<%= plug_name %>_app_installation_repositories(status: 500)
+    stub_send_to_slack_log
+
+    api(:get, "/settings/org_id/inbox_id/#{@plug_installation_id}/edit?step=2")
+
+    assert_response :not_acceptable
+
+    assert_requested_send_to_slack_log
+    assert_requested_<%= plug_name %>_app_installation_repositories
+    assert_requested_post_access_token(@plug_installation_id)
+  end
+
+  # TODO: Add your own settings tests here
+end

data/templates/test/controllers/yetto_controller_test.rb

@@ -4,55 +4,61 @@
 require "test_helper"
 
 class YettoControllerTest < ActionDispatch::IntegrationTest
-  include API::TestHelpers
+  include Hephaestus::API::TestHelpers
 
-  include Webmocks::YettoWebmock
+  include Hephaestus::Webmocks::YettoWebmock
 
   def setup
     super
     @after_create_plug_installation = {
-      plug_installation: {
-        id: @plug_installation_id,
-        settings: {
-          from_email: "new@from.company",
-          reply_to_email: "new@from.company",
+      yetto: {
+        plug_installation: {
+          id: @plug_installation_id,
+          settings: {},
+        },
+        organization: {
+          id: @organization_id,
+        },
+        plug: {
+          id: @plug_id,
+        },
+        inbox: {
+          id: @inbox_id,
         },
-      },
-      organization: {
-        id: @organization_id,
-      },
-      plug: {
-        id: @plug_id,
-      },
-      inbox: {
-        id: @inbox_id,
       },
     }
 
     @after_create_message = {
-      plug_installation: {
-        id: @plug_installation_id,
-        settings: {},
-        credentials: {},
-      },
-      message: {
-        id: @message_id,
-        text_content: "blern",
-        html_content: "<p>blern</p>",
-        metadata: {},
-        conversation: {
-          id: @conversation_id,
-          title: "Hey there?",
-          metadata: {
-            "in-reply-to" => "123",
-          },
+      yetto: {
+        plug_installation: {
+          id: @plug_installation_id,
+          settings: {}, # This is where you would put your settings that identify your platform
+          credentials: {},
         },
-      },
-      inbox: {
-        id: @inbox_id,
-        organization: {
-          id: @organization_id,
-          status: "active",
+        message: {
+          id: @message_id,
+          text_content: "blern",
+          html_content: "<p>blern</p>",
+          metadata: {},
+          conversation: {
+            id: @conversation_id,
+            title: "Hey there?",
+            metadata: {
+              "in-reply-to" => "123",
+            },
+            inbox: {
+              id: @inbox_id,
+              organization: {
+                id: @organization_id,
+                status: "active",
+              },
+            },
+          },
+          created_by_membership: {
+            user: {
+              name: "someone",
+            },
+          },
         },
       },
     }
@@ -60,41 +66,12 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
 
   def headers(body)
     {
-      Headers::Yetto::HEADER_EVENT => "created",
-      Headers::Yetto::HEADER_RECORD_TYPE => "plug_installation",
-      Headers::Yetto::HEADER_SIGNATURE => yetto_auth_header(body),
+      Hephaestus::Headers::HEADER_EVENT => "created",
+      Hephaestus::Headers::HEADER_RECORD_TYPE => "plug_installation",
+      Hephaestus::Headers::HEADER_SIGNATURE => yetto_auth_header(body),
     }
   end
 
-  test "it handles null headers" do
-    api(:post, "/plug_installation/created", headers: nil)
-
-    assert_response :bad_request
-  end
-
-  test "it handles missing headers" do
-    api(:post, "/plug_installation/created", headers: {})
-
-    assert_response :bad_request
-  end
-
-  test "it handles incorrect headers" do
-    api(:post, "/plug_installation/created", headers: { "X-Yetto-Signature" => "Basic jabroni:lies" })
-
-    assert_response :bad_request
-
-    api(:post, "/plug_installation/created", headers: { "X-Yetto-Signature" => "sha256=123456" })
-
-    assert_response :bad_request
-  end
-
-  test "it handles missing body" do
-    body = {}
-    api(:post, "/plug_installation/created", headers: headers(body), body: body)
-
-    assert_response :bad_request
-  end
-
   test "it handles wrong event" do
     body = @after_create_plug_installation
     api(:post, "/bloop/plug_installation", headers: headers(body), body: body)
@@ -105,7 +82,7 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
   test "it handles wrong record type" do
     body = @after_create_plug_installation
 
-    api(:post, "/after_create/plug_instunk", headers: headers(body), body: body)
+    api(:post, "/plug_instunk/created", headers: headers(body), body: body)
 
     assert_response :not_found
   end
@@ -126,4 +103,56 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
 
     assert_response :bad_request
   end
+
+  test "it performs some job to do something to your platform" do
+    incoming_body = @after_create_message
+
+    job_args = {
+      create_issue_data: {
+        gh_installation_id: @after_create_message[:yetto][:plug_installation][:settings][:github_installations],
+        gh_repo_id: @after_create_message[:yetto][:plug_installation][:settings][:github_repositories].to_i,
+        title: @after_create_message[:yetto][:message][:conversation][:title],
+        body: @after_create_message[:yetto][:message][:text_content],
+      },
+      message: {
+        id: @message_id,
+        author: {
+          name: "someone",
+        },
+        metadata: {},
+      },
+      conversation: {
+        id: @conversation_id,
+      },
+      plug_installation: {
+        id: @plug_installation_id,
+      },
+      inbox: {
+        id: @inbox_id,
+      },
+    }
+
+    assert_enqueued_with(job: "SomeJob", args: assert_expected_args(job_args)) do
+      api(:post, "/message/created", body: incoming_body, headers: headers(incoming_body))
+
+      assert_response :no_content
+    end
+  end
+
+  # You should also add jobs for when your installation is created, updated, or destroy, similar to
+  # the below EXAMPLE showing how to test the job that is enqueued when a plug installation is updated.
+  # test "it performs UpdateYettoJob after the installation is updated" do
+  #   incoming_body = @after_update_plug_installation
+
+  #   job_args = {
+  #     gh_installation_id: incoming_body[:yetto][:plug_installation][:settings][:github_installations],
+  #     gh_repo_id: incoming_body[:yetto][:plug_installation][:settings][:github_repositories].to_i,
+  #   }
+
+  #   assert_enqueued_with(job: CreateLabelJob, args: assert_expected_args(job_args)) do
+  #     api(:post, "/plug_installation/updated", body: incoming_body, headers: headers(incoming_body))
+
+  #     assert_response :no_content
+  #   end
+  # end
 end

data/templates/test/fixtures/files/plug_installation_settings/valid.json

@@ -1,3 +1,3 @@
 {
-    "github_installations": "gh_installation_id"
+    "app_id": "123"
 }

data/templates/test/support/rails.rb

@@ -1,40 +1,20 @@
 # typed: false
 # frozen_string_literal: true
 
-ENV["RAILS_ENV"] ||= "test"
-require_relative "../../config/environment"
-
-module ActiveSupport
-  class TestCase
-    extend T::Sig
-
-    # Run tests in parallel with specified workers
-    parallelize(workers: :number_of_processors)
-
-    def setup
-      @organization_id ||= "org_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-      @plug_installation_id ||= "pli_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-      @inbox_id ||= "ibx_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-      @plug_id ||= "plg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-      @message_id ||= "msg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-      @conversation_id ||= "cnv_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
-    end
-
-    def file_fixture_path(dir, name)
-      Rails.root.join("test", "fixtures", "files", dir, name)
-    end
-
-    def assert_expected_args(expected_args)
-      lambda do |job_args_arr|
-        job_args_arr.first.each do |actual_args|
-          actual_key = actual_args.first
-          actual_value = actual_args.second
-
-          expected_value = expected_args[actual_key]
-
-          assert_equal(expected_value, actual_value, "Expected `#{actual_key}` to be `#{expected_value.nil? ? "nil" : expected_value}`, but was `#{actual_value.nil? ? "nil" : actual_value}`")
-        end
-      end
-    end
-  end
+def create_installation(valid: true, expires_at: 8.hours.from_now)
+  {
+    installed_on_inbox: {
+      id: @inbox_id,
+      organization: {
+        id: @organization_id,
+        status: "active",
+      },
+    },
+    plug: {
+      id: @plug_id,
+    },
+    # TODO: fill these out!
+    settings: {},
+    credentials: {},
+  }
 end

data/templates/test/support/webmocks/app_webmock.rb.tt

@@ -0,0 +1,29 @@
+# typed: false
+# frozen_string_literal: true
+
+module Webmocks
+  module <%= capital_plug_name %>Webmock
+    extend T::Sig
+    extend T::Helpers
+
+    # TODO: Add webmocks here which are specific to your application
+    # For example, if your application interacts with GitHub, you can add webmocks for GitHub here
+    #
+    # sig { params(state: String).returns(T.untyped) }
+    # def assert_requested_user_access_token(state)
+    #   assert_requested(:post, "https://github.com/login/oauth/access_token?#{token_query_params(state)}")
+    # end
+
+    # sig { params(state: String, valid: T::Boolean, status: Integer).returns(T.untyped) }
+    # def stub_request_user_access_token(state, valid: true, status: 200)
+    #   response_body = JSON.parse(file_fixture_path("gh_access_token", valid ? "valid.json" : "invalid.json").read).deep_symbolize_keys
+    #   stub_request(:post, "https://github.com/login/oauth/access_token?#{token_query_params(state)}")
+    #     .to_return(
+    #       status: status,
+    #       headers: { content_type: "application/json; charset=utf-8" },
+    #       body: response_body.to_json,
+    #     )
+    # end
+
+  end
+end

data/templates/test/test_helper.rb

@@ -1,37 +1,7 @@
 # typed: false
 # frozen_string_literal: true
 
-require "debug" if ENV.fetch("DEBUG", false)
+require "hephaestus/test_helper"
 
-if ENV["COVERAGE"] == "1"
-  require "simplecov"
-  require "simplecov-console"
-
-  SimpleCov.start("rails")
-
-  # do not crash on failure; we want a distinct job to report the coverage error
-  module SimpleCov
-    class << self
-      def result_exit_status(_)
-        SimpleCov::ExitCodes::SUCCESS
-      end
-    end
-  end
-end
-
-require "httpx"
-require "webmock/minitest"
-require "httpx/adapters/webmock"
-WebMock.enable!
-WebMock.disable_net_connect!(allow_localhost: true)
-
-require_relative "support/rails"
-
-require "minitest/pride"
-
-require "webmock/minitest"
 # Load everything else from test/support
 Dir[File.expand_path("support/**/*.rb", __dir__)].each { |rb| require(rb) }
-
-# https://github.com/freerange/mocha#rails
-require "mocha/minitest"

data/templates/vendor/fly/{fly-production.toml → fly-production.toml.tt}

@@ -2,16 +2,12 @@
 # See https://fly.io/docs/reference/configuration/ for information about how to use this file.
 #
 
-app = "plug-app-production"
+app = "plug-<%= plug_name %>-production"
 primary_region = "iad"
 
-[env]
-RAILS_ENV = "production"
-LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
-
 [processes]
-web = "./bin/rails server"
-worker = "bundle exec sidekiq"
+web = "/app/bin/rails server"
+supervisor = "/app/bin/jobs"
 
 [[vm]]
 cpu_kind = "performance"
@@ -23,7 +19,17 @@ processes = ["web"]
 cpu_kind = "performance"
 cpus = 1
 memory = "2gb"
-processes = ["worker"]
+processes = ["supervisor"]
+
+[[restart]]
+policy = "always"
+retries = 5
+processes = ["supervisor"]
+
+[[restart]]
+policy = "on-failure"
+retries = 5
+processes = ["web"]
 
 [http_service]
 internal_port = 3000
@@ -39,13 +45,20 @@ hard_limit = 250
 
 [checks]
 [checks.alive]
-type = "tcp"
-interval = "15s"
+type = "http"
+interval = "10s"
 timeout = "2s"
 grace_period = "5s"
+method = "GET"
+path = "/up"
+protocol = "http"
+tls_skip_verify = false
+processes = ["web"]
+[checks.alive.headers]
+X-Forwarded-Proto = "https"
 
 [[statics]]
-guest_path = "/plug-app/public"
+guest_path = "/plug-<%= plug_name %>/public"
 url_prefix = "/"
 
 [deploy]

data/templates/vendor/fly/{fly-staging.toml → fly-staging.toml.tt}

@@ -1,13 +1,13 @@
-app = "plug-app-staging"
-primary_region = "iad"
+#
+# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
+#
 
-[env]
-RAILS_ENV = "staging"
-LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
+app = "plug-<%= plug_name %>-staging"
+primary_region = "iad"
 
 [processes]
-web = "./bin/rails server"
-worker = "bundle exec sidekiq"
+web = "/app/bin/rails server"
+supervisor = "/app/bin/jobs"
 
 [[vm]]
 cpu_kind = "shared"
@@ -19,7 +19,11 @@ processes = ["web"]
 cpu_kind = "shared"
 cpus = 2
 memory = "1gb"
-processes = ["worker"]
+processes = ["supervisor"]
+
+[[restart]]
+policy = "on-failure"
+retries = 5
 
 [http_service]
 internal_port = 3000
@@ -33,15 +37,14 @@ type = "requests"
 soft_limit = 200
 hard_limit = 250
 
-[checks]
-[checks.alive]
-type = "tcp"
-interval = "15s"
-timeout = "2s"
-grace_period = "5s"
+[[services]]
+auto_stop_machines = "stop"
+auto_start_machines = true
+min_machines_running = 0
+processes = ["supervisor"]
 
 [[statics]]
-guest_path = "/plug-app/public"
+guest_path = "/plug-<%= plug_name %>/public"
 url_prefix = "/"
 
 [deploy]