Class: module:sassy-test

Runs assertions against compileFixture()'s result object.

The compileFixture() automatically calls this method to run a standard set of assertions against the result object before it is returned. If no Sass error occurs, assertResult() checks for an error when reading the output.css file using assert.ifError() and compares the results to the expected output using assert.strictEqual().

If the SassyTest user chooses, this method can be overridden to perform different assertions.

Runs sass' compile() with a light-weight wrapper.

In addition to running sass' compile(), this method:

• adds the test fixtures path directory to the loadPaths
• ensures the loadPaths are passed to sass

Sassy-test also adds the following properties to the sass result object:

• warn: An array containing the output of any @warn statements.
• debug: An array containing the output of any @debug statements.

import SassyTest from 'sassy-test';
const sassyTest = new SassyTest();

describe('a test suite', function() {
  it('should test something', function(done) {
    const path = 'fixtures/_init.scss';
    sassyTest.compile(path, options, function(error, result) {
      assert.ifError(error);
      assert.ok(result.css);
      done();
    });
  });
});

Compiles the test fixture and returns the result.

Looks inside the specified folder in test/fixtures, compiles the input.scss file and reads the output.css file. Before it returns the sass result object, it calls assertResult() to run a standard set of assertions.

compileFixture() does not test for errors itself; it requires the caller to decide if a Sass error is a test failure or not. Good Sass libraries should @error if used incorrectly and sassy-test lets you see these errors and assert they were the expected result.

Sassy-test also adds the following properties to the sass result object:

• warn: An array containing the output of any @warn statements.
• debug: An array containing the output of any @debug statements.
• sassError: A sass error object which contains @error statements, if any.
• expectedOutput: The text of the output.css file; should match the css property provided by sass.

import SassyTest from 'sassy-test';
const sassyTest = new SassyTest();

describe('a test suite', function() {
  it('should test something', async function() {
    sassyTest.compileFixture('sometest', options, function(error, result) {
      // If there was no error, compileFixture() has already compared
      // the compiled output of fixtures/sometest/input.scss to
      // fixtures/sometest/output.css.
      assert.ifError(error);
      done();
    });
  });
});

Runs sass' compileString() with a light-weight wrapper.

In addition to running sass' compileString(), this method:

• adds the test fixtures path directory to the loadPaths
• ensures the loadPaths are passed to sass

Sassy-test also adds the following properties to the sass result object:

• warn: An array containing the output of any @warn statements.
• debug: An array containing the output of any @debug statements.

import SassyTest from 'sassy-test';
const sassyTest = new SassyTest();

describe('a test suite', function() {
  it('should test something', async function() {
    let result;
    try {
      result = sassyTest.compileString(
        '@import "init"; // Imports fixtures/_init.scss.'
        options
      );
    } catch (error) {
      assert.ifError(error);
    }
    assert.ok(result.css);
  });
});

Configures the paths needed for the sassyTest object.

import SassyTest from 'sassy-test';
const sassyTest = new SassyTest();
sassyTest.configurePaths({
  fixtures: '/my/path/to/fixtures',
  loadPaths: ['/my/path/to/library']
});

If sassy-test is installed in node_modules and your test fixtures are in ./test/fixtures (relative to the root of your project), then sassy-test will automatically configure the fixtures path without you having to set fixtures with configurePaths().

Returns the full path to the requested test fixture.

When called without any parameters, this method returns the path to the test fixtures directory. If one or more parameters are given, the method will append them to the returned path.

import SassyTest from 'sassy-test';
const sassyTest = new SassyTest();

// Returns full path to the test fixtures.
const fixturePath = sassyTest.fixture();
// Returns full path to [fixtures]/sub-folder.
const fixturePath = sassyTest.fixture('sub-folder');
// Returns full path to [fixtures]/sub-folder/_file.scss.
const fixturePath = sassyTest.fixture('sub-folder', '_file.scss');