Merge pull request #695 from bugsnag/tms/https-doc-server

Add basic https support

.buildkite/pipeline.yml

@@ -36,13 +36,14 @@ steps:
     key: ios-test-fixture
     agents:
       queue: macos-14
+    env:
+      XCODE_VERSION: "15.4.0"
     command:
       - cd bugsnag-cocoa
-      - bundle install
-      - make test-fixtures
+      - ./features/scripts/export_ios_app.sh Release
     plugins:
       artifacts#v1.9.0:
-        upload: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp.ipa"
+        upload: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp_Release.ipa"
 
   - label: ':docker: Build CI image for Ruby 2'
     timeout_in_minutes: 30
@@ -240,14 +241,14 @@ steps:
     concurrency_group: 'browserstack-app'
     concurrency_method: eager
 
-  - label: ':browserstack: iOS 15 - W3C'
+  - label: ':browserstack: iOS 16 - W3C'
     timeout_in_minutes: 20
     depends_on:
       - "ios-test-fixture"
       - "push-branch-cli"
     plugins:
       artifacts#v1.9.0:
-        download: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp.ipa"
+        download: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp_Release.ipa"
         upload: "bugsnag-cocoa/maze_output/**/*"
       docker-compose#v4.14.0:
         pull: appium-test-bs
@@ -257,11 +258,11 @@ steps:
           - "./bugsnag-cocoa/features:/app/features"
           - "./bugsnag-cocoa/maze_output:/app/maze_output"
         command:
-          - "--app=features/fixtures/ios/output/iOSTestApp.ipa"
+          - "--app=features/fixtures/ios/output/iOSTestApp_Release.ipa"
           - "--farm=bs"
-          - "--device=IOS_15"
+          - "--device=IOS_16"
           - "--fail-fast"
-          - "features/barebone_tests.feature"
+          - "features/release/barebone_tests.feature"
         image-repository: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner
         cache-from:
           - cli:855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:${BRANCH_NAME}-cli
@@ -308,7 +309,7 @@ steps:
   # BitBar tests
   #
 
-  - label: ':bitbar: Safari 15'
+  - label: ':bitbar: Safari 16'
     depends_on: "push-branch-cli"
     timeout_in_minutes: 10
     plugins:
@@ -322,7 +323,7 @@ steps:
         verbose: true
         command:
           - "--farm=bb"
-          - "--browser=safari_15"
+          - "--browser=safari_16"
           - "--aws-public-ip"
           - "--fail-fast"
           - "--no-tunnel"
@@ -372,7 +373,7 @@ steps:
       - "push-branch-cli"
     plugins:
       artifacts#v1.9.0:
-        download: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp.ipa"
+        download: "bugsnag-cocoa/features/fixtures/ios/output/iOSTestApp_Release.ipa"
         upload: "bugsnag-cocoa/maze_output/**/*"
       docker-compose#v4.14.0:
         pull: appium-test-bb
@@ -383,13 +384,13 @@ steps:
           - "./bugsnag-cocoa/maze_output:/app/maze_output"
         service-ports: true
         command:
-          - "--app=features/fixtures/ios/output/iOSTestApp.ipa"
+          - "--app=features/fixtures/ios/output/iOSTestApp_Release.ipa"
           - "--farm=bb"
           - "--device=IOS_14|IOS_15|IOS_16"
           - "--fail-fast"
           - "--no-tunnel"
           - "--aws-public-ip"
-          - "features/barebone_tests.feature"
+          - "features/release/barebone_tests.feature"
         image-repository: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner
         cache-from:
           - cli:855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:${BRANCH_NAME}-cli

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 9.16.0 - 2024-11-01
+
+## Enhancements
+
+- Add https support for document servers [695](https://github.com/bugsnag/maze-runner/pull/695)
+
 # 9.15.1 - 2024-10-29
 
 ## Fixes

lib/maze.rb

@@ -7,7 +7,7 @@
 # Glues the various parts of MazeRunner together that need to be accessed globally,
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
-  VERSION = '9.15.1'
+  VERSION = '9.16.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

lib/maze/client/selenium/bb_client.rb

@@ -12,6 +12,7 @@ def start_session
           capabilities.merge! browsers[config.browser]
           capabilities.merge! JSON.parse(config.capabilities_option)
           capabilities['bitbar:options']['testTimeout'] = 900
+          capabilities['acceptInsecureCerts'] = true
           config.capabilities = capabilities
 
           if Maze::Client::BitBarClientUtils.use_local_tunnel?

lib/maze/client/selenium/bs_client.rb

@@ -16,6 +16,7 @@ def start_session
             capabilities['browserstack.local'] = 'true'
             capabilities['browserstack.localIdentifier'] = Maze.run_uuid
             capabilities['browserstack.console'] = 'errors'
+            capabilities['acceptInsecureCerts'] = 'true'
 
             # Convert W3S capabilities to JSON-WP
             capabilities['browser'] = browser['browserName']
@@ -29,6 +30,7 @@ def start_session
             config.capabilities = capabilities
           else
             capabilities = {
+              'acceptInsecureCerts' => true,
               'bstack:options' => {
                 'local' => 'true',
                 'localIdentifier' => Maze.run_uuid

lib/maze/configuration.rb

@@ -22,6 +22,9 @@ def initialize
     # Server configuration
     #
 
+    # Whether the mock server should use https
+    attr_accessor :https
+
     # Mock server bind address
     attr_accessor :bind_address
 

lib/maze/driver/browser.rb

@@ -118,7 +118,13 @@ def create_driver(driver_for, selenium_url=nil)
                                                  capabilities: @capabilities
             end
           else
-            driver = ::Selenium::WebDriver.for driver_for
+            if driver_for == :chrome
+              options = Selenium::WebDriver::Options.chrome
+            elsif driver_for == :firefox
+              options = Selenium::WebDriver::Options.firefox
+            end
+            options.accept_insecure_certs = true
+            driver = ::Selenium::WebDriver.for driver_for, options: options
           end
           $logger.info "Selenium driver started in #{(Time.now - time).to_i}s"
           @driver = driver

lib/maze/option.rb

@@ -6,12 +6,13 @@ module Option
     # Document server options
     DS_BIND_ADDRESS = 'document-server-bind-address'
     DS_PORT = 'document-server-port'
-    DS_ROOT = 'document-server-root'
 
     # Server options
+    HTTPS = 'https'
     BIND_ADDRESS = 'bind-address'
     NULL_PORT = 'null-port'
     PORT = 'port'
+    DS_ROOT = 'document-server-root'
 
     # Appium options
     A11Y_LOCATOR = 'a11y-locator'

lib/maze/option/parser.rb

@@ -60,6 +60,11 @@ def parse(args)
             text ''
             text 'Server options:'
 
+            opt Option::HTTPS,
+                'Use HTTPS for the mock server',
+                short: :none,
+                type: :boolean,
+                default: false
             opt Option::BIND_ADDRESS,
                 'Mock server bind address',
                 short: :none,

lib/maze/option/processor.rb

@@ -13,6 +13,7 @@ class << self
         def populate(config, options)
 
           # Server options
+          config.https = options[Maze::Option::HTTPS]
           config.bind_address = options[Maze::Option::BIND_ADDRESS]
           config.port = options[Maze::Option::PORT]
           config.null_port = options[Maze::Option::NULL_PORT]

lib/maze/server.rb

@@ -209,11 +209,20 @@ def start
         loop do
 
           @thread = Thread.new do
+
             options = {
-                Port: Maze.config.port,
-                Logger: $logger,
-                AccessLog: []
+              Port: Maze.config.port,
+              Logger: $logger,
+              AccessLog: []
             }
+            # SSL config if enabled
+            if Maze.config.https
+              cert_name = [
+                %w[CN localhost],
+              ]
+              options[:SSLEnable] = true
+              options[:SSLCertName] = cert_name
+            end
             options[:BindAddress] = Maze.config.bind_address unless Maze.config.bind_address.nil?
             server = WEBrick::HTTPServer.new(options)
 
@@ -243,6 +252,7 @@ def start
             server.mount '/metrics', Servlets::Servlet, :metrics
             server.mount '/reflect', Servlets::ReflectiveServlet
             server.mount '/docs', WEBrick::HTTPServlet::FileHandler, Maze.config.document_server_root unless Maze.config.document_server_root.nil?
+
             server.start
           rescue StandardError => e
             Bugsnag.notify e

test/fixtures/browser/features/handled_errors.feature

@@ -1,6 +1,6 @@
 Feature: Browser smoke tests
 
-Scenario: Receiving responses from URLs
+Scenario: Receiving responses from URLs using an HTTPS server
   When I navigate to the test URL "/test.html"
   Then I wait to receive an error
   And the error payload field "test" equals "browser"

test/fixtures/browser/features/steps/browser_steps.rb

@@ -1,18 +1,10 @@
 require 'socket'
 
-def get_document_server_url
-  if Maze.config.aws_public_ip
-    "http://#{Maze.public_document_server_address}"
-  else
-    "http://#{get_private_hostname}:#{Maze.config.document_server_port}"
-  end
-end
-
 def get_maze_runner_url
   if Maze.config.aws_public_ip
-      "http://#{Maze.public_address}"
+      "https://#{Maze.public_address}"
   else
-    "http://#{get_private_hostname}:#{Maze.config.port}"
+    "https://#{get_private_hostname}:#{Maze.config.port}"
   end
 end
 
@@ -35,8 +27,7 @@ def get_private_hostname
 
 When('I navigate to the test URL {string}') do |test_path|
   maze_address = get_maze_runner_url
-  doc_server = get_document_server_url
-  url = "#{doc_server}#{test_path}?maze_address=#{CGI.escape(maze_address)}"
+  url = "#{maze_address}/docs#{test_path}?maze_address=#{CGI.escape(maze_address)}"
   step("I navigate to the URL \"#{url}\"")
 end
 

test/fixtures/browser/features/support/env.rb

@@ -1,10 +1,9 @@
 require 'yaml'
 
-Maze.hooks.before_all do
-  Maze.config.receive_no_requests_wait = 15
-  Maze.config.enforce_bugsnag_integrity = false
-  Maze.config.document_server_root = 'features/fixtures'
-end
+Maze.config.receive_no_requests_wait = 15
+Maze.config.enforce_bugsnag_integrity = false
+Maze.config.https = true
+Maze.config.document_server_root = 'features/fixtures'
 
 at_exit do
   # Stop the web page server

test/option/parser_test.rb

@@ -31,6 +31,7 @@ def test_default_values
     # Common options
     assert_nil(options[Maze::Option::FARM])
     assert_nil(options[Maze::Option::APP])
+    assert_false(options[Maze::Option::HTTPS])
     assert_false(options[Maze::Option::A11Y_LOCATOR])
     assert_equal('{}', options[Maze::Option::CAPABILITIES])
 
@@ -72,6 +73,7 @@ def test_overwritten_values
       --farm=ARG_FARM
       --app=ARG_APP
       --a11y-locator
+      --https
       --capabilities=ARG_CAPABILITIES
       --bs-local=ARG_BS_LOCAL
       --device=ARG_DEVICE
@@ -98,6 +100,7 @@ def test_overwritten_values
     assert_equal('ARG_FARM', options[Maze::Option::FARM])
     assert_equal('ARG_APP', options[Maze::Option::APP])
     assert_true(options[Maze::Option::A11Y_LOCATOR])
+    assert_true(options[Maze::Option::HTTPS])
     assert_equal('ARG_CAPABILITIES', options[Maze::Option::CAPABILITIES])
 
     # Device-farm-only options

test/option/processor_test.rb

@@ -96,11 +96,12 @@ def test_default_options
     assert_true config.enable_retries
     assert_false config.log_requests
     assert_false config.always_log
+    assert_false config.https
     assert_nil config.bugsnag_repeater_api_key
   end
 
   def test_overriden_defaults
-    args = %w[--no-bugsnag --no-retries --no-file-log --no-tunnel --log-requests --always-log --bind-address=1.2.3.4 \
+    args = %w[--no-bugsnag --no-retries --no-file-log --no-tunnel --log-requests --always-log --https --bind-address=1.2.3.4 \
               --port=1234]
     options = Maze::Option::Parser.parse args
     config = Maze::Configuration.new
@@ -121,6 +122,7 @@ def test_overriden_defaults
     assert_false config.enable_bugsnag
     assert_false config.enable_retries
 
+    assert_true config.https
     assert_true config.log_requests
     assert_true config.always_log
   end