[rubygems] add inital implementation for /version,/info/{gem}.

This commit is contained in:
Haoyuan (Bill) Xing 2024-05-17 01:24:52 -04:00
parent 45a41811de
commit c8a92a3bc7
No known key found for this signature in database
GPG Key ID: 59E2C2AAF8DCC4F0
3 changed files with 195 additions and 6 deletions

View File

@ -586,6 +586,8 @@ func CommonRoutes() *web.Route {
r.Get("/specs.4.8.gz", rubygems.EnumeratePackages)
r.Get("/latest_specs.4.8.gz", rubygems.EnumeratePackagesLatest)
r.Get("/prerelease_specs.4.8.gz", rubygems.EnumeratePackagesPreRelease)
r.Get("/info/{package}", rubygems.ServePackageInfo)
r.Get("/versions", rubygems.ServeVersionsFile)
r.Get("/quick/Marshal.4.8/{filename}", rubygems.ServePackageSpecification)
r.Get("/gems/{filename}", rubygems.DownloadPackageFile)
r.Group("/api/v1/gems", func() {

View File

@ -6,6 +6,7 @@ package rubygems
import (
"compress/gzip"
"compress/zlib"
"crypto/md5"
"errors"
"fmt"
"io"
@ -22,6 +23,10 @@ import (
packages_service "code.gitea.io/gitea/services/packages"
)
const (
Sep = "---\n"
)
func apiError(ctx *context.Context, status int, obj any) {
helper.LogAndProcessError(ctx, status, obj, func(message string) {
ctx.PlainText(status, message)
@ -92,6 +97,69 @@ func enumeratePackages(ctx *context.Context, filename string, pvs []*packages_mo
}
}
// Serves info file for rubygems.org compatible /info/{gem} file.
// See also https://guides.rubygems.org/rubygems-org-compact-index-api/.
func ServePackageInfo(ctx *context.Context) {
package_name := ctx.Params("package")
versions, err := packages_model.GetVersionsByPackageName(
ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems, package_name)
if err != nil {
apiError(ctx, http.StatusInternalServerError, err)
}
if len(versions) == 0 {
apiError(ctx, http.StatusNotFound, fmt.Sprintf("Could not find package %s", package_name))
}
result, err := buildInfoFileForPackage(ctx, versions)
if err != nil {
apiError(ctx, http.StatusInternalServerError, err)
return
}
ctx.PlainText(http.StatusOK, *result)
}
// ServeVersionsFile creates rubygems.org compatible /versions file.
// See also https://guides.rubygems.org/rubygems-org-compact-index-api/.
func ServeVersionsFile(ctx *context.Context) {
packages, err := packages_model.GetPackagesByType(
ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems)
if err != nil {
apiError(ctx, http.StatusInternalServerError, err)
return
}
result := new(strings.Builder)
result.WriteString(Sep)
for _, pack := range packages {
versions, err := packages_model.GetVersionsByPackageName(
ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems, pack.Name)
if err != nil {
apiError(ctx, http.StatusInternalServerError, err)
}
if len(versions) == 0 {
// No versions left for this package, we should continue.
continue
}
fmt.Fprintf(result, "%s ", pack.Name)
for i, v := range versions {
result.WriteString(v.Version)
if i != len(versions)-1 {
result.WriteString(",")
}
}
info, err := buildInfoFileForPackage(ctx, versions)
if err != nil {
apiError(ctx, http.StatusInternalServerError, err)
}
checksum := md5.Sum([]byte(*info))
fmt.Fprintf(result, " %x\n", checksum)
}
ctx.PlainText(http.StatusOK, result.String())
}
// ServePackageSpecification serves the compressed Gemspec file of a package
func ServePackageSpecification(ctx *context.Context) {
filename := ctx.Params("filename")
@ -227,12 +295,7 @@ func UploadPackageFile(ctx *context.Context) {
return
}
var filename string
if rp.Metadata.Platform == "" || rp.Metadata.Platform == "ruby" {
filename = strings.ToLower(fmt.Sprintf("%s-%s.gem", rp.Name, rp.Version))
} else {
filename = strings.ToLower(fmt.Sprintf("%s-%s-%s.gem", rp.Name, rp.Version, rp.Metadata.Platform))
}
filename := getFullFilename(rp.Name, rp.Version, rp.Metadata.Platform)
_, _, err = packages_service.CreatePackageAndAddFile(
ctx,
@ -300,6 +363,84 @@ func DeletePackage(ctx *context.Context) {
}
}
func writeRequirements(reqs []rubygems_module.VersionRequirement, result *strings.Builder) {
if len(reqs) == 0 {
reqs = []rubygems_module.VersionRequirement{{Restriction: ">=", Version: "0"}}
}
for i, req := range reqs {
if i != 0 {
result.WriteString("&")
}
result.WriteString(req.Restriction)
result.WriteString(" ")
result.WriteString(req.Version)
}
}
func buildRequirementStringFromVersion(ctx *context.Context, version *packages_model.PackageVersion) (string, error) {
pd, err := packages_model.GetPackageDescriptor(ctx, version)
if err != nil {
return "", err
}
metadata := pd.Metadata.(*rubygems_module.Metadata)
dep_requirements := new(strings.Builder)
for i, dep := range metadata.RuntimeDependencies {
if i != 0 {
dep_requirements.WriteString(",")
}
dep_requirements.WriteString(dep.Name)
dep_requirements.WriteString(":")
reqs := dep.Version
writeRequirements(reqs, dep_requirements)
}
full_name := getFullFilename(pd.Package.Name, version.Version, metadata.Platform)
file, err := packages_model.GetFileForVersionByName(ctx, version.ID, full_name, "")
if err != nil {
return "", err
}
blob, err := packages_model.GetBlobByID(ctx, file.BlobID)
if err != nil {
return "", err
}
additional_requirments := new(strings.Builder)
fmt.Fprintf(additional_requirments, "checksum:%s", blob.HashSHA256)
if len(metadata.RequiredRubyVersion) != 0 {
additional_requirments.WriteString(",ruby:")
writeRequirements(metadata.RequiredRubyVersion, additional_requirments)
}
if len(metadata.RequiredRubygemsVersion) != 0 {
additional_requirments.WriteString(",rubygems:")
writeRequirements(metadata.RequiredRubygemsVersion, additional_requirments)
}
return fmt.Sprintf("%s %s|%s", version.Version, dep_requirements, additional_requirments), nil
}
func buildInfoFileForPackage(ctx *context.Context, versions []*packages_model.PackageVersion) (*string, error) {
result := "---\n"
for _, v := range versions {
str, err := buildRequirementStringFromVersion(ctx, v)
if err != nil {
return nil, err
}
result += str
result += "\n"
}
return &result, nil
}
func getFullFilename(gem_name, version, platform string) string {
return strings.ToLower(getFullName(gem_name, version, platform)) + ".gem"
}
func getFullName(gem_name, version, platform string) string {
if platform == "" || platform == "ruby" {
return fmt.Sprintf("%s-%s", gem_name, version)
} else {
return fmt.Sprintf("%s-%s-%s", gem_name, version, platform)
}
}
func getVersionsByFilename(ctx *context.Context, filename string) ([]*packages_model.PackageVersion, error) {
pvs, _, err := packages_model.SearchVersions(ctx, &packages_model.PackageSearchOptions{
OwnerID: ctx.Package.Owner.ID,

View File

@ -5,6 +5,8 @@ package integration
import (
"bytes"
"crypto/md5"
"crypto/sha256"
"encoding/base64"
"fmt"
"mime/multipart"
@ -29,6 +31,9 @@ func TestPackageRubyGems(t *testing.T) {
packageName := "gitea"
packageVersion := "1.0.5"
packageFilename := "gitea-1.0.5.gem"
packageDependency := "runtime-dep:>= 1.2.0&< 2.0"
rubyRequirements := "ruby:>= 2.3.0"
sep := "---"
gemContent, _ := base64.StdEncoding.DecodeString(`bWV0YWRhdGEuZ3oAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAwMDA0NDQAMDAwMDAw
@ -111,6 +116,7 @@ AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA`)
checksum := fmt.Sprintf("%x", sha256.Sum256(gemContent))
root := fmt.Sprintf("/api/packages/%s/rubygems", user.Name)
@ -206,6 +212,30 @@ gAAAAP//MS06Gw==`)
enumeratePackages(t, "prerelease_specs.4.8.gz", b)
})
t.Run("PackageInfo", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()
req := NewRequest(t, "GET", fmt.Sprintf("%s/info/%s", root, packageName)).
AddBasicAuth(user.Name)
resp := MakeRequest(t, req, http.StatusOK)
expected := fmt.Sprintf("%s\n%s %s|checksum:%s,%s\n",
sep, packageVersion, packageDependency, checksum, rubyRequirements)
assert.Equal(t, expected, resp.Body.String())
})
t.Run("Versions", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()
versions_req := NewRequest(t, "GET", fmt.Sprintf("%s/versions", root)).
AddBasicAuth(user.Name)
versions_resp := MakeRequest(t, versions_req, http.StatusOK)
info_req := NewRequest(t, "GET", fmt.Sprintf("%s/info/%s", root, packageName)).
AddBasicAuth(user.Name)
info_resp := MakeRequest(t, info_req, http.StatusOK)
expected := fmt.Sprintf("%s\n%s %s %x\n",
sep, packageName, packageVersion, md5.Sum(info_resp.Body.Bytes()))
assert.Equal(t, expected, string(versions_resp.Body.String()))
})
t.Run("Delete", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()
@ -224,4 +254,20 @@ gAAAAP//MS06Gw==`)
assert.NoError(t, err)
assert.Empty(t, pvs)
})
t.Run("NonExistingGem", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()
req := NewRequest(t, "GET", fmt.Sprintf("%s/info/%s", root, packageName)).
AddBasicAuth(user.Name)
_ = MakeRequest(t, req, http.StatusNotFound)
})
t.Run("EmptyVersions", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()
req := NewRequest(t, "GET", fmt.Sprintf("%s/versions", root)).
AddBasicAuth(user.Name)
resp := MakeRequest(t, req, http.StatusOK)
assert.Equal(t, sep+"\n", string(resp.Body.Bytes()))
})
}