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.

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

Better engine package structure #992

Merged
merged 5 commits into from
Oct 23, 2019
Merged

Better engine package structure #992

merged 5 commits into from
Oct 23, 2019

Conversation

zen-dog
Copy link
Contributor

@zen-dog zen-dog commented Oct 23, 2019

Files around plan execution engine have been rearranged: TL;DR:

  • /pkg/engine folder is now home to all plan execution-related files
  • we're now clearly separating between rendering engine and workflow engine
  • plan_execution_engine.go was moved from the instance controller to the /pkg/engine/workflow

This is the new structure in overview:

./pkg/engine/
├── doc.go
├── renderer
│   ├── doc.go
│   ├── engine.go
│   └── engine_test.go
├── task
│   ├── doc.go
│   ├── enhancer.go
│   ├── render.go
│   ├── task.go
│   ├── task_apply.go
│   ├── task_apply_test.go
│   ├── task_delete.go
│   ├── task_delete_test.go
│   ├── task_dummy.go
│   ├── task_dummy_test.go
│   └── task_test.go
└── workflow
│   ├── doc.go
│   ├── engine.go
│   └── engine_test.go
├── types.go

No functional changes were made in this PR.

Files around plan execution engine has been rearranged: TL;DR:
- `/pkg/engine` folder is now home to all plan execution related files
- we're now clearly separating between `rendering` engine and `workflow` engine
- `plan_execution_engine.go` was moved from the instance controller to the `/pkg/engine/workflow`

This is the new structure overview:
```
├── renderer
│   ├── engine.go
│   └── engine_test.go
├── task
│   ├── doc.go
│   ├── enhancer.go
│   ├── render.go
│   ├── task.go
│   ├── task_apply.go
│   ├── task_apply_test.go
│   ├── task_delete.go
│   ├── task_delete_test.go
│   ├── task_dummy.go
│   ├── task_dummy_test.go
│   └── task_test.go
└── workflow
│   ├── engine.go
│   └── engine_test.go
├── metadata.go
```

No functional changes were made in this PR.
@gerred
Copy link
Member

gerred commented Oct 23, 2019

nice refactoring, I love this. makes it really obvious where to look for things.

@gerred
Copy link
Member

gerred commented Oct 23, 2019

Can you stub out small doc.go module docs for each new package as entrypoints into those?

Copy link
Member

@gerred gerred left a comment

Choose a reason for hiding this comment

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

😍 😻

@zen-dog zen-dog merged commit 83dc45e into master Oct 23, 2019
@zen-dog zen-dog deleted the ad/pkg-engine branch October 23, 2019 16:17
alenkacz added a commit that referenced this pull request Oct 24, 2019
What this PR does / why we need it:
This is a follow-up of #992 where we wanted to move enhancer into the rendering package but just did not manage to do that. This PR moves it there plus the metadata from tasker, that is actually rendering metadata so it belongs there.

This also moves template package and health package into the engine and does a bit of renaming.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants