2021-02-22 04:28:32 -05:00
|
|
|
name: Tests
|
|
|
|
|
|
|
|
on:
|
|
|
|
pull_request:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- main
|
2022-03-17 22:15:48 -04:00
|
|
|
- beta
|
|
|
|
- stable
|
2021-02-22 04:28:32 -05:00
|
|
|
|
2021-11-25 15:44:40 -05:00
|
|
|
concurrency:
|
2021-11-25 17:31:05 -05:00
|
|
|
group: tests-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
|
2021-11-25 15:44:40 -05:00
|
|
|
cancel-in-progress: true
|
|
|
|
|
2022-07-30 11:22:03 -04:00
|
|
|
permissions:
|
|
|
|
contents: read
|
|
|
|
|
2021-02-22 04:28:32 -05:00
|
|
|
jobs:
|
|
|
|
build:
|
2022-12-21 11:52:35 -05:00
|
|
|
if: "!(github.event_name == 'push' && github.repository == 'discourse/discourse-private-mirror')"
|
2023-01-13 07:22:33 -05:00
|
|
|
name: ${{ matrix.target }} ${{ matrix.build_type }} ${{ matrix.ruby }}
|
2022-09-21 13:13:13 -04:00
|
|
|
runs-on: ${{ (matrix.build_type == 'annotations') && 'ubuntu-latest' || 'ubuntu-20.04-8core' }}
|
2023-02-22 13:39:49 -05:00
|
|
|
container: discourse/discourse_test:slim${{ (matrix.build_type == 'frontend' || matrix.build_type == 'system') && '-browsers' || '' }}${{ (matrix.ruby == '3.1') && '-ruby-3.1.0' || '' }}
|
2022-09-21 13:13:13 -04:00
|
|
|
timeout-minutes: 20
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
env:
|
|
|
|
DISCOURSE_HOSTNAME: www.example.com
|
|
|
|
RUBY_GLOBAL_METHOD_CACHE_SIZE: 131072
|
|
|
|
RAILS_ENV: test
|
|
|
|
PGUSER: discourse
|
|
|
|
PGPASSWORD: discourse
|
2023-01-26 08:26:02 -05:00
|
|
|
USES_PARALLEL_DATABASES: ${{ matrix.build_type == 'backend' || matrix.build_type == 'system' }}
|
2023-01-04 19:50:35 -05:00
|
|
|
CAPBYARA_DEFAULT_MAX_WAIT_TIME: 4
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
strategy:
|
|
|
|
fail-fast: false
|
|
|
|
|
|
|
|
matrix:
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
build_type: [backend, frontend, system, annotations]
|
2021-02-22 04:28:32 -05:00
|
|
|
target: [core, plugins]
|
2023-02-22 13:39:49 -05:00
|
|
|
ruby: ['3.2']
|
2021-07-06 04:47:16 -04:00
|
|
|
exclude:
|
|
|
|
- build_type: annotations
|
|
|
|
target: plugins
|
2022-01-19 05:41:52 -05:00
|
|
|
- build_type: frontend
|
|
|
|
target: core # Handled by core_frontend_tests job (below)
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
steps:
|
2023-01-30 10:39:43 -05:00
|
|
|
- name: Set working directory owner
|
|
|
|
run: chown root:root .
|
|
|
|
|
2022-04-28 09:51:48 -04:00
|
|
|
- uses: actions/checkout@v3
|
2021-02-22 04:28:32 -05:00
|
|
|
with:
|
|
|
|
fetch-depth: 1
|
|
|
|
|
|
|
|
- name: Setup Git
|
|
|
|
run: |
|
|
|
|
git config --global user.email "ci@ci.invalid"
|
|
|
|
git config --global user.name "Discourse CI"
|
|
|
|
|
2021-09-08 08:01:37 -04:00
|
|
|
- name: Start redis
|
|
|
|
run: |
|
|
|
|
redis-server /etc/redis/redis.conf &
|
2021-02-22 04:28:32 -05:00
|
|
|
|
2021-12-14 12:20:06 -05:00
|
|
|
- name: Start Postgres
|
|
|
|
run: |
|
|
|
|
chown -R postgres /var/run/postgresql
|
|
|
|
sudo -E -u postgres script/start_test_db.rb
|
|
|
|
sudo -u postgres psql -c "CREATE ROLE $PGUSER LOGIN SUPERUSER PASSWORD '$PGPASSWORD';"
|
|
|
|
|
2021-02-22 04:28:32 -05:00
|
|
|
- name: Bundler cache
|
2022-03-31 06:51:42 -04:00
|
|
|
uses: actions/cache@v3
|
2021-02-22 04:28:32 -05:00
|
|
|
with:
|
|
|
|
path: vendor/bundle
|
2023-01-13 09:39:49 -05:00
|
|
|
key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
|
2021-02-22 04:28:32 -05:00
|
|
|
restore-keys: |
|
2023-01-13 09:39:49 -05:00
|
|
|
${{ runner.os }}-${{ matrix.ruby }}-gem-
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
- name: Setup gems
|
|
|
|
run: |
|
2022-01-12 16:50:04 -05:00
|
|
|
gem install bundler --conservative -v $(awk '/BUNDLED WITH/ { getline; gsub(/ /,""); print $0 }' Gemfile.lock)
|
2021-02-22 04:28:32 -05:00
|
|
|
bundle config --local path vendor/bundle
|
|
|
|
bundle config --local deployment true
|
|
|
|
bundle config --local without development
|
|
|
|
bundle install --jobs 4
|
|
|
|
bundle clean
|
|
|
|
|
|
|
|
- name: Get yarn cache directory
|
|
|
|
id: yarn-cache-dir
|
2022-11-11 08:12:08 -05:00
|
|
|
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
- name: Yarn cache
|
2022-03-31 06:51:42 -04:00
|
|
|
uses: actions/cache@v3
|
2021-02-22 04:28:32 -05:00
|
|
|
id: yarn-cache
|
|
|
|
with:
|
|
|
|
path: ${{ steps.yarn-cache-dir.outputs.dir }}
|
|
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
|
|
restore-keys: |
|
|
|
|
${{ runner.os }}-yarn-
|
|
|
|
|
|
|
|
- name: Yarn install
|
|
|
|
run: yarn install
|
|
|
|
|
|
|
|
- name: Checkout official plugins
|
|
|
|
if: matrix.target == 'plugins'
|
|
|
|
run: bin/rake plugin:install_all_official
|
|
|
|
|
2022-03-17 22:49:58 -04:00
|
|
|
- name: Pull compatible versions of plugins
|
|
|
|
if: matrix.target == 'plugins'
|
|
|
|
run: bin/rake plugin:pull_compatible_all
|
|
|
|
|
2021-12-14 04:40:16 -05:00
|
|
|
- name: Fetch app state cache
|
2022-03-31 06:51:42 -04:00
|
|
|
uses: actions/cache@v3
|
2021-12-14 04:40:16 -05:00
|
|
|
id: app-cache
|
|
|
|
with:
|
|
|
|
path: tmp/app-cache
|
|
|
|
key: >- # postgres version, hash of migrations, "parallel?"
|
|
|
|
${{ runner.os }}-
|
|
|
|
${{ hashFiles('.github/workflows/tests.yml') }}-
|
|
|
|
${{ matrix.postgres }}-
|
|
|
|
${{ hashFiles('db/**/*', 'plugins/**/db/**/*') }}-
|
|
|
|
${{ env.USES_PARALLEL_DATABASES }}
|
|
|
|
|
|
|
|
- name: Restore database from cache
|
|
|
|
if: steps.app-cache.outputs.cache-hit == 'true'
|
|
|
|
run: psql -f tmp/app-cache/cache.sql postgres
|
|
|
|
|
|
|
|
- name: Restore uploads from cache
|
|
|
|
if: steps.app-cache.outputs.cache-hit == 'true'
|
|
|
|
run: rm -rf public/uploads && cp -r tmp/app-cache/uploads public/uploads
|
|
|
|
|
|
|
|
- name: Create and migrate database
|
|
|
|
if: steps.app-cache.outputs.cache-hit != 'true'
|
2021-02-22 04:28:32 -05:00
|
|
|
run: |
|
|
|
|
bin/rake db:create
|
|
|
|
bin/rake db:migrate
|
|
|
|
|
2021-12-14 04:40:16 -05:00
|
|
|
- name: Create and migrate parallel databases
|
|
|
|
if: >-
|
|
|
|
env.USES_PARALLEL_DATABASES == 'true' &&
|
|
|
|
steps.app-cache.outputs.cache-hit != 'true'
|
2021-02-22 04:28:32 -05:00
|
|
|
run: |
|
|
|
|
bin/rake parallel:create
|
|
|
|
bin/rake parallel:migrate
|
|
|
|
|
2021-12-14 04:40:16 -05:00
|
|
|
- name: Dump database for cache
|
|
|
|
if: steps.app-cache.outputs.cache-hit != 'true'
|
|
|
|
run: mkdir -p tmp/app-cache && pg_dumpall > tmp/app-cache/cache.sql
|
|
|
|
|
|
|
|
- name: Dump uploads for cache
|
|
|
|
if: steps.app-cache.outputs.cache-hit != 'true'
|
|
|
|
run: rm -rf tmp/app-cache/uploads && cp -r public/uploads tmp/app-cache/uploads
|
|
|
|
|
2022-09-21 17:13:25 -04:00
|
|
|
- name: Fetch turbo_rspec_runtime.log cache
|
|
|
|
uses: actions/cache@v3
|
|
|
|
id: test-runtime-cache
|
|
|
|
if: matrix.build_type == 'backend' && matrix.target == 'core'
|
|
|
|
with:
|
|
|
|
path: tmp/turbo_rspec_runtime.log
|
|
|
|
key: rspec-runtime-backend-core
|
|
|
|
|
2023-03-16 10:22:16 -04:00
|
|
|
- name: Run Zeitwerk check
|
|
|
|
if: matrix.build_type == 'backend'
|
|
|
|
env:
|
|
|
|
LOAD_PLUGINS: ${{ (matrix.target == 'plugins') && '1' || '0' }}
|
|
|
|
run: |
|
|
|
|
if ! bin/rails zeitwerk:check --trace; then
|
|
|
|
echo
|
|
|
|
echo "---------------------------------------------"
|
|
|
|
echo
|
|
|
|
echo "::error::'bin/rails zeitwerk:check' failed - the app will fail to boot with 'eager_load=true' (e.g. in production)."
|
|
|
|
echo "To reproduce locally, run 'bin/rails zeitwerk:check'."
|
|
|
|
echo "Alternatively, you can run your local server/tests with the 'DISCOURSE_ZEITWERK_EAGER_LOAD=1' environment variable."
|
|
|
|
echo
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2021-02-22 04:28:32 -05:00
|
|
|
- name: Core RSpec
|
|
|
|
if: matrix.build_type == 'backend' && matrix.target == 'core'
|
2021-06-07 15:28:59 -04:00
|
|
|
run: bin/turbo_rspec --verbose
|
2021-02-22 04:28:32 -05:00
|
|
|
|
|
|
|
- name: Plugin RSpec
|
|
|
|
if: matrix.build_type == 'backend' && matrix.target == 'plugins'
|
2022-09-20 10:42:54 -04:00
|
|
|
run: bin/rake plugin:turbo_spec
|
2021-02-22 04:28:32 -05:00
|
|
|
|
2022-06-20 10:33:05 -04:00
|
|
|
- name: Plugin QUnit
|
2022-07-16 16:55:39 -04:00
|
|
|
if: matrix.build_type == 'frontend' && matrix.target == 'plugins'
|
2022-09-21 13:13:13 -04:00
|
|
|
run: QUNIT_PARALLEL=3 bin/rake plugin:qunit['*','1200000']
|
2021-02-22 04:28:32 -05:00
|
|
|
timeout-minutes: 30
|
2021-07-06 04:47:16 -04:00
|
|
|
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
- name: Ember Build for System Tests
|
|
|
|
if: matrix.build_type == 'system'
|
|
|
|
run: bin/ember-cli --build
|
|
|
|
|
2023-01-26 08:26:02 -05:00
|
|
|
- name: Setup Webdriver
|
|
|
|
if: matrix.build_type == 'system'
|
|
|
|
run: bin/rails runner "require 'webdrivers'; Webdrivers::Chromedriver.update"
|
|
|
|
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
- name: Core System Tests
|
|
|
|
if: matrix.build_type == 'system' && matrix.target == 'core'
|
2023-03-15 15:40:45 -04:00
|
|
|
run: bin/rspec spec/system
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
|
|
|
|
- name: Plugin System Tests
|
|
|
|
if: matrix.build_type == 'system' && matrix.target == 'plugins'
|
2023-03-15 15:40:45 -04:00
|
|
|
run: LOAD_PLUGINS=1 bin/rspec plugins/*/spec/system
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
|
|
|
|
- name: Upload failed system test screenshots
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
if: matrix.build_type == 'system' && failure()
|
|
|
|
with:
|
|
|
|
name: failed-system-test-screenshots
|
2022-12-13 00:36:30 -05:00
|
|
|
path: tmp/capybara/*.png
|
DEV: Minimal first pass of rails system test setup (#16311)
This commit introduces rails system tests run with chromedriver, selenium,
and headless chrome to our testing toolbox.
We use the `webdrivers` gem and `selenium-webdriver` which is what
the latest Rails uses so the tests run locally and in CI out of the box.
You can use `SELENIUM_VERBOSE_DRIVER_LOGS=1` to show extra
verbose logs of what selenium is doing to communicate with the system
tests.
By default JS logs are verbose so errors from JS are shown when
running system tests, you can disable this with
`SELENIUM_DISABLE_VERBOSE_JS_LOGS=1`
You can use `SELENIUM_HEADLESS=0` to run the system
tests inside a chrome browser instead of headless, which can be useful to debug things
and see what the spec sees. See note above about `bin/ember-cli` to avoid
surprises.
I have modified `bin/turbo_rspec` to exclude `spec/system` by default,
support for parallel system specs is a little shaky right now and we don't
want them slowing down the turbo by default either.
### PageObjects and System Tests
To make querying and inspecting parts of the page easier
and more reusable inbetween system tests, we are using the
concept of [PageObjects](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) in
our system tests. A "Page" here is generally corresponds to
an overarching ember route, e.g. "Topic" for `/t/324345/some-topic`,
and this contains logic for querying components within the topic
such as "Posts".
I have also split "Modals" into their own entity. Further down the
line we may want to explore creating independent "Component"
contexts.
Capybara DSL should be included in each PageObject class,
reference for this can be found at https://rubydoc.info/github/teamcapybara/capybara/master#the-dsl
For system tests, since they are so slow, we want to focus on
the "happy path" and not do every different possible context
and branch check using them. They are meant to be overarching
tests that check a number of things are correct using the full stack
from JS and ember to rails to ruby and then the database.
### CI Setup
Whenever a system spec fails, a screenshot
is taken and a build artifact is produced _after the entire CI run is complete_,
which can be downloaded from the Actions UI in the repo.
Most importantly, a step to build the Ember app using Ember CLI
is needed, otherwise the JS assets cannot be found by capybara:
```
- name: Build Ember CLI
run: bin/ember-cli --build
```
A new `--build` argument has been added to `bin/ember-cli` for this
case, which is not needed locally if you already have the discourse
rails server running via `bin/ember-cli -u` since the whole server is built and
set up by default.
Co-authored-by: David Taylor <david@taylorhq.com>
2022-09-27 21:48:16 -04:00
|
|
|
|
2021-07-06 04:47:16 -04:00
|
|
|
- name: Check Annotations
|
|
|
|
if: matrix.build_type == 'annotations'
|
|
|
|
run: |
|
|
|
|
bin/rake annotate:ensure_all_indexes
|
|
|
|
bin/annotate --models --model-dir app/models
|
|
|
|
|
|
|
|
if [ ! -z "$(git status --porcelain app/models/)" ]; then
|
|
|
|
echo "Core annotations are not up to date. To resolve, run:"
|
|
|
|
echo " bin/rake annotate:clean"
|
|
|
|
echo
|
|
|
|
echo "Or manually apply the diff printed below:"
|
|
|
|
echo "---------------------------------------------"
|
|
|
|
git -c color.ui=always diff app/models/
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
timeout-minutes: 30
|
2022-01-19 05:41:52 -05:00
|
|
|
|
|
|
|
core_frontend_tests:
|
2022-12-21 11:52:35 -05:00
|
|
|
if: "!(github.event_name == 'push' && github.repository == 'discourse/discourse-private-mirror')"
|
2022-01-19 05:41:52 -05:00
|
|
|
name: core frontend (${{ matrix.browser }})
|
2022-09-21 13:13:13 -04:00
|
|
|
runs-on: ubuntu-20.04-8core
|
|
|
|
container:
|
|
|
|
image: discourse/discourse_test:slim-browsers
|
|
|
|
options: --user discourse
|
|
|
|
|
2022-08-14 11:30:15 -04:00
|
|
|
timeout-minutes: 35
|
2022-01-19 05:41:52 -05:00
|
|
|
|
|
|
|
strategy:
|
|
|
|
fail-fast: false
|
|
|
|
matrix:
|
2022-09-21 10:34:26 -04:00
|
|
|
browser: ["Chrome", "Firefox ESR", "Firefox Evergreen"]
|
|
|
|
|
|
|
|
env:
|
|
|
|
TESTEM_BROWSER: ${{ (startsWith(matrix.browser, 'Firefox') && 'Firefox') || matrix.browser }}
|
|
|
|
TESTEM_FIREFOX_PATH: ${{ (matrix.browser == 'Firefox Evergreen') && '/opt/firefox-evergreen/firefox' }}
|
2022-01-19 05:41:52 -05:00
|
|
|
|
|
|
|
steps:
|
2022-11-11 08:31:28 -05:00
|
|
|
- uses: actions/checkout@v3
|
2022-01-19 05:41:52 -05:00
|
|
|
with:
|
|
|
|
fetch-depth: 1
|
|
|
|
|
|
|
|
- name: Setup Git
|
|
|
|
run: |
|
|
|
|
git config --global user.email "ci@ci.invalid"
|
|
|
|
git config --global user.name "Discourse CI"
|
|
|
|
|
|
|
|
- name: Get yarn cache directory
|
|
|
|
id: yarn-cache-dir
|
2022-11-11 08:12:08 -05:00
|
|
|
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
|
2022-01-19 05:41:52 -05:00
|
|
|
|
|
|
|
- name: Yarn cache
|
2022-03-31 06:51:42 -04:00
|
|
|
uses: actions/cache@v3
|
2022-01-19 05:41:52 -05:00
|
|
|
id: yarn-cache
|
|
|
|
with:
|
|
|
|
path: ${{ steps.yarn-cache-dir.outputs.dir }}
|
|
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
|
|
restore-keys: |
|
|
|
|
${{ runner.os }}-yarn-
|
|
|
|
|
|
|
|
- name: Yarn install
|
|
|
|
working-directory: ./app/assets/javascripts/discourse
|
|
|
|
run: yarn install
|
|
|
|
|
|
|
|
- name: Ember Build
|
|
|
|
working-directory: ./app/assets/javascripts/discourse
|
|
|
|
run: |
|
2022-09-21 13:13:13 -04:00
|
|
|
mkdir /tmp/emberbuild
|
|
|
|
yarn ember build --environment=test -o /tmp/emberbuild
|
2022-01-19 05:41:52 -05:00
|
|
|
|
2022-09-21 13:13:13 -04:00
|
|
|
- name: Core QUnit
|
2022-01-19 05:41:52 -05:00
|
|
|
working-directory: ./app/assets/javascripts/discourse
|
2022-09-21 13:13:13 -04:00
|
|
|
run: yarn ember exam --path /tmp/emberbuild --load-balance --parallel=5 --launch "${{ env.TESTEM_BROWSER }}" --write-execution-file --random
|
2022-08-14 11:30:15 -04:00
|
|
|
timeout-minutes: 15
|
2022-01-19 05:41:52 -05:00
|
|
|
|
2022-09-21 13:13:13 -04:00
|
|
|
- uses: actions/upload-artifact@v3
|
|
|
|
if: ${{ always() }}
|
|
|
|
with:
|
|
|
|
name: ember-exam-execution-${{matrix.browser}}
|
|
|
|
path: ./app/assets/javascripts/discourse/test-execution-*.json
|