Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add db:migrate:status #385

Merged
merged 1 commit into from
Nov 21, 2016
+55 −0
Merged

add db:migrate:status #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions lib/tasks/db.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,35 @@ module.exports = {
}
},

'db:migrate:status': {
descriptions: {
'short': 'List the status of all migrations'
},

task: function () {
return getMigrator('migration').then(function (migrator) {
return ensureCurrentMetaSchema(migrator).then(function () {
return migrator.executed();
}).then(function (migrations) {
_.forEach(migrations, function (migration) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the way you are logging the results. Maybe something like this would be nicer:

Executed migrations:
- <migration file 1>
- <migration file 2>
...

Pending migrations:
- <migration file 3>
- <migration file 4>
...

If there are no executed or pending migrations, instead of that just log:

No executed migrations found.

No pending migrations found.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format I chose was modeled after ActiveRecord's 'rake db:migrate:status', which will make it familiar to many users.
Having the 'up' or 'down' at the front of each line makes it easy to grep for any down migrations.
Adding the extra verbiage if there are no migrations of a particular type goes against the typical unix command-line style.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point here, it is helpful for chaining more commands on the output.

console.log('up ', migration.file);
});
}).then(function () {
return migrator.pending();
}).then(function (migrations) {
_.forEach(migrations, function (migration) {
console.log('down', migration.file);
});
}).then(function () {
process.exit(0);
}).catch(function (err) {
console.error(err);
process.exit(1);
});
});
}
},

'db:migrate:undo': {
descriptions: {
'short': 'Revert the last migration run.'
Expand Down
26 changes: 26 additions & 0 deletions test/db/migrate/status.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
'use strict';

var Support = require(__dirname + '/../../support');
var helpers = require(__dirname + '/../../support/helpers');
var gulp = require('gulp');

([
'db:migrate:status'
]).forEach(function (flag) {
describe(Support.getTestDialectTeaser(flag), function () {
it('is correctly reports a down and an up migration', function (done) {
gulp
.src(Support.resolveSupportPath('tmp'))
.pipe(helpers.clearDirectory())
.pipe(helpers.runCli('init'))
.pipe(helpers.copyMigration('createPerson.js'))
.pipe(helpers.overwriteFile(JSON.stringify(helpers.getTestConfig()), 'config/config.json'))
.pipe(helpers.runCli('db:migrate', { pipeStdout: false }))
.pipe(helpers.copyMigration('renamePersonToUser.js'))
.pipe(helpers.runCli(flag, { pipeStdout: true }))
.pipe(helpers.ensureContent('up 20111117063700-createPerson.js'))
.pipe(helpers.ensureContent('down 20111205064000-renamePersonToUser.js'))
.pipe(helpers.teardown(done));
});
});
});