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.

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

Jump to bottom

fix: import package with same prefix name as the root package #2598

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+39 −7
Open

fix: import package with same prefix name as the root package #2598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
623fbfb
test: import package with same prefix name
leovct Nov 29, 2024
f30d535
test: add `GetAbsoluteLocator` test
leovct Nov 29, 2024
9b65b30
test
leovct Nov 29, 2024
f3a167a
fix: importing package with same prefix name
leovct Nov 29, 2024
eed3599
test: with and without root package id trailing slash
leovct Nov 29, 2024
948f573
fix: typo
leovct Nov 29, 2024
c1fdd37
chore: nit
leovct Nov 29, 2024
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
42 changes: 37 additions & 5 deletions ...gine/startosis_packages/git_package_content_provider/git_package_content_provider_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ package git_package_content_provider

import (
"fmt"
"os"
"path"
"testing"

"github.com/kurtosis-tech/kurtosis/api/golang/core/lib/shared_utils"
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/database_accessors/enclave_db"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/docker_compose_transpiler"
Expand All @@ -12,9 +16,6 @@ import (
"github.com/kurtosis-tech/stacktrace"
"github.com/stretchr/testify/require"
bolt "go.etcd.io/bbolt"
"os"
"path"
"testing"
)

const (
Expand Down Expand Up @@ -600,14 +601,45 @@ func TestGetAbsoluteLocator_AbsoluteLocatorIsInRootPackageButSourceIsNotShouldNo
require.Nil(t, err)
}

func TestGetAbsoluteLocator_ImportPackageWithSamePrefixNameAsRootPackageShouldNotBeBlocked(t *testing.T) {
provider := NewGitPackageContentProvider("", "", NewGitHubPackageAuthProvider(""), nil)

packageId := "github.com/main-package"
locatorOfModuleInWhichThisBuiltInIsBeingCalled := "github.com/main-package-xyz/main.star" // same package prefix
maybeRelativeLocator := "github.com/main-package/file.star"

_, err := provider.GetAbsoluteLocator(packageId, locatorOfModuleInWhichThisBuiltInIsBeingCalled, maybeRelativeLocator, noPackageReplaceOptions)
require.Nil(t, err)
}

func Test_isSamePackageLocalAbsoluteLocator_TestDetectionInSubpath(t *testing.T) {
result := shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/bang/lib.star", "github.com/author/package/main.star", "github.com/author/package/")
// Without root package id trailing slash.
result := shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/bang/lib.star", "github.com/author/package/main.star", "github.com/author/package")
require.True(t, result)

// With root package id trailing slash.
result = shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/bang/lib.star", "github.com/author/package/main.star", "github.com/author/package/")
require.True(t, result)
}

func Test_isSamePackageLocalAbsoluteLocator_TestDetectionInDifferentSubdirectories(t *testing.T) {
result := shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/subdir1/file1.star", "github.com/author/package/subdir2/file2.star", "github.com/author/package/")
// Without root package id trailing slash.
result := shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/subdir1/file1.star", "github.com/author/package/subdir2/file2.star", "github.com/author/package")
require.True(t, result)

// With root package id trailing slash.
result = shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package/subdir1/file1.star", "github.com/author/package/subdir2/file2.star", "github.com/author/package/")
require.True(t, result)
}

func Test_isNotSamePackageLocalAbsoluteLocator_TestImportPackageWithSamePrefixNameAsRootPackages(t *testing.T) {
// Without root package id trailing slash.
result := shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package2/main.star", "github.com/author/package/main.star", "github.com/author/package")
require.False(t, result)

// With root package id trailing slash.
result = shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage("github.com/author/package2/main.star", "github.com/author/package/main.star", "github.com/author/package/")
require.False(t, result)
}

func Test_getPathToPackageRoot(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions ...ainer/server/startosis_engine/startosis_packages/git_package_content_provider/locators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ func isLocalLocator(locator string) bool {
}

func shouldBlockAbsoluteLocatorBecauseIsInTheSameSourceModuleLocatorPackage(relativeOrAbsoluteLocator string, sourceModuleLocator string, rootPackageId string) bool {

// Make sure the root package id ends with a trailing slash.
rootPackageId = strings.TrimSuffix(rootPackageId, "/") + "/"
isSourceModuleInRootPackage := strings.HasPrefix(sourceModuleLocator, rootPackageId)
isAbsoluteLocatorInRootPackage := strings.HasPrefix(relativeOrAbsoluteLocator, rootPackageId)

return isSourceModuleInRootPackage && isAbsoluteLocatorInRootPackage
}

Expand Down
Loading