Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00
Code Issues Activity
ghost/test/utils/fixtures/themes/README.md

36 lines
1.7 KiB
Markdown
Raw Normal View History

Updated casper test fixture to latest version closes: https://github.com/TryGhost/Toolbox/issues/193 - Our Casper fixture was several years out of date. - I'd already updated the ghost-api to point to the latest API version, which was the main difference - This makes sure the full fixture is up to date and correct, and therefore that we're truly testing if Ghost right now works - It also adds instructions for how to update it in future GOTCHA: the mock-express-style tests are failing if the API difference between test-theme and casper are different - I've tried to look into why this is - it's something to do with the overridden route settings not working properly if the API version changes - Given that we may not keep this style of testing AND we are definitely not keeping API versions, I'm ignoreing this for now - To get around it, I'm setting both themes to be v4 API, so that Casper is exactly as in main
2022-01-25 06:38:03 -05:00
# Theme Fixtures
These files are used throughout our tests to mock themes in various states.
## Updating the Casper theme fixture
The casper fixture is a partial copy of the content/themes/casper folder.
It should not include any files that aren't needed to run the theme.
Updated fixture Casper@v4.7.2 & corrected README - I noticed our test fixture theme was still throwing errors during tests because it had partials that are no longer in use - Updated the docs on how to update Casper to include ensuring Casper was on a valid version AND removing Casper before copying it across - Performed the exact steps in the README - This ensures that the Casper version we use in our tests is not throwing tonnes of errors and is up to date
2022-02-15 10:34:55 -05:00
To update it:
Updated casper test fixture to latest version closes: https://github.com/TryGhost/Toolbox/issues/193 - Our Casper fixture was several years out of date. - I'd already updated the ghost-api to point to the latest API version, which was the main difference - This makes sure the full fixture is up to date and correct, and therefore that we're truly testing if Ghost right now works - It also adds instructions for how to update it in future GOTCHA: the mock-express-style tests are failing if the API difference between test-theme and casper are different - I've tried to look into why this is - it's something to do with the overridden route settings not working properly if the API version changes - Given that we may not keep this style of testing AND we are definitely not keeping API versions, I'm ignoreing this for now - To get around it, I'm setting both themes to be v4 API, so that Casper is exactly as in main
2022-01-25 06:38:03 -05:00
Updated fixture Casper@v4.7.2 & corrected README - I noticed our test fixture theme was still throwing errors during tests because it had partials that are no longer in use - Updated the docs on how to update Casper to include ensuring Casper was on a valid version AND removing Casper before copying it across - Performed the exact steps in the README - This ensures that the Casper version we use in our tests is not throwing tonnes of errors and is up to date
2022-02-15 10:34:55 -05:00
1. Ensure your `content/themes/casper` folder is on the latest released version e.g.
- Run `yarn main`
- `cd content/themes/casper`
- `git log -20` - find the latest tag
- `git checkout vx.y.z` - checkout the latest tag
2. Ensure you are in side this folder (the fixtures/themes directory), remove casper entirely and then copy it across fresh:
- `cd tests/utils/fixtures/themes`
- `rm -rf casper`
- `rsync -rv --exclude '.git*' --exclude 'assets/css*' --exclude 'assets/js*' --exclude 'gulpfile.js' --exclude 'yarn.lock' --exclude 'README.md' ../../../../content/themes/casper .`
Updated casper test fixture to latest version closes: https://github.com/TryGhost/Toolbox/issues/193 - Our Casper fixture was several years out of date. - I'd already updated the ghost-api to point to the latest API version, which was the main difference - This makes sure the full fixture is up to date and correct, and therefore that we're truly testing if Ghost right now works - It also adds instructions for how to update it in future GOTCHA: the mock-express-style tests are failing if the API difference between test-theme and casper are different - I've tried to look into why this is - it's something to do with the overridden route settings not working properly if the API version changes - Given that we may not keep this style of testing AND we are definitely not keeping API versions, I'm ignoreing this for now - To get around it, I'm setting both themes to be v4 API, so that Casper is exactly as in main
2022-01-25 06:38:03 -05:00
Added instructions about theme fixtures maintenance refs https://github.com/TryGhost/Ghost/commit/492f115850e9140046fcfe27031655fdec837822 - Added quick copy-pasteable instruction on modifying theme fixtures - Added notes about possible future improvemetns and current pitfalls when touching theme fixtures
2021-03-01 01:32:20 -05:00
### Modifying theme fixtures
When a new rule is introduced in gscan one of these fixture files might break and you'll have to update a "zip" which isn't as easy as opening a text editor... It could become that one day but for now here are some commands to help out with the edit process
- Unzip the theme files, e.g.: `cd $CURRENT_DIR && unzip valid.zip -d valid`
- Make a change in the file which caused a warning/error/whatever
Added detection of "ghost-api" use in theme config refs https://github.com/TryGhost/Toolbox/issues/241 - The `engines.ghost-api` property has been deprecated and the support for it will be dropped in Ghost v5 due to versionless nature of the Content API. - When uploading a new theme or activating existing one that uses ghost-api in it's config a warning will be shown to the user
2022-03-21 22:15:58 -05:00
- Zip the files back: `cd valid; zip -r ../valid.zip * ; cd ..`
- Clean up `rm -rf ./valid`
Added instructions about theme fixtures maintenance refs https://github.com/TryGhost/Ghost/commit/492f115850e9140046fcfe27031655fdec837822 - Added quick copy-pasteable instruction on modifying theme fixtures - Added notes about possible future improvemetns and current pitfalls when touching theme fixtures
2021-03-01 01:32:20 -05:00
- Commit changed zip file: `git add valid.zip ;... you know the drill :)`
Ideas for future improvements in theme tests:
- Decouple tests from file system as much as possible
- Track contents of what is in "zips" in source control. Right now, having a diff on a binary file is not useful at all
Reference in a new issue Copy permalink