]> git.openstreetmap.org Git - rails.git/blob - test/teaspoon_env.rb
Add note on assigning issues
[rails.git] / test / teaspoon_env.rb
1 Teaspoon.configure do |config|
2   # Determines where the Teaspoon routes will be mounted. Changing this to "/jasmine" would allow you to browse to
3   # `http://localhost:3000/jasmine` to run your tests.
4   config.mount_at = "/teaspoon"
5
6   # Specifies the root where Teaspoon will look for files. If you're testing an engine using a dummy application it can
7   # be useful to set this to your engines root (e.g. `Teaspoon::Engine.root`).
8   # Note: Defaults to `Rails.root` if nil.
9   config.root = nil
10
11   # Paths that will be appended to the Rails assets paths
12   # Note: Relative to `config.root`.
13   config.asset_paths = ["test/javascripts", "test/javascripts/stylesheets"]
14
15   # Fixtures are rendered through a controller, which allows using HAML, RABL/JBuilder, etc. Files in these paths will
16   # be rendered as fixtures.
17   config.fixture_paths = ["test/javascripts/fixtures"]
18
19   # SUITES
20   #
21   # You can modify the default suite configuration and create new suites here. Suites are isolated from one another.
22   #
23   # When defining a suite you can provide a name and a block. If the name is left blank, :default is assumed. You can
24   # omit various directives and the ones defined in the default suite will be used.
25   #
26   # To run a specific suite
27   # - in the browser: http://localhost/teaspoon/[suite_name]
28   # - with the rake task: rake teaspoon suite=[suite_name]
29   # - with the cli: teaspoon --suite=[suite_name]
30   config.suite do |suite|
31     # Specify the framework you would like to use. This allows you to select versions, and will do some basic setup for
32     # you -- which you can override with the directives below. This should be specified first, as it can override other
33     # directives.
34     # Note: If no version is specified, the latest is assumed.
35     #
36     # Versions: 1.10.0, 1.17.1, 1.18.2, 1.19.0, 2.0.1, 2.1.0, 2.2.4, 2.2.5, 2.3.3
37     suite.use_framework :mocha, "2.3.3"
38
39     # Specify a file matcher as a regular expression and all matching files will be loaded when the suite is run. These
40     # files need to be within an asset path. You can add asset paths using the `config.asset_paths`.
41     suite.matcher = "{test/javascripts,app/assets}/**/*_test.{js,js.coffee,coffee,es6,js.es6}"
42
43     # Load additional JS files, but requiring them in your spec helper is the preferred way to do this.
44     # suite.javascripts = []
45
46     # You can include your own stylesheets if you want to change how Teaspoon looks.
47     # Note: Spec related CSS can and should be loaded using fixtures.
48     # suite.stylesheets = ["teaspoon"]
49
50     # This suites spec helper, which can require additional support files. This file is loaded before any of your test
51     # files are loaded.
52     suite.helper = "test_helper"
53
54     # Partial to be rendered in the head tag of the runner. You can use the provided ones or define your own by creating
55     # a `_boot.html.erb` in your fixtures path, and adjust the config to `"/boot"` for instance.
56     #
57     # Available: boot, boot_require_js
58     suite.boot_partial = "boot"
59
60     # Partial to be rendered in the body tag of the runner. You can define your own to create a custom body structure.
61     suite.body_partial = "body"
62
63     # Hooks allow you to use `Teaspoon.hook("fixtures")` before, after, or during your spec run. This will make a
64     # synchronous Ajax request to the server that will call all of the blocks you've defined for that hook name.
65     # suite.hook :fixtures, &proc{}
66
67     # Determine whether specs loaded into the test harness should be embedded as individual script tags or concatenated
68     # into a single file. Similar to Rails' asset `debug: true` and `config.assets.debug = true` options. By default,
69     # Teaspoon expands all assets to provide more valuable stack traces that reference individual source files.
70     # suite.expand_assets = true
71
72     # Non-.js file extensions Teaspoon should consider JavaScript files
73     # suite.js_extensions = [/(\.js)?.coffee/, /(\.js)?.es6/, ".es6.js"]
74   end
75
76   # Example suite. Since we're just filtering to files already within the root test/javascripts, these files will also
77   # be run in the default suite -- but can be focused into a more specific suite.
78   # config.suite :targeted do |suite|
79   #  suite.matcher = "spec/javascripts/targeted/*_spec.{js,js.coffee,coffee}"
80   # end
81
82   # CONSOLE RUNNER SPECIFIC
83   #
84   # These configuration directives are applicable only when running via the rake task or command line interface. These
85   # directives can be overridden using the command line interface arguments or with ENV variables when using the rake
86   # task.
87   #
88   # Command Line Interface:
89   # teaspoon --driver=phantomjs --server-port=31337 --fail-fast=true --format=junit --suite=my_suite /spec/file_spec.js
90   #
91   # Rake:
92   # teaspoon DRIVER=phantomjs SERVER_PORT=31337 FAIL_FAST=true FORMATTERS=junit suite=my_suite
93
94   # Specify which headless driver to use. Supports PhantomJS, Selenium Webdriver and BrowserStack Webdriver.
95   #
96   # Available: :phantomjs, :selenium, :browserstack
97   # PhantomJS: https://github.com/jejacks0n/teaspoon/wiki/Using-PhantomJS
98   # Selenium Webdriver: https://github.com/jejacks0n/teaspoon/wiki/Using-Selenium-WebDriver
99   # BrowserStack Webdriver: https://github.com/jejacks0n/teaspoon/wiki/Using-BrowserStack-WebDriver
100   # Capybara Webkit: https://github.com/jejacks0n/teaspoon/wiki/Using-Capybara-Webkit
101   require "selenium-webdriver"
102   config.driver = :selenium
103   config.driver_options = {
104     :client_driver => :firefox,
105     :selenium_options => {
106       :options => Selenium::WebDriver::Firefox::Options.new(:args => ["-headless"])
107     }
108   }
109
110   # Specify additional options for the driver.
111   #
112   # PhantomJS: https://github.com/jejacks0n/teaspoon/wiki/Using-PhantomJS
113   # Selenium Webdriver: https://github.com/jejacks0n/teaspoon/wiki/Using-Selenium-WebDriver
114   # BrowserStack Webdriver: https://github.com/jejacks0n/teaspoon/wiki/Using-BrowserStack-WebDriver
115   # Capybara Webkit: https://github.com/jejacks0n/teaspoon/wiki/Using-Capybara-Webkit
116   # config.driver_options = nil
117
118   # Specify the timeout for the driver. Specs are expected to complete within this time frame or the run will be
119   # considered a failure. This is to avoid issues that can arise where tests stall.
120   # config.driver_timeout = 180
121
122   # Specify a server to use with Rack (e.g. thin, mongrel). If nil is provided Rack::Server is used.
123   # config.server = nil
124
125   # Specify a host to run on a specific host, otherwise Teaspoon will use 127.0.0.1.
126   # config.server_host = nil
127
128   # Specify a port to run on a specific port, otherwise Teaspoon will use a random available port.
129   # config.server_port = nil
130
131   # Timeout for starting the server in seconds. If your server is slow to start you may have to bump this, or you may
132   # want to lower this if you know it shouldn't take long to start.
133   # config.server_timeout = 20
134
135   # Force Teaspoon to fail immediately after a failing suite. Can be useful to make Teaspoon fail early if you have
136   # several suites, but in environments like CI this may not be desirable.
137   # config.fail_fast = true
138
139   # Specify the formatters to use when outputting the results.
140   # Note: Output files can be specified by using `"junit>/path/to/output.xml"`.
141   #
142   # Available: :dot, :clean, :documentation, :json, :junit, :pride, :rspec_html, :snowday, :swayze_or_oprah, :tap, :tap_y, :teamcity
143   # config.formatters = [:dot]
144
145   # Specify if you want color output from the formatters.
146   # config.color = true
147
148   # Teaspoon pipes all console[log/debug/error] to $stdout. This is useful to catch places where you've forgotten to
149   # remove them, but in verbose applications this may not be desirable.
150   # config.suppress_log = false
151
152   # COVERAGE REPORTS / THRESHOLD ASSERTIONS
153   #
154   # Coverage reports requires Istanbul (https://github.com/gotwarlost/istanbul) to add instrumentation to your code and
155   # display coverage statistics.
156   #
157   # Coverage configurations are similar to suites. You can define several, and use different ones under different
158   # conditions.
159   #
160   # To run with a specific coverage configuration
161   # - with the rake task: rake teaspoon USE_COVERAGE=[coverage_name]
162   # - with the cli: teaspoon --coverage=[coverage_name]
163
164   # Specify that you always want a coverage configuration to be used. Otherwise, specify that you want coverage
165   # on the CLI.
166   # Set this to "true" or the name of your coverage config.
167   # config.use_coverage = nil
168
169   # You can have multiple coverage configs by passing a name to config.coverage.
170   # e.g. config.coverage :ci do |coverage|
171   # The default coverage config name is :default.
172   config.coverage do |coverage|
173     # Which coverage reports Istanbul should generate. Correlates directly to what Istanbul supports.
174     #
175     # Available: text-summary, text, html, lcov, lcovonly, cobertura, teamcity
176     # coverage.reports = ["text-summary", "html"]
177
178     # The path that the coverage should be written to - when there's an artifact to write to disk.
179     # Note: Relative to `config.root`.
180     # coverage.output_path = "coverage"
181
182     # Assets to be ignored when generating coverage reports. Accepts an array of filenames or regular expressions. The
183     # default excludes assets from vendor, gems and support libraries.
184     # coverage.ignore = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
185
186     # Various thresholds requirements can be defined, and those thresholds will be checked at the end of a run. If any
187     # aren't met the run will fail with a message. Thresholds can be defined as a percentage (0-100), or nil.
188     # coverage.statements = nil
189     # coverage.functions = nil
190     # coverage.branches = nil
191     # coverage.lines = nil
192   end
193 end