TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-23 22:11:09 +03:00
Code Issues Projects Releases Wiki Activity
17804dd3ac
Ghost/ghost/core/.c8rc.json

39 lines
1.0 KiB
JSON
Raw Normal View History

Configured c8 to exclude frontend and migrations from coverage refs: https://github.com/TryGhost/Toolbox/issues/117 Adding a basic configuration to the unit test coverage tracking to ignore irrelevant files.
2021-11-16 12:53:32 +03:00
{
Mode c8 configuration from package.json to .c8rc.json refs: https://github.com/TryGhost/Toolbox/issues/117 Simplifies the commands in package.json by adding defaults to the .c8rc.json file
2021-11-16 13:22:15 +03:00
"all": true,
Pinned coverage to current levels to prevent drops - Updating our config to have `--check-coverage` enforces that the coverage meets a certain level. - The default is 95 I believe, but our coverage is lower. - I've set the levels to our current levels, so any drop below these numbers will cause the build to fail. - I've also set the reporters to be text, html and cobertura so we always have a mini report, the full HTML files to navigate and cobertura for CI - Cleaned up CI so we don't use the cov:unit command as we're now using codecov - This also means we can remove the cov:unit command which was weird to use because it uses the last test run, which can be confusing
2022-02-24 12:20:17 +03:00
"check-coverage": true,
"reporter": [
Changed c8 reporter html -> html-spa - I might be the only person who uses these, but I like to dig into coverage reports so I can see where we've got holes - In Ghost the reports is huge and unweildy, and it's hard to see what coverage is like for components grouped by folders - html-spa reporter fixes this, it makes a beautiful nested tree view, but you can also switch to flat - it's so much more useful for working on coverage in an area of the codebase!
2022-03-09 17:15:40 +03:00
"html-spa",
Pinned coverage to current levels to prevent drops - Updating our config to have `--check-coverage` enforces that the coverage meets a certain level. - The default is 95 I believe, but our coverage is lower. - I've set the levels to our current levels, so any drop below these numbers will cause the build to fail. - I've also set the reporters to be text, html and cobertura so we always have a mini report, the full HTML files to navigate and cobertura for CI - Cleaned up CI so we don't use the cov:unit command as we're now using codecov - This also means we can remove the cov:unit command which was weird to use because it uses the last test run, which can be confusing
2022-02-24 12:20:17 +03:00
"text-summary",
"cobertura"
],
Added eslint rule for file naming convention As discussed with the product team we want to enforce kebab-case file names for all files, with the exception of files which export a single class, in which case they should be PascalCase and reflect the class which they export. This will help find classes faster, and should push better naming for them too. Some files and packages have been excluded from this linting, specifically when a library or framework depends on the naming of a file for the functionality e.g. Ember, knex-migrator, adapter-manager
2023-05-02 23:43:47 +03:00
"statements": 58.8,
Removed old email flow (#16349) fixes https://github.com/TryGhost/Team/issues/2611 The old email flow is no longer used since we introduced the email stability flow. This commit removes the related code and tests. The general test coverage decreased a bit as a result, because the old email flow probably had a high test coverage. The new flow is in separate packages, so it couldn't contribute to a higher test coverage (but it does have 100% unit test coverage).
2023-03-07 18:08:40 +03:00
"branches": 84,
Lowered minimum function coverage tests (#15894) refs https://github.com/TryGhost/Ghost/pull/15877 refs https://github.com/TryGhost/Ghost/pull/15892 We've been running into issues with unit test coverage in the references PR's and have tried adding unit tests, but the problem persists. We're lowering this to unblock development.
2022-11-29 12:55:53 +03:00
"functions": 50,
Added eslint rule for file naming convention As discussed with the product team we want to enforce kebab-case file names for all files, with the exception of files which export a single class, in which case they should be PascalCase and reflect the class which they export. This will help find classes faster, and should push better naming for them too. Some files and packages have been excluded from this linting, specifically when a library or framework depends on the naming of a file for the functionality e.g. Ember, knex-migrator, adapter-manager
2023-05-02 23:43:47 +03:00
"lines": 58.8,
Mode c8 configuration from package.json to .c8rc.json refs: https://github.com/TryGhost/Toolbox/issues/117 Simplifies the commands in package.json by adding defaults to the .c8rc.json file
2021-11-16 13:22:15 +03:00
"include": [
"core/{*.js,frontend,server,shared}"
],
Configured c8 to exclude frontend and migrations from coverage refs: https://github.com/TryGhost/Toolbox/issues/117 Adding a basic configuration to the unit test coverage tracking to ignore irrelevant files.
2021-11-16 12:53:32 +03:00
"exclude": [
"core/frontend/src/**",
"core/frontend/public/**",
"core/server/data/migrations/**",
Removed db schema config from test coverage refs https://ghost.slack.com/archives/C02G9E68C/p1669707419081529?thread_ts=1669702577.532999&cid=C02G9E68C refs https://github.com/TryGhost/Toolbox/issues/117 - Database schema definition file is a special type of "configuration" file containing mostly static declarations. This sort of code should not be tested by unit tests, rather by e2e tests
2022-11-29 10:50:28 +03:00
"core/server/data/schema/schema.js",
Added more files to c8 excludes There are some files we don't expect _unit_ tests for - they are e2e tested and tracking that is a different problem! - express routes and wiring files - this does not count middleware. Middleware functions should be fully unit tested - previous API version files - canary api endpoint configuration files - this does not count api utils, valiation and serialisation which can be unit tested
2021-11-16 18:53:08 +03:00
"!core/server/data/migrations/utils.js",
"core/frontend/web/**",
"!core/frontend/web/middleware/**",
"core/server/web/api/**",
"!core/server/web/api/middleware/**",
Added "testmode" app to coverage ignore list refs https://github.com/TryGhost/Toolbox/issues/486 - Testmode is a special app used for manual testing and has no value in code coverage reports
2022-11-30 12:45:22 +03:00
"core/server/web/api/testmode/**",
Added more files to c8 excludes There are some files we don't expect _unit_ tests for - they are e2e tested and tracking that is a different problem! - express routes and wiring files - this does not count middleware. Middleware functions should be fully unit tested - previous API version files - canary api endpoint configuration files - this does not count api utils, valiation and serialisation which can be unit tested
2021-11-16 18:53:08 +03:00
"core/server/web/parent/**",
"!core/server/web/parent/middleware/**",
"core/server/web/shared/**",
"!core/server/web/shared/middleware/**",
Renamed API `canary/` folder to `endpoints/` - now we only have one API version, it doesn't make sense to keep "canary" around - renaming it to `endpoints/` makes more sense for this - this commit renames the `core/server/api/canary/` folder to `core/server/api/endpoints/` - it also fixes the naming in test titles and the various other places we relied on this
2022-07-04 11:27:55 +03:00
"core/server/api/endpoints/**",
🐛 Fixed SingleUseTokens being cleared on boot (#15999) fixes https://github.com/TryGhost/Team/issues/1996 **Issue** Our Magic links are valid for 24 hours. After first usage, the token lives for a further 10 minutes, so that in the case of email servers or clients that "visit" links, the token can still be used. The implementation of the 10 minute window uses setTimeout, meaning if the process is interrupted, the 10 minute window is ignored completely, and the token will continue to live for the remainder of it's 24 hour validity period. To prevent that, the tokens are cleared on boot at the moment. **Solution** To remove the boot clearing logic, we need to make sure the tokens are only valid for 10 minutes after first use even during restarts. This commit adds 3 new fields to the SingleUseToken model: - updated_at: for storing the last time the token was changed/used). Not really used atm. - first_used_at: for storing the first time the token was used - used_count: for storing the number of times the token has been used Using these fields: - A token can only be used 3 times - A token is only valid for 10 minutes after first use, even if the server restarts in between - A token is only valid for 24 hours after creation (not changed) We now also delete expired tokens in a separate job instead of on boot / in a timeout.
2023-01-04 11:49:39 +03:00
"!core/server/api/endpoints/utils",
Updated coverage exemption list - like the members jobs, we don't need to run unit tests on these because they're not library code
2023-02-17 13:42:11 +03:00
"core/server/services/email-analytics/jobs/**",
Updated coverage excemption list Removed the wrapper class for the email service from coverage, because this only wires up a lot of dependencies, which is hard to test in a unit test because we also have to init all the dependencies in a unit test. It is already covered by E2E tests.
2023-02-17 16:27:59 +03:00
"core/server/services/members/jobs/**",
Removed service.js files from unit test coverage The service.js files are rarely unit tested because they are essentially glue code which acts as a singleton and doesn't use dependency injection, this lil cocktail makes it difficult to stub dependencies, as well as to call the init method more than once in a test suite. This change should give us improved unit test coverage
2023-03-12 19:08:40 +03:00
"core/server/services/email-service/wrapper.js",
"core/server/services/**/service.js"
Configured c8 to exclude frontend and migrations from coverage refs: https://github.com/TryGhost/Toolbox/issues/117 Adding a basic configuration to the unit test coverage tracking to ignore irrelevant files.
2021-11-16 12:53:32 +03:00
]
}
Reference in New Issue Copy Permalink