Testing

Table of contents

Using test helpers inside your application

Testing an embedded app outside the Shopify admin

Using test helpers inside your application

A test helper that will allow you to test ShopifyApp::WebhookVerification in the controller from your app, to use this test, you need to require it directly inside your app test/controllers/webhook_verification_test.rb.

require 'test_helper'
require 'action_controller'
require 'action_controller/base'
require 'shopify_app/test_helpers/webhook_verification_helper'

A test helper that allows you to stub out a shopify_app session in controllers that include ShopifyApp::LoginProtection, to use this helper, you need to require it directly.

Example Usage:

require 'shopify_app/test_helpers/shopify_session_helper'

class MyAuthenticatedControllerTest < ActionController::TestCase
  include ShopifyApp::TestHelpers::ShopifySessionHelper

  test "does not redirect when there is a valid shopify session" do
    # note shop_domain should be the same as your shopify domain
    shop_domain = "my-shop.myshopify.com"
    setup_shopify_session(session_id: "1", shop_domain: shop_domain)

    get :index

    assert_response :ok
  end
end

Or you can require all shopify_app test helpers in your test/test_helper.rb.

ENV['RAILS_ENV'] ||= 'test'
require_relative '../config/environment'
require 'rails/test_help'
require 'byebug'
require 'shopify_app/test_helpers/all'

With lib/shopify_app/test_helpers/all' more tests can be added and will only need to be required in once in your library.

Testing an embedded app outside the Shopify admin

By default, loading your embedded app will redirect to the Shopify admin, with the app view loaded in an iframe. If you need to load your app outside of the Shopify admin (e.g., for performance testing), you can change forceRedirect: true to false in ShopifyApp.init block in the embedded_app view. To keep the redirect on in production but off in your development and test environments, you can use:

forceRedirect: <%= Rails.env.development? || Rails.env.test? ? 'false' : 'true' %>