(Superseded) Set up plugin continuous integration tests on Travis CI

LeoMcA · 2018 年 8 月 17 日午後 2:32

@david thanks so much for the comprehensive post, it helped immensely when getting my own plugin’s specs running in Travis

Here’s an example: Travis CI, and the scripts common to all my plugins live in:

From implementing this (and banging my head against my desk a lot) I’ve got a few improvements to propose:

Extract plugin name from `plugin.rb`

We have a discrepancy between the name of our plugins (e.g. mozilla-iam) and the name of its repo (e.g. discourse-mozilla-iam).

So I came up with a little oneliner to extract that name from plugin.rb rather than the directory:

github.com

mozilla/discourse-mozilla-travis/blob/master/before_script.sh#L2


      
          #!/bin/bash
          export PLUGIN_NAME=$(sed -n -e "s/# name: \([^ ]*\)\s*/\1/p" plugin.rb)
          echo "PLUGIN_NAME=$PLUGIN_NAME"
          chmod -R 777 . # This is necessary if your plugin installs gems

(some extra escapes will have to be thrown in to put it in a .travis.yml)

Travis log folding

Like Travis does automatically with all the pre-install and pre-script gubbins, you can force Travis to fold a section of output by echoing travis_fold:start:#{id} and travis_fold:end:#{id}

So like:

echo "travis_fold:start:discourse_setup"

and

echo "travis_fold:end:discourse_setup"

I did however spend far too long getting this working, because I managed to misspell discourse in the end command without noticing

To actually wrap the relevant sections with that command I had to roll my own near-duplicate of discourse/lib/tasks/docker.rake at main · discourse/discourse · GitHub.

I’d propose that script puts some fold commands if TRAVIS=true.

Measure code coverage and export to Coveralls

This is probably the least supported thing I got kinda working, and probably requires further discussion in its own topic.

It can be seen in practice here: mozilla/discourse-mozilla-iam | Coveralls - Test Coverage History & Statistics

The measuring of coverage itself is a bit quirky. Presumably because of the order in which files are loaded, any code executed in plugin.rb doesn’t get picked up by simplecov. I’m sure there’s some way around this, but I haven’t been able to figure it out (and I’ve just got around the problem by moving all the code I can into separate files).

To actually get coverage running, I import this file at the top of all my specs:

github.com

mozilla/discourse-mozilla-travis/blob/master/plugin_helper.rb

if ENV["COVERALLS"] || ENV["SIMPLECOV"]
  require "simplecov"

  if ENV["COVERALLS"]
    require "coveralls"
    SimpleCov.formatter = Coveralls::SimpleCov::Formatter
  end

  SimpleCov.start do
    root File.expand_path("../..", __FILE__)
    add_filter "spec/"
    add_filter "db/migrate"
    add_filter "gems/"
  end
end

require "rails_helper"

Which relies on those gems being installed, which I achieve like so:

github.com

mozilla/discourse-mozilla-travis/blob/master/entrypoint.sh#L8-L9


      
          git fetch origin tests-passed -q || exit 1
          git reset --hard origin/tests-passed -q || exit 1

It would be to see support for this in core. There’s a smattering for some of it already:

github.com

discourse/discourse/blob/main/spec/rails_helper.rb#L1-L4


      
          # frozen_string_literal: true
          
          if ENV["COVERAGE"]
            require "simplecov"

But simplecov isn’t in the Gemfile.

To then get coverage exported to Coveralls, I needed to export a couple of environment variables to docker.

Happy to submit a PR incorporating some of these improvements upstream, but I’ll take guidance on which would be welcomed.

Also, if anyone has any ideas about how to check JS test coverage that would be welcomed by me! There seemed to be a few methods of getting LCOV-formatted data out of QUnit-run tests, but none seemed to slot nicely into our existing tooling.

トピック		返信	表示
Setup Continuous Integration using GitHub Actions Developer Guides how-to , code	8	1364	2025 年 3 月 3 日
Developing Discourse Plugins - Part 6 - Add acceptance tests Developer Guides testing , plugin-guides , tutorial	32	16867	2022 年 6 月 2 日
Check plugin or theme validity Support	16	1354	2023 年 10 月 25 日
Is it possible to use a local plugin directory with a docker install? Dev	39	2689	2022 年 6 月 16 日
Plugin QUnit tests are not running as part of rake qunit:test Dev	7	2026	2017 年 7 月 17 日

(Superseded) Set up plugin continuous integration tests on Travis CI

Extract plugin name from plugin.rb

Travis log folding

Measure code coverage and export to Coveralls

関連トピック

Extract plugin name from `plugin.rb`