Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 3 additions & 6 deletions cmd/mcp/tools_provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,14 +148,11 @@ func runProviderDelete(ctx context.Context, g *flags.GlobalFlags, name string) e
return err
}

opLock, err := provider.GetProviderOperationLock(devsyConfig.DefaultContext, name)
unlock, err := provider.LockProvider(devsyConfig.DefaultContext, name)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, g.Provider)
if err != nil {
Expand Down
9 changes: 3 additions & 6 deletions cmd/pro/update_provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,11 @@ func (cmd *UpdateProviderCmd) Run(ctx context.Context, args []string) error {
if provider.Source.Internal {
return nil
}
opLock, err := provider2.GetProviderOperationLock(devsyConfig.DefaultContext, provider.Name)
unlock, err := provider2.LockProvider(devsyConfig.DefaultContext, provider.Name)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()
devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
return err
Expand Down
9 changes: 3 additions & 6 deletions cmd/provider/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,11 @@ func (cmd *AddCmd) Run(ctx context.Context, devsyConfig *config.Config, args []s
sort.Strings(names)
}
for _, name := range names {
opLock, lockErr := provider.GetProviderOperationLock(devsyConfig.DefaultContext, name)
unlock, lockErr := provider.LockProviderNamed(devsyConfig.DefaultContext, name)
if lockErr != nil {
return fmt.Errorf("get operation lock for %s: %w", name, lockErr)
return lockErr
}
if lockErr := opLock.Lock(); lockErr != nil {
return fmt.Errorf("acquire operation lock for %s: %w", name, lockErr)
}
defer func() { _ = opLock.Unlock() }()
defer unlock()
}
devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
Expand Down
9 changes: 3 additions & 6 deletions cmd/provider/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,11 @@ func (cmd *DeleteCmd) Run(ctx context.Context, args []string) error {
return fmt.Errorf("specify a provider to delete")
}

opLock, err := provider2.GetProviderOperationLock(devsyConfig.DefaultContext, provider)
unlock, err := provider2.LockProvider(devsyConfig.DefaultContext, provider)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
Expand Down
10 changes: 3 additions & 7 deletions cmd/provider/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"
"os"

"github.com/devsy-org/devsy/cmd/completion"
Expand Down Expand Up @@ -40,14 +39,11 @@ func NewInitCmd(f *flags.GlobalFlags) *cobra.Command {
return err
}

opLock, err := provider2.GetProviderOperationLock(devsyConfig.DefaultContext, name)
unlock, err := provider2.LockProvider(devsyConfig.DefaultContext, name)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
Expand Down
18 changes: 6 additions & 12 deletions cmd/provider/rename.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,17 @@ func (cmd *RenameCmd) Run(ctx context.Context, args []string) error {
return err
}

lock1, err := provider.GetProviderOperationLock(devsyConfig.DefaultContext, names[0])
unlock1, err := provider.LockProviderNamed(devsyConfig.DefaultContext, names[0])
if err != nil {
return fmt.Errorf("get operation lock for %s: %w", names[0], err)
}
if err := lock1.Lock(); err != nil {
return fmt.Errorf("acquire operation lock for %s: %w", names[0], err)
return err
}
defer func() { _ = lock1.Unlock() }()
defer unlock1()

lock2, err := provider.GetProviderOperationLock(devsyConfig.DefaultContext, names[1])
unlock2, err := provider.LockProviderNamed(devsyConfig.DefaultContext, names[1])
if err != nil {
return fmt.Errorf("get operation lock for %s: %w", names[1], err)
}
if err := lock2.Lock(); err != nil {
return fmt.Errorf("acquire operation lock for %s: %w", names[1], err)
return err
}
defer func() { _ = lock2.Unlock() }()
defer unlock2()

devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
Expand Down
9 changes: 3 additions & 6 deletions cmd/provider/set.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,14 @@ func (cmd *SetCmd) Run(ctx context.Context, args []string) error {
if err != nil {
return err
}
opLock, err := provider2.GetProviderOperationLock(
unlock, err := provider2.LockProvider(
devsyConfig.DefaultContext,
providerWithOptions.Config.Name,
)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

devsyConfig, providerWithOptions, err = cmd.loadProviderInContext(
devsyConfig.DefaultContext,
Expand Down
9 changes: 3 additions & 6 deletions cmd/provider/set_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,11 @@ func (cmd *SetSourceCmd) Run(ctx context.Context, devsyConfig *config.Config, ar
}
providerName := args[0]

opLock, err := provider2.GetProviderOperationLock(devsyConfig.DefaultContext, providerName)
unlock, err := provider2.LockProvider(devsyConfig.DefaultContext, providerName)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

devsyConfig, err = config.LoadConfig(devsyConfig.DefaultContext, cmd.Provider)
if err != nil {
Expand Down
11 changes: 3 additions & 8 deletions cmd/provider/use.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package provider

import (
"fmt"

"github.com/devsy-org/devsy/cmd/completion"
"github.com/devsy-org/devsy/cmd/flags"
"github.com/devsy-org/devsy/pkg/config"
Expand All @@ -19,14 +17,11 @@ func UseProvider(contextOverride, providerOverride, name string) error {
if err != nil {
return err
}
opLock, err := provider.GetProviderOperationLock(initial.DefaultContext, name)
unlock, err := provider.LockProvider(initial.DefaultContext, name)
if err != nil {
return fmt.Errorf("get operation lock: %w", err)
}
if err := opLock.Lock(); err != nil {
return fmt.Errorf("acquire operation lock: %w", err)
return err
}
defer func() { _ = opLock.Unlock() }()
defer unlock()

var resolved string
err = config.UpdateConfig(
Expand Down
24 changes: 24 additions & 0 deletions pkg/provider/operationlock.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,30 @@ func GetProviderOperationLock(contextName, providerName string) (*flock.Flock, e
return flock.New(filepath.Join(locksDir, providerName+".provider-operation.lock")), nil
}

// LockProvider acquires the operation lock for providerName in contextName and
// returns the func that releases it. Errors are wrapped as "get operation lock"
// or "acquire operation lock". Callers defer the returned func.
func LockProvider(contextName, providerName string) (func(), error) {
return lockProvider(contextName, providerName, "")
}

// LockProviderNamed is LockProvider with the provider name in the error text
// ("get operation lock for <name>: ...").
func LockProviderNamed(contextName, providerName string) (func(), error) {
return lockProvider(contextName, providerName, " for "+providerName)
}

func lockProvider(contextName, providerName, errSuffix string) (func(), error) {
opLock, err := GetProviderOperationLock(contextName, providerName)
if err != nil {
return nil, fmt.Errorf("get operation lock%s: %w", errSuffix, err)
}
if err := opLock.Lock(); err != nil {
return nil, fmt.Errorf("acquire operation lock%s: %w", errSuffix, err)
}
return func() { _ = opLock.Unlock() }, nil
}

// GetProInstanceOperationLock serializes creation of one Pro host without
// sharing a lock file with provider rename or lifecycle operations.
func GetProInstanceOperationLock(contextName, host string) (*flock.Flock, error) {
Expand Down
44 changes: 44 additions & 0 deletions pkg/provider/operationlock_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package provider

import (
"testing"

"github.com/stretchr/testify/require"
)

func TestLockProviderHoldsLockUntilUnlock(t *testing.T) {
useTempDevsyHome(t)

probe, err := GetProviderOperationLock("default", "same")
require.NoError(t, err)

unlock, err := LockProvider("default", "same")
require.NoError(t, err)

held, err := probe.TryLock()
require.NoError(t, err)
require.False(t, held, "operation lock must be held until unlock is called")

unlock()

acquired, err := probe.TryLock()
require.NoError(t, err)
require.True(t, acquired, "unlock must release the operation lock")
require.NoError(t, probe.Unlock())
}

func TestLockProviderWrapsGetError(t *testing.T) {
useTempDevsyHome(t)

unlock, err := LockProvider("default", "")
require.EqualError(t, err, `get operation lock: invalid provider name ""`)
require.Nil(t, unlock)
}

func TestLockProviderNamedIncludesNameInError(t *testing.T) {
useTempDevsyHome(t)

unlock, err := LockProviderNamed("default", "")
require.EqualError(t, err, `get operation lock for : invalid provider name ""`)
require.Nil(t, unlock)
}
Loading