Sven
Sven

Reputation: 952

How can I inject parameters into a TestCafé test?

Scenario:

I run TestCafé wrapped in code, using the API I have a test I want to parameterize, testing with different dynamic values.

Problem

Testcafé has no support for sending parameters to a test. Is there a way to inject values?

Upvotes: 3

Views: 3098

Answers (2)

Andrey Belym
Andrey Belym

Reputation: 2903

You can use process.env to pass parameters to TestCafe tests from your runner script.

//test.js
const createTestCafe = require('testcafe');

(async => {
   process.env.foo = 'bar';

   const testcafe = await createTestCafe();

   await testcafe
       .createRunner()
       .src('test.js')
       .browsers('chrome')
       .run();

   await testcafe.close();
})()
//test.js
fixture `Examples`;

test('process.env', async t => {
    console.log(process.env.foo);
});

Upvotes: 6

Sven
Sven

Reputation: 952

Yes, there is a way! The clientScripts feature can be used to send in parameters. The documentation is very well written how to inject scripts. It took me some time to figure out how to use it from within the test so hopefully this will bring you on the right track.

  1. Create a data object with your params
  2. Add the JSON to a small JS code block representing a function
  3. Inject the code block to your runner/fixture/test with the .clientScripts setter
  4. eval the code in your test et voilá! You have the parameters
// Create the data object
let data = {aString: 'Yo!', aNumber: 345}

// Add it to a String value representing a JS function
const scriptContent = `
  function getParameters() {
    return ${JSON.stringify(data)};
  }`

// Invoke the test runner with the code block as content
testcafe('localhost').then(cafe => {
    cafe.createRunner()
      .src('mytest.js')
      .clientScripts({ content: scriptContent })
      .run()
      //...and so on...
})

Now, when the test is executed the getParameters function exists inside the page head. This code can be evaluated or invoked with a ClientFunction or a t.eval:

let x = await t.eval( () => getParameters() );
console.log(x);
await t.expect(x.aString).eql('Yo!', 'Not Okey, mKay?')

An answer with a fully working example can be found here.

Upvotes: 3

Related Questions