feat(command): add support for creates and consumes properties for co… #505
Conversation
…mmands This adds support for new command properties. creates: You can track all artifacts that will be created by this command using a Path rendered from a PathToken. consumes: You can track all artifacts that will be consumed by a command using a Path rendered from a PathToken. With creates and consumes defined, we provide a contextmanager that enables customizable rollback functionality for project commands. Example: ``` with command.enable_rollback(project_command): project_command(...) ``` This will perform a backup of all "consumed" artifacts, and restore the backup after the run. Furthermore, all created artifacts will be deleted. You can customize this behavior, by providing custom Callables for the 3 stages: - backup - restore - prune
Codecov ReportBase: 50.89% // Head: 50.74% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #505 +/- ##
==========================================
- Coverage 50.89% 50.74% -0.15%
==========================================
Files 124 124
Lines 8107 8207 +100
Branches 1254 1274 +20
==========================================
+ Hits 4126 4165 +39
- Misses 3822 3882 +60
- Partials 159 160 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| project = project_command.project | ||
|
|
||
| for created in command.creates: | ||
| created_path = created.render(project=project) |
There was a problem hiding this comment.
Maybe we should add a few sanity checks here. I'm always uneasy when using rm with a renderer.
created_path != '/'
created_path != '/home/'
created_path != '/home/user/'
Hope you get my point 😆
There was a problem hiding this comment.
Agreed. I'm in the same boat.
Imho it should even be restricted to project.builddir.
benchbuild/command.py
Outdated
| creates: tp.Optional[tp.List[PathToken]] = None, | ||
| consumes: tp.Optional[tp.List[PathToken]] = None, |
There was a problem hiding this comment.
I'm not sure if only PathToken gives a easy to user interface here. If I did not miss something I need to always create a const string token here? Would be taking Union[PathToken, str] be ok and convert the str automatically?
Maybe this is not correct and we do have to prefix every path with the source root?
However, this would introduce quite a lot of duplication.
There was a problem hiding this comment.
The ConstStr should not be necessary. I would expect the PathToken to begin with a SourceRoot or ProjectRoot most of the time. If you provide a str, what should the default behavior be? I would be ok with "default to ProjectRoot."
This makes the protocol for PathToken explicit in the sense that we now require dedicated properties and methods for the unrendered and rendered version of the token. If a rendered version of a token is requested by the user or the API that cannot be provided yet, an error is logged and the unrendered version will be returned. For tokens that require information about a project, make sure to wrap your existing Command with a ProjectCommand.
…mmands
This adds support for new command properties.
creates:
You can track all artifacts that will be created by this command using a Path rendered from a PathToken.
consumes:
You can track all artifacts that will be consumed by a command using a Path rendered from a PathToken.
With creates and consumes defined, we provide a contextmanager that enables customizable rollback functionality for project commands.
Example:
This will perform a backup of all "consumed" artifacts, and restore the backup after the run. Furthermore, all created artifacts will be deleted. You can customize this behavior, by providing custom Callables for the 3 stages:
- backup
- restore
- prune