mongoose-data-seed

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../../"> <title data-ice="title">src/lib/core/seeder-generator.test.js | mongoose-data-seed</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="Seed mongodb with data using mongoose models"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="mongoose-data-seed"><meta property="twitter:description" content="Seed mongodb with data using mongoose models"></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/sharvit/mongoose-data-seed"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib">lib</a>V<a href="variable/index.html#static-variable-config">config</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-configFilename">configFilename</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultUserGeneratorConfig">defaultUserGeneratorConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemConfigTemplate">systemConfigTemplate</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemSeederTemplate">systemSeederTemplate</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands">lib/commands</a>F<a href="function/index.html#static-function-aliasToCommand">aliasToCommand</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-commandToFunction">commandToFunction</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getCommandAndArgvFromCli">getCommandAndArgvFromCli</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isAlias">isAlias</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runCommand">runCommand</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-aliases">aliases</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-availableCommandsList">availableCommandsList</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commands">commands</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commandsMap">commandsMap</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultCommand">defaultCommand</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-generate">lib/commands/generate</a>F<a href="function/index.html#static-function-generateSeeder">generateSeeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateOptions">validateOptions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-help">lib/commands/help</a>F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-init">lib/commands/init</a>C<a href="class/src/lib/commands/init/installer-logger.js~InstallerLogger.html">InstallerLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-promptMissingOptions">promptMissingOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runinstaller">runinstaller</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-run">lib/commands/run</a>C<a href="class/src/lib/commands/run/run-logger.js~RunLogger.html">RunLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-run">run</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-core">lib/core</a>C<a href="class/src/lib/core/installer-error.js~InstallerError.html">InstallerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/installer.js~Installer.html">Installer</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner-error.js~MdSeedRunnerError.html">MdSeedRunnerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner.js~MdSeedRunner.html">MdSeedRunner</a></li> <li data-ice="doc">C<a href="class/src/lib/core/seeder-generator.js~SeederGenerator.html">SeederGenerator</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-InstallerConfig">InstallerConfig</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-utils">lib/utils</a>C<a href="class/src/lib/utils/base-logger.js~BaseLogger.html">BaseLogger</a></li> <li data-ice="doc">C<a href="class/src/lib/utils/seeder.js~Seeder.html">Seeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-exit">exit</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getFolderNameFromPath">getFolderNameFromPath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getObjectWithSelectedKeys">getObjectWithSelectedKeys</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederFileName">normalizeSeederFileName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederName">normalizeSeederName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeederTemplatePath">validateSeederTemplatePath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeedersFolderName">validateSeedersFolderName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateUserConfig">validateUserConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-ExitCodes">ExitCodes</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/lib/core/seeder-generator.test.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import test from 'ava'; import sinon from 'sinon'; import path from 'path'; import SeederGenerator, { __RewireAPI__ as moduleRewireAPI, } from './seeder-generator'; const helperData = { name: 'some-name', seederName: 'SomeName', seederFileName: 'some-name.seeder.js', seederFilePath: 'some/path/some-name.seeder.js', seederFileRelativePath: 'some/relative-path/some-name.seeder.js', seederTemplate: 'some template', userSeedersFolderPath: 'some/path/for/seeders', userSeedersFolderName: 'some-folder-name', }; test('should create a new instance of SeederGenerator', t => { const createStubs = () => { sinon.stub(SeederGenerator.prototype, '_initOptions'); sinon.stub(SeederGenerator.prototype, '_initMemFs'); sinon.stub(SeederGenerator.prototype, '_initName'); }; const restoreStubs = () => { SeederGenerator.prototype._initOptions.restore(); SeederGenerator.prototype._initMemFs.restore(); SeederGenerator.prototype._initName.restore(); }; createStubs(); const { name, seederTemplate, userSeedersFolderPath } = helperData; const generator = new SeederGenerator({ name, seederTemplate, userSeedersFolderPath, }); t.true( generator._initOptions.calledWith({ seederTemplate, userSeedersFolderPath, }) ); t.true(generator._initMemFs.called); t.true(generator._initName.calledWith(name)); restoreStubs(); }); test('should generate Seeder', async t => { const { seederFileRelativePath } = helperData; const context = { seederFileRelativePath, _validateSeederFileNotExists: sinon.stub(), _copySeederTemplate: sinon.stub(), _commitMemFsChanges: sinon.stub().resolves(), }; const result = await SeederGenerator.prototype.generate.call(context); t.true(context._validateSeederFileNotExists.called); t.true(context._copySeederTemplate.called); t.true(context._commitMemFsChanges.called); t.is(result, context.seederFileRelativePath); }); test('should init options', t => { const createStubs = ({ getFolderNameFromPath }) => { moduleRewireAPI.__Rewire__('getFolderNameFromPath', getFolderNameFromPath); }; const restoreStubs = () => { moduleRewireAPI.__ResetDependency__('getFolderNameFromPath'); }; const { seederTemplate, userSeedersFolderPath, userSeedersFolderName, } = helperData; const getFolderNameFromPath = sinon .stub() .withArgs(userSeedersFolderPath) .returns(userSeedersFolderName); createStubs({ getFolderNameFromPath }); const context = {}; SeederGenerator.prototype._initOptions.call(context, { seederTemplate, userSeedersFolderPath, }); t.true(getFolderNameFromPath.calledWith(userSeedersFolderPath)); t.deepEqual(context, { options: { seederTemplate, userSeedersFolderName, userSeedersFolderPath, }, }); restoreStubs(); }); test('should init memFs', t => { const createStubs = ({ memFs, editor }) => { moduleRewireAPI.__Rewire__('memFs', memFs); moduleRewireAPI.__Rewire__('editor', editor); }; const restoreStubs = () => { moduleRewireAPI.__ResetDependency__('memFs'); moduleRewireAPI.__ResetDependency__('editor'); }; const store = 'some store'; const fs = 'some fs'; const memFs = { create: sinon.stub().returns(store) }; const editor = { create: sinon .stub() .withArgs(store) .returns(fs), }; createStubs({ memFs, editor }); const context = {}; SeederGenerator.prototype._initMemFs.call(context); t.true(memFs.create.called); t.true(editor.create.calledWith(store)); t.deepEqual(context, { fs }); restoreStubs(); }); test('should init name', t => { const { name, seederName, seederFileName, userSeedersFolderPath, userSeedersFolderName, } = helperData; const seederFilePath = path.join(userSeedersFolderPath, seederFileName); const seederFileRelativePath = path.join( userSeedersFolderName, seederFileName ); const context = { options: { userSeedersFolderPath, userSeedersFolderName } }; const expectedContext = Object.assign({}, context, { name, seederName, seederFileName, seederFilePath, seederFileRelativePath, }); SeederGenerator.prototype._initName.call(context, name); t.deepEqual(context, expectedContext); }); test('_validateSeederFileNotExists should throw error when seeder file are already exists', t => { const { seederFilePath, seederFileRelativePath } = helperData; const fs = { exists: () => true }; const context = { fs, seederFilePath, seederFileRelativePath }; t.throws( () => SeederGenerator.prototype._validateSeederFileNotExists.call(context), Error ); }); test('_validateSeederFileNotExists should not throw error when seeder file are not exists', t => { const { seederFilePath, seederFileRelativePath } = helperData; const fs = { exists: () => false }; const context = { fs, seederFilePath, seederFileRelativePath }; t.notThrows(() => SeederGenerator.prototype._validateSeederFileNotExists.call(context) ); }); test('should commit memFs changes', async t => { const fs = { commit: sinon.stub().callsArg(0) }; const context = { fs }; await SeederGenerator.prototype._commitMemFsChanges.call(context); t.true(fs.commit.called); }); test('should copy seeder template', async t => { const { seederName, seederTemplate, seederFilePath } = helperData; const fs = { copyTpl: sinon.spy() }; const context = { fs, seederName, seederFilePath, options: { seederTemplate }, }; SeederGenerator.prototype._copySeederTemplate.call(context); t.true(fs.copyTpl.calledWith(seederTemplate, seederFilePath, { seederName })); }); </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>