fix(live-server): testing

[mfranzke]

Summary of changes:

I've identified that the tests for the live-server subpackage tend to fail (not just partly like before, but due to bigger problems in total).

It seems to be especially about two code changes that have been introduced with commit f56ba66 that would need to get further analyzed (both executed via yarn run test:separate:

• f56ba66#diff-51d22b3e81513a3393c5550557316dda316d952a663f8423e1245cd394920724R176

yarn run v1.22.10
$ mocha test && npm run lint
/Users/maximilianfranzke/Sites/patternlab-node-fork/packages/live-server/index.js:175
  const watchPaths = options.watch || [root, ...options.assets];
                                                        ^

TypeError: options.assets is not iterable
    at Object.LiveServer.start (/Users/maximilianfranzke/Sites/patternlab-node-fork/packages/live-server/index.js:175:57)
    at Object.<anonymous> (/Users/maximilianfranzke/Sites/patternlab-node-fork/packages/live-server/test/acceptance.js:3:32)
    at Module._compile (internal/modules/cjs/loader.js:956:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:973:10)
    at Module.load (internal/modules/cjs/loader.js:812:32)
    at Function.Module._load (internal/modules/cjs/loader.js:724:14)
    at Module.require (internal/modules/cjs/loader.js:849:19)
    at require (internal/modules/cjs/helpers.js:74:18)
    at /Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/mocha/lib/mocha.js:231:27
    at Array.forEach (<anonymous>)
    at Mocha.loadFiles (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/mocha/lib/mocha.js:228:14)
    at Mocha.run (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/mocha/lib/mocha.js:514:10)
    at Object.<anonymous> (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/mocha/bin/_mocha:484:18)
    at Module._compile (internal/modules/cjs/loader.js:956:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:973:10)
    at Module.load (internal/modules/cjs/loader.js:812:32)
    at Function.Module._load (internal/modules/cjs/loader.js:724:14)
    at Function.Module.runMain (internal/modules/cjs/loader.js:1025:10)
    at internal/main/run_main_module.js:17:11
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

• f56ba66#diff-51d22b3e81513a3393c5550557316dda316d952a663f8423e1245cd394920724L455, among others:

  33) spa tests
       spa-ignore-assets should not redirect .css:
     TypeError: Cannot read property 'address' of undefined
      at Test.serverAddress (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:55:18)
      at new Test (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:36:12)
      at Object.obj.<computed> [as get] (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/index.js:25:14)
      at Context.<anonymous> (test/spa.js:36:40)
      at processImmediate (internal/timers.js:439:21)

Additionally I've fixed these further aspects:

• patternlab script injection has been removed with pull request Fix live-server injects code to SVGs #1235, so the test is now failing:

  1) basic functional tests
       should not inject script into svg files:
     Error: injected code not found
      at test/acceptance.js:44:17
      at Test._assertFunction (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:281:11)
      at Test.assert (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:171:18)
      at assert (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:131:12)
      at /Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/supertest/lib/test.js:128:5
      at Test.Request.callback (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/superagent/lib/node/index.js:716:12)
      at /Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/superagent/lib/node/index.js:916:18
      at IncomingMessage.<anonymous> (/Users/maximilianfranzke/Sites/patternlab-node-fork/node_modules/superagent/lib/node/parsers/image.js:10:5)
      at endReadableNT (_stream_readable.js:1183:12)
      at processTicksAndRejections (internal/process/task_queues.js:80:21)

• the package got renamed with commit 420f3ea:

Uncaught AssertionError [ERR_ASSERTION]: version not found

@JosefBredereck do you have the chance to have a look whether those two changes to your previously checked in code with commit f56ba66 are fine for you?

The following code changes are mainly minor changes, but remaining to have the tests run smoothly again:

• The following test case doesn't make any sense, compare the condition with the error message (https://github.com/pattern-lab/patternlab-node/pull/1331/files#diff-afbb42c28735c64e9b94d7c4e722327342e280f8f270db1950a3c4b803f64f72L45):

assert(stdout.indexOf('Serving') == 0, 'serving string not found');

Solutions

• The first issue is solved by testing for the variable first before trying to iterate over it.
• And the second is by reintegrating the return for the server object, compare to e.g. https://stackoverflow.com/a/38729860
• Negate the check for script injection to SVG files, as this was changed with pull request Fix live-server injects code to SVGs #1235 to not get included in those files any more.
• Renamed the package within the test file according to its changed name with commit 420f3ea
• Corrected the cli conditions on "serving string not found", as searching for the string starting at the beginning in relation to this error message works correctly if this condition is being negated.
• Even work in progress test cases get interpreted and that for have been commented out from the file https://github.com/pattern-lab/patternlab-node/pull/1331/files#diff-3f9d76101afaf1ea8d9215739948c6d84cd5631041ccadd5bd251a9c1e2512edR58
• Added some simple code changes out of ESLint feedback, to finally let the test cases run through smoothly (didn't wanted to open a new issue / merge request for those simple, but related "fixes").
• exiting mocha at the end by its version 3 behavior

Retest

To retest the changes out of this release:

yarn run setup && cd packages/live-server/ && yarn run test:separate