Mock driver plugin implementation and driver registration #4777

nickethier · 2018-10-12T18:33:05Z

Started by @nickethier - finished by @schmichael

This implements the mock driver as a plugin. All plugins are registered by default, but the mock driver is not registered for release builds.

I created files specifically for registering plugins to hopefully ease management of build tags (as we have a lot of platform specific drivers).

Why not use side-effect imports?

Before this PR drivers registered themselves in init methods and the agent package imported all drivers to register them.

This PR moves registrations into the catalog package and references static variables within the driver packages.

Pros of registration in `catalog` package (new approach)

Registration is near the registrar. Traditionally registration by side effect can be difficult to discover; hopefully putting everything registration related in one place helps.
Tests outside of the agent package would have to manually register the plugins they needed.

Cons of registration in `catalog` package

Drivers cannot import the catalog package. Not an issue today, and hopefully never an issue in the future.
All plugins will be registered by default. May negatively affect test build/runtime performance.

dadgar · 2018-10-15T18:07:19Z

plugins/shared/catalog/testing.go

@@ -1,3 +1,5 @@
+// +build !release


I don't think this is necessary. It shouldn't be imported by anything in the build, only tests. None of our other testing files do this

I started adding it because I did accidently import a testing file into release! Happy to remove though: it's a small thing.

dadgar · 2018-10-15T18:07:50Z

nomad/testing.go

@@ -1,3 +1,5 @@
+// +build !release


Same comment

dadgar · 2018-10-15T18:10:23Z

drivers/rawexec/driver.go

+	}
+)
+
+func PluginLoader(opts map[string]string) (map[string]interface{}, error) {


Put a comment on all three of these public fields

dadgar · 2018-10-15T18:15:20Z

drivers/mock/driver.go

+	select {
+	case <-h.waitCh:
+		d.logger.Debug("not killing task: already exited", "task_name", h.task.Name)
+	case <-time.After(h.killAfter):


This doesn't make sense. It is waiting on unrelated timeouts.

Right? I just ported the existing code and it confused me too: https://github.com/hashicorp/nomad/blob/master/client/driver/mock_driver.go#L380-L402

~~Should I do a grep and switch everything to kill_timeout and remove kill_after?~~

@nickethier pointed out killTimeout isn't used. Removing that one.

Ah I think I see. If not set the kill will happen immediately. So it is just a way to introduce a kill delay.

nickethier · 2018-10-15T19:19:08Z

plugins/shared/catalog/register_testing.go

+
+import "github.com/hashicorp/nomad/drivers/mock"
+
+func init() {


Comment whats going on here

nickethier · 2018-10-15T19:22:27Z

drivers/mock/handle.go

+
+	runFor          time.Duration
+	killAfter       time.Duration
+	killTimeout     time.Duration


killTimeout is not used and can be removed I think

nickethier · 2018-10-15T19:25:11Z

drivers/mock/driver.go

+}
+
+func (d *Driver) DestroyTask(taskID string, force bool) error {
+	//TODO is there anything else to do here?


Check if handle exists, if state == running and !force return error.

If handle does not exist return drivers.ErrTaskNotFound

nickethier · 2018-10-15T19:26:51Z

drivers/mock/driver.go

+}
+
+func (d *Driver) TaskEvents(netctx.Context) (<-chan *drivers.TaskEvent, error) {
+	panic("not implemented")


I would add an eventer like other plugins and plumb it through here.

Do not register mock_driver on release builds.

from #4777 comments

dadgar · 2018-10-15T21:41:30Z

drivers/mock/driver.go

+	select {
+	case <-h.waitCh:
+		d.logger.Debug("not killing task: already exited", "task_name", h.task.Name)
+	case <-time.After(h.killAfter):


Ah I think I see. If not set the kill will happen immediately. So it is just a way to introduce a kill delay.

from #4777 comments

github-actions · 2023-02-26T02:20:54Z

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

nickethier and others added 2 commits October 12, 2018 14:31

drivers/mock: start mock driver implementation

7880c52

drivers/mock: complete plugin impl

7054830

schmichael force-pushed the r-clientv2-mock branch from ae35b59 to 60433ad Compare October 15, 2018 18:00

schmichael changed the title ~~WIP: mock driver plugin implementation~~ Mock driver plugin implementation and automatic driver registration Oct 15, 2018

schmichael changed the title ~~Mock driver plugin implementation and automatic driver registration~~ Mock driver plugin implementation and driver registration Oct 15, 2018

dadgar requested changes Oct 15, 2018

View reviewed changes

nickethier commented Oct 15, 2018

View reviewed changes

schmichael added 2 commits October 15, 2018 14:07

register drivers by default

71af40f

Do not register mock_driver on release builds.

fixup comments, logging, and missing method impls

9bc211f

from #4777 comments

schmichael force-pushed the r-clientv2-mock branch from 60433ad to 9bc211f Compare October 15, 2018 21:28

dadgar approved these changes Oct 15, 2018

View reviewed changes

schmichael merged commit 071ec14 into r-clientv2 Oct 15, 2018

schmichael deleted the r-clientv2-mock branch October 15, 2018 22:18

schmichael added a commit that referenced this pull request Oct 16, 2018

fixup comments, logging, and missing method impls

59940e3

from #4777 comments

schmichael added a commit that referenced this pull request Oct 16, 2018

fixup comments, logging, and missing method impls

4175e90

from #4777 comments

github-actions bot locked as resolved and limited conversation to collaborators Feb 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mock driver plugin implementation and driver registration #4777

Mock driver plugin implementation and driver registration #4777

nickethier commented Oct 12, 2018 •

edited by schmichael

Loading

dadgar Oct 15, 2018

schmichael Oct 15, 2018

dadgar Oct 15, 2018

dadgar Oct 15, 2018

dadgar Oct 15, 2018

schmichael Oct 15, 2018 •

edited

Loading

schmichael Oct 15, 2018

dadgar Oct 15, 2018

nickethier Oct 15, 2018

nickethier Oct 15, 2018

nickethier Oct 15, 2018

nickethier Oct 15, 2018

dadgar Oct 15, 2018

github-actions bot commented Feb 26, 2023


		import "github.com/hashicorp/nomad/drivers/mock"

		func init() {

Mock driver plugin implementation and driver registration #4777

Mock driver plugin implementation and driver registration #4777

Conversation

nickethier commented Oct 12, 2018 • edited by schmichael Loading

Why not use side-effect imports?

Pros of registration in catalog package (new approach)

Cons of registration in catalog package

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schmichael Oct 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 26, 2023

nickethier commented Oct 12, 2018 •

edited by schmichael

Loading

Pros of registration in `catalog` package (new approach)

Cons of registration in `catalog` package

schmichael Oct 15, 2018 •

edited

Loading