Skip to content

APP-7995: Don't allow two module configs to point to same ExePath #4897

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

APP-7995: Don't allow two module configs to point to same ExePath #4897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions module/modmanager/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,11 @@ func (mgr *Manager) add(ctx context.Context, conf config.Module, moduleLogger lo
return nil
}

exists, existingName := mgr.execPathAlreadyExists(&conf)
if exists {
return errors.Errorf("An existing module %s already exists with the same executable path as module %s", existingName, conf.Name)
Copy link
Member

Choose a reason for hiding this comment

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

does this break the entire reconfigure? or does the reconfigure loop continue for other modules

Copy link
Member Author

Choose a reason for hiding this comment

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

It will only stop reconfigure for this module. The reconfigure loop is higher up in the stack, this method is called for each module in the case where there are multiple modules being reconfigured.

So this one module would error, and the existing module that is already configured with the same exepath will keep running.

}

var moduleDataDir string
// only set the module data directory if the parent dir is present (which it might not be during tests)
if mgr.moduleDataParentDir != "" {
Expand Down Expand Up @@ -442,6 +447,11 @@ func (mgr *Manager) Reconfigure(ctx context.Context, conf config.Module) ([]reso
return nil, errors.Errorf("cannot reconfigure module %s as it does not exist", conf.Name)
}

exists, existingName := mgr.execPathAlreadyExists(&conf)
if exists {
return nil, errors.Errorf("An existing module %s already exists with the same executable path as module %s", existingName, conf.Name)
Copy link
Member

Choose a reason for hiding this comment

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

this is happening in reconfigure. thinking through the broader flow here:

  • I create module 1
  • I create module 2 with same exe path
  • module 2 fails to add()
  • now I reconfigure module 1
  • does it error, leaving zero working copies? or is module 2 not in mgr.modules, because it failed to add()?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question. the 2nd module will never be added to mgr.modules in add(). An error is returned during this validation before it is attempted to be started and added to mgr.modules.

So in the case you brought up, module 1 will be added, module 2 will not, when module 1 is reconfigured it will pass this validation because it has no awareness that module 2 is failing to be added.

Copy link
Member Author

Choose a reason for hiding this comment

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

I also did a another round of manual testing and ensured this is the case. Didn't see this issue or anything else in the various scenarios I tested.

}

handledResources := mod.resources
var handledResourceNames []resource.Name
var handledResourceNameStrings []string
Expand Down Expand Up @@ -852,6 +862,20 @@ func (mgr *Manager) getModule(conf resource.Config) (foundMod *module, exists bo
return
}

func (mgr *Manager) execPathAlreadyExists(conf *config.Module) (bool, string) {
var exists bool
var existingName string
mgr.modules.Range(func(_ string, m *module) bool {
if m.cfg.Name != conf.Name && m.cfg.ExePath == conf.ExePath {
exists = true
existingName = m.cfg.Name
return false
}
return true
})
return exists, existingName
}

// CleanModuleDataDirectory removes unexpected folders and files from the robot's module data directory.
// Modules removed from the robot config (even temporarily) will get pruned here.
func (mgr *Manager) CleanModuleDataDirectory() error {
Expand Down
45 changes: 41 additions & 4 deletions module/modmanager/manager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func setupModManager(
func TestModManagerFunctions(t *testing.T) {
// Precompile module copies to avoid timeout issues when building takes too long.
modPath := rtestutils.BuildTempModule(t, "examples/customresources/demos/simplemodule")
modPath2 := rtestutils.BuildTempModule(t, "examples/customresources/demos/simplemodule")
modPath2 := rtestutils.BuildTempModule(t, "examples/customresources/demos/complexmodule")

for _, mode := range []string{"tcp", "unix"} {
t.Run(mode, func(t *testing.T) {
Expand Down Expand Up @@ -207,20 +207,35 @@ func TestModManagerFunctions(t *testing.T) {
t.Log("test AllModels")
modCfg2 := config.Module{
Name: "simple-module2",
ExePath: modPath,
ExePath: modPath2,
Type: config.ModuleTypeLocal,
}
err = mgr.Add(ctx, modCfg2)
test.That(t, err, test.ShouldBeNil)
models := mgr.AllModels()

type expectedModel struct {
model resource.Model
api resource.API
}

expectedMod2Models := []expectedModel{
{resource.NewModel("acme", "demo", "mycounter"), resource.NewAPI("rdk", "component", "generic")},
{resource.NewModel("acme", "demo", "mygizmo"), resource.NewAPI("acme", "component", "gizmo")},
{resource.NewModel("acme", "demo", "mysum"), resource.NewAPI("acme", "service", "summation")},
{resource.NewModel("acme", "demo", "mynavigation"), resource.NewAPI("rdk", "service", "navigation")},
{resource.NewModel("acme", "demo", "mybase"), resource.NewAPI("rdk", "component", "base")},
}

for _, model := range models {
test.That(t, model.Model, test.ShouldResemble, resource.NewModel("acme", "demo", "mycounter"))
test.That(t, model.API, test.ShouldResemble, resource.NewAPI("rdk", "component", "generic"))
switch model.ModuleName {
case "simple-module":
test.That(t, model.FromLocalModule, test.ShouldEqual, false)
test.That(t, model.Model, test.ShouldResemble, resource.NewModel("acme", "demo", "mycounter"))
test.That(t, model.API, test.ShouldResemble, resource.NewAPI("rdk", "component", "generic"))
case "simple-module2":
test.That(t, model.FromLocalModule, test.ShouldEqual, true)
test.That(t, expectedModel{model.Model, model.API}, test.ShouldBeIn, expectedMod2Models)
default:
t.Fail()
t.Logf("test AllModels failure: unrecoginzed moduleName %v", model.ModuleName)
Expand Down Expand Up @@ -301,6 +316,19 @@ func TestModManagerFunctions(t *testing.T) {
test.That(t, err, test.ShouldBeNil)
test.That(t, ret["total"], test.ShouldEqual, 24)

// Reconfigure module with duplicate ExePath.
err = mgr.Add(ctx, modCfg2)
test.That(t, err, test.ShouldBeNil)

modCfg.ExePath = modPath2
_, err = mgr.Reconfigure(ctx, modCfg)
test.That(t, err, test.ShouldNotBeNil)
test.That(t, err.Error(), test.ShouldContainSubstring,
"An existing module simple-module2 already exists with the same executable path as module simple-module")

_, err = mgr.Remove(modCfg2.Name)
test.That(t, err, test.ShouldBeNil)

// Change underlying binary path of module to be a different copy of the same module
modCfg.ExePath = modPath2

Expand Down Expand Up @@ -495,6 +523,15 @@ func TestModManagerValidation(t *testing.T) {
test.That(t, err, test.ShouldNotBeNil)
test.That(t, err.Error(), test.ShouldResemble,
"rpc error: code = DeadlineExceeded desc = context deadline exceeded")

modCfg = config.Module{
Name: "second-module",
ExePath: modPath,
}
err = mgr.Add(ctx, modCfg)
test.That(t, err, test.ShouldNotBeNil)
test.That(t, err.Error(), test.ShouldResemble,
"An existing module complex-module already exists with the same executable path as module second-module")
}

func TestModuleReloading(t *testing.T) {
Expand Down
Loading