Ghost/ghost/stripe/test/unit/lib/Migrations.test.js
Hannah Wolfe 6161f94910
Updated to use assert/strict everywhere (#17047)
refs: https://github.com/TryGhost/Toolbox/issues/595

We're rolling out new rules around the node assert library, the first of which is enforcing the use of assert/strict. This means we don't need to use the strict version of methods, as the standard version will work that way by default.

This caught some gotchas in our existing usage of assert where the lack of strict mode had unexpected results:
- Url matching needs to be done on `url.href` see aa58b354a4
- Null and undefined are not the same thing,  there were a few cases of this being confused
- Particularly questionable changes in [PostExporter tests](c1a468744b) tracked [here](https://github.com/TryGhost/Team/issues/3505).
- A typo see eaac9c293a

Moving forward, using assert strict should help us to catch unexpected behaviour, particularly around nulls and undefineds during implementation.
2023-06-21 09:56:59 +01:00

162 lines
5.1 KiB
JavaScript

const assert = require('assert/strict');
const sinon = require('sinon');
const Migrations = require('../../../lib/StripeMigrations');
describe('Migrations', function () {
describe('updateStripeProductNamesFromDefaultProduct', function () {
it('Does not run migration if api is not configured', async function () {
const api = {
getProduct: sinon.stub().resolves({
id: 'prod_123',
name: 'Bronze'
}),
_configured: false
};
const models = {
Product: {
transaction: sinon.spy()
}
};
const migrations = new Migrations({
models,
api
});
await migrations.execute();
assert(
models.Product.transaction.called === false,
'Stripe should not call any of the populateProductsAndPrices method parts if api is not configured'
);
});
it('Does not run migration if api is in test environment', async function () {
const api = {
getProduct: sinon.stub().resolves({
id: 'prod_123',
name: 'Bronze'
}),
_configured: true,
testEnv: true
};
const models = {
Product: {
transaction: sinon.spy()
}
};
const migrations = new Migrations({
models,
api
});
await migrations.execute();
assert(
models.Product.transaction.called === false,
'Stripe should not call any of the populateProductsAndPrices method parts if api is not configured'
);
});
it('Does not update Stripe product if name is not "Default Product"', async function () {
const api = {
getProduct: sinon.stub().resolves({
id: 'prod_123',
name: 'Bronze'
}),
updateProduct: sinon.stub().resolves()
};
const models = {
Product: {
transaction: fn => fn()
},
StripeProduct: {
findPage: sinon.stub().resolves({
data: [{
get(key) {
return key;
}
}],
meta: {}
})
},
Settings: {
findOne: sinon.stub().resolves({
key: 'title',
value: 'Site Title'
})
}
};
const migrations = new Migrations({
models,
api
});
await migrations.updateStripeProductNamesFromDefaultProduct();
assert(
api.updateProduct.called === false,
'Stripe product should not be updated if name is not "Default Product"'
);
});
it('Updates the Stripe Product name if it is Default Product', async function () {
const api = {
getProduct: sinon.stub().resolves({
id: 'prod_123',
name: 'Default Product'
}),
updateProduct: sinon.stub().resolves()
};
const models = {
Product: {
transaction: fn => fn()
},
StripeProduct: {
findPage: sinon.stub().resolves({
data: [{
get(key) {
return key;
}
}],
meta: {}
})
},
Settings: {
findOne: sinon.stub().resolves({
get(key) {
if (key === 'key') {
return 'title';
}
if (key === 'value') {
return 'Site Title';
}
return key;
}
})
}
};
const migrations = new Migrations({
models,
api
});
await migrations.updateStripeProductNamesFromDefaultProduct();
assert(
api.updateProduct.calledOnce,
'Stripe product should be updated if name is "Default Product"'
);
assert(
api.updateProduct.calledWith('prod_123', {
name: 'Site Title'
}),
'Stripe product should have been updated with the site title as name'
);
});
});
});