Developing Discourse Plugins - Part 6 - Add acceptance tests

Machigatta · November 22, 2018, 5:09pm

LOAD_PLUGINS=1 QUNIT_SKIP_CORE=1 QUNIT_SINGLE_PLUGIN='discouse-humble-box' /home/ravenstorm/.rbenv/versions/2.5.3/bin/rake qunit:test
Chrome is not installed. Download from https://www.google.com/chrome/browser/desktop/index.html
rake aborted!
Command failed with status (1): [LOAD_PLUGINS=1 QUNIT_SKIP_CORE=1 QUNIT_SIN...]
/home/ravenstorm/discourse/lib/tasks/plugin.rake:117:in `block in <main>'
Tasks: TOP => plugin:qunit

pmusaraj · November 22, 2018, 5:38pm

Install Chrome and then give it another try.

Machigatta · November 22, 2018, 5:56pm

Oh sorry i’ve pasted an old error code which i had stored in a pastebin

navigate to http://localhost:60099/qunit?qunit_single_plugin=discouse-humble-box&qunit_skip_core=1&seed=187998423095278311109560784485973475676
Tests timed out
rake aborted!
Command failed with status (124): [node /home/ravenstorm/discourse/vendor/ass...]
/home/ravenstorm/discourse/lib/tasks/qunit.rake:89:in `block in <main>'
Tasks: TOP => qunit:test
(See full trace by running task with --trace)
rake aborted!
Command failed with status (1): [LOAD_PLUGINS=1 QUNIT_SKIP_CORE=1 QUNIT_SIN...]
/home/ravenstorm/discourse/lib/tasks/plugin.rake:117:in `block in <main>'
Tasks: TOP => plugin:qunit

pmusaraj · November 22, 2018, 5:59pm

Try running the test in the browser as David suggested earlier. So, in your browser, when the server is running, go to your-local-site/qunit. Very often, for me, timeouts in the Terminal have errors in JS that I could see and fix after visiting /qunit on the browser.

Machigatta · November 22, 2018, 6:12pm

Thats one of the problems

I can’t find acceptance tests on my /qunit

Even after turning on all modules and filtering it with box and humble nothing is here

david · November 22, 2018, 6:46pm

Try renaming the folder to test/javascripts/acceptance - that extra s is quite important!

https://github.com/discourse/discourse/blob/cd0403174dd88b0d1619ee7a53b42bc600bd69d1/lib/plugin/instance.rb#L463

You might need to do rm -rf tmp, and then restart your development server for the changes to take effect.

pmusaraj · November 22, 2018, 7:20pm

Do what David said above (rename the folder to javascripts), but ALSO, change the name of your plugin in plugin.rb to discourse-humble-box to match the folder name. I did these two changes, and I see tests locally:

Machigatta · November 22, 2018, 7:28pm

Yea i’ve seen those as well now, but these aren’t really eye-opening results tbh.

But gotta dig deeper and lookup why these errors are shown.

Thanks for the help guys.
For example the second test case… if i am testing it myself by hand… it works, but running it on qunit it fails

Ok, got a brief idea whats bringing me the errors and it confuses me:
http://localhost:9292/ in my browser has the plugin installed and working
http://localhost:9292/qunit the test shows, that the plugin is not even installed

I thought these two are using the same enviroment ?
Could this be caused by my local dev-enviroment since it’s not using docker and I’m not able to install the plugin like Install Plugins in Discourse ? It’s just sitting in the plugins folder like the others.

Machigatta · November 30, 2018, 5:40pm

Any idea how this is possible ?

jlc · May 19, 2022, 3:29pm

I’m trying to follow this guide, but I’m getting stuck right at the beginning: I can’t access /qunit at all. (This also seems related to the Beginners Guide to Install Discourse on Ubuntu for Development, which is basically the approach I’m using to deploying Discourse on my local machine for learning about development, but this guide is the prompt that triggered my obstacle, so I thought I’d put it here.) Attempting to access it gives a “That page doesn’t exist or is private” response.

The controller for the /qunit route (discourse/qunit_controller.rb at 166fe3bb34f99bd0baa613726486ce0f13c7a992 · discourse/discourse · GitHub) mentions that it is # only used in non-ember-cli test / dev (the comment before that method), so I’ve tried running the instance with RAILS_ENV=test bundle exec rails server, but EmberCli.enabled? is still true.

What approach are you all using to run a local development server such that we can actually access /qunit (which probably involves disabling EmberCLI)? (I certainly may be missing something obvious.)

david · May 19, 2022, 4:06pm

The new path is /tests. I’ll update the OP - thanks!

jlc · May 19, 2022, 5:43pm

Great, thanks! On to the next obstacle:

This direct link to the particular acceptance test gives the error (with a backtrace):

Error: No tests matched the module "Acceptance: Purple Tentacle".

Indeed, when I search through the “Module:” select list, I don’t see anything there matching “purple” or “Purple”. Is there a new piece to the system for registering plugins or their tests that may be missing here?

If I search for “purple” using the “Filter:” text box, it takes me to the following URL: http://localhost:4200/tests?filter=purple, which gives me a different error:

Error: Could not find module `helpers/qunit-helpers` imported from `discourse/plugins//acceptance/purple-tentacle-test`
    at missingModule (http://localhost:4200/assets/vendor.js:259:11)

Do you have any ideas for what might be out of place here?

As a sidebar, does the /tests URL use the catch-all get "*url", to: 'permalinks#show' route, and thus Permalink.find_by_url to actually resolve? If so, at what point in Discourse initialization does the /tests URL mapping get loaded into the database?

nat · June 2, 2022, 11:06am

@jlc, thank you so much for trying out our guide and keeping us up to date.

I’ve made some changes to the OP’s example acceptance test to reflect some new changes we’re using for acceptance tests. Essentially, the two changes are

imports, and
the usage of the needs constant within acceptance

That should solve most of the issues you’ve mentioned. You can also make use of some of the needs options here:

github.com

discourse/discourse/blob/711cd7c85d2e58e101fd82800954cbc94baa9003/app/assets/javascripts/discourse/tests/helpers/qunit-helpers.js#L341-L371


      
          const needs = {
            user(changes) {
              loggedIn = true;
              userChanges = changes;
            },
            pretender(fn) {
              addPretenderCallback(name, fn);
            },
            site(changes) {
              siteChanges = changes;
            },
            settings(changes) {
              settingChanges = changes;
            },
            mobileView() {
              mobileView = true;
            },
          };
          
          if (options.loggedIn) {

This file has been truncated. show original

Looking through the whole qunit-helpers file would also be very useful!

Topic		Replies	Views
Developing Discourse Plugins - Part 5 - Add an admin interface Developer Guides plugin-guides , tutorial	47	25283	September 24, 2024
QUnit tests won't pass in discourse_dev docker image Dev	19	2568	July 25, 2017
Developing Discourse Plugins - Part 1 - Create a basic plugin Developer Guides plugin-guides , tutorial	31	79013	September 24, 2024
Best tools, materials & practices to onboard a hoarde of new users? Community	22	3458	January 30, 2018
Install Discourse for development using Docker Developer Guides docker , dev-install , how-to	214	77518	March 21, 2025

Developing Discourse Plugins - Part 6 - Add acceptance tests

Related topics