Skip to content

Add composor source field #33502

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

Merged
merged 11 commits into from
Feb 28, 2025
9 changes: 6 additions & 3 deletions models/packages/descriptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,12 @@ func GetPackageDescriptor(ctx context.Context, pv *PackageVersion) (*PackageDesc
if err != nil {
return nil, err
}
repository, err := repo_model.GetRepositoryByID(ctx, p.RepoID)
if err != nil && !repo_model.IsErrRepoNotExist(err) {
return nil, err
var repository *repo_model.Repository
if p.RepoID > 0 {
repository, err = repo_model.GetRepositoryByID(ctx, p.RepoID)
if err != nil && !repo_model.IsErrRepoNotExist(err) {
return nil, err
}
}
creator, err := user_model.GetUserByID(ctx, pv.CreatorID)
if err != nil {
Expand Down
22 changes: 20 additions & 2 deletions routers/api/packages/composer/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,15 @@ type PackageMetadataResponse struct {
}

// PackageVersionMetadata contains package metadata
// https://getcomposer.org/doc/05-repositories.md#package
type PackageVersionMetadata struct {
*composer_module.Metadata
Name string `json:"name"`
Version string `json:"version"`
Type string `json:"type"`
Created time.Time `json:"time"`
Dist Dist `json:"dist"`
Source Source `json:"source"`
}

// Dist contains package download information
Expand All @@ -82,6 +84,13 @@ type Dist struct {
Checksum string `json:"shasum"`
}

// Source contains package source information
type Source struct {
URL string `json:"url"`
Type string `json:"type"`
Reference string `json:"reference"`
}

func createPackageMetadataResponse(registryURL string, pds []*packages_model.PackageDescriptor) *PackageMetadataResponse {
versions := make([]*PackageVersionMetadata, 0, len(pds))

Expand All @@ -94,7 +103,7 @@ func createPackageMetadataResponse(registryURL string, pds []*packages_model.Pac
}
}

versions = append(versions, &PackageVersionMetadata{
pkg := PackageVersionMetadata{
Name: pd.Package.Name,
Version: pd.Version.Version,
Type: packageType,
Expand All @@ -105,7 +114,16 @@ func createPackageMetadataResponse(registryURL string, pds []*packages_model.Pac
URL: fmt.Sprintf("%s/files/%s/%s/%s", registryURL, url.PathEscape(pd.Package.LowerName), url.PathEscape(pd.Version.LowerVersion), url.PathEscape(pd.Files[0].File.LowerName)),
Checksum: pd.Files[0].Blob.HashSHA1,
},
})
}
if pd.Repository != nil {
pkg.Source = Source{
URL: pd.Repository.HTMLURL(),
Type: "git",
Reference: pd.Version.Version,
}
}

versions = append(versions, &pkg)
}

return &PackageMetadataResponse{
Expand Down
35 changes: 35 additions & 0 deletions tests/integration/api_packages_composer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
"testing"

"code.gitea.io/gitea/models/db"
"code.gitea.io/gitea/models/packages"

Check failure on line 15 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-backend

ST1019: package "code.gitea.io/gitea/models/packages" is being imported more than once (stylecheck)

Check failure on line 15 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-go-windows

ST1019: package "code.gitea.io/gitea/models/packages" is being imported more than once (stylecheck)

Check failure on line 15 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-go-gogit

ST1019: package "code.gitea.io/gitea/models/packages" is being imported more than once (stylecheck)
packages_model "code.gitea.io/gitea/models/packages"

Check failure on line 16 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-backend

duplicated-imports: Package "code.gitea.io/gitea/models/packages" already imported (revive)

Check failure on line 16 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-go-windows

duplicated-imports: Package "code.gitea.io/gitea/models/packages" already imported (revive)

Check failure on line 16 in tests/integration/api_packages_composer_test.go

View workflow job for this annotation

GitHub Actions / lint-go-gogit

duplicated-imports: Package "code.gitea.io/gitea/models/packages" already imported (revive)
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
composer_module "code.gitea.io/gitea/modules/packages/composer"
Expand Down Expand Up @@ -217,5 +219,38 @@
assert.Equal(t, "4f5fa464c3cb808a1df191dbf6cb75363f8b7072", pkgs[0].Dist.Checksum)
assert.Len(t, pkgs[0].Bin, 1)
assert.Equal(t, packageBin, pkgs[0].Bin[0])

// Test package linked to repository
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeComposer)
assert.NoError(t, err)
assert.Len(t, pvs, 1)

err = packages_model.SetRepositoryLink(db.DefaultContext, pvs[0].ID, repo1.ID)
assert.NoError(t, err)

req = NewRequest(t, "GET", fmt.Sprintf("%s/p2/%s/%s.json", url, vendorName, projectName)).
AddBasicAuth(user.Name)
resp = MakeRequest(t, req, http.StatusOK)

result = composer.PackageMetadataResponse{}
DecodeJSON(t, resp, &result)

assert.Contains(t, result.Packages, packageName)
pkgs = result.Packages[packageName]
assert.Len(t, pkgs, 1)
assert.Equal(t, packageName, pkgs[0].Name)
assert.Equal(t, packageVersion, pkgs[0].Version)
assert.Equal(t, packageType, pkgs[0].Type)
assert.Equal(t, packageDescription, pkgs[0].Description)
assert.Len(t, pkgs[0].Authors, 1)
assert.Equal(t, packageAuthor, pkgs[0].Authors[0].Name)
assert.Equal(t, "zip", pkgs[0].Dist.Type)
assert.Equal(t, "4f5fa464c3cb808a1df191dbf6cb75363f8b7072", pkgs[0].Dist.Checksum)
assert.Len(t, pkgs[0].Bin, 1)
assert.Equal(t, packageBin, pkgs[0].Bin[0])
assert.Equal(t, repo1.HTMLURL(), pkgs[0].Source.URL)
assert.Equal(t, "git", pkgs[0].Source.Type)
assert.Equal(t, packageVersion, pkgs[0].Source.Reference)
})
}
Loading