mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 00:20:25 +08:00 
			
		
		
		
	Close #20098, in the NPM registry API, implemented to match what's described by https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search Currently have only implemented the bare minimum to work with the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html). Co-authored-by: Jack Vine <jackv@jack-lemur-suse.cat-prometheus.ts.net> Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
		
			
				
	
	
		
			311 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			311 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2021 The Gitea Authors. All rights reserved.
 | 
						|
// Use of this source code is governed by a MIT-style
 | 
						|
// license that can be found in the LICENSE file.
 | 
						|
 | 
						|
package integration
 | 
						|
 | 
						|
import (
 | 
						|
	"encoding/base64"
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"net/url"
 | 
						|
	"strings"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/models/db"
 | 
						|
	"code.gitea.io/gitea/models/packages"
 | 
						|
	"code.gitea.io/gitea/models/unittest"
 | 
						|
	user_model "code.gitea.io/gitea/models/user"
 | 
						|
	"code.gitea.io/gitea/modules/packages/npm"
 | 
						|
	"code.gitea.io/gitea/modules/setting"
 | 
						|
	"code.gitea.io/gitea/tests"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/assert"
 | 
						|
)
 | 
						|
 | 
						|
func TestPackageNpm(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | 
						|
 | 
						|
	token := fmt.Sprintf("Bearer %s", getTokenForLoggedInUser(t, loginUser(t, user.Name)))
 | 
						|
 | 
						|
	packageName := "@scope/test-package"
 | 
						|
	packageVersion := "1.0.1-pre"
 | 
						|
	packageTag := "latest"
 | 
						|
	packageTag2 := "release"
 | 
						|
	packageAuthor := "KN4CK3R"
 | 
						|
	packageDescription := "Test Description"
 | 
						|
 | 
						|
	data := "H4sIAAAAAAAA/ytITM5OTE/VL4DQelnF+XkMVAYGBgZmJiYK2MRBwNDcSIHB2NTMwNDQzMwAqA7IMDUxA9LUdgg2UFpcklgEdAql5kD8ogCnhwio5lJQUMpLzE1VslJQcihOzi9I1S9JLS7RhSYIJR2QgrLUouLM/DyQGkM9Az1D3YIiqExKanFyUWZBCVQ2BKhVwQVJDKwosbQkI78IJO/tZ+LsbRykxFXLNdA+HwWjYBSMgpENACgAbtAACAAA"
 | 
						|
 | 
						|
	buildUpload := func(version string) string {
 | 
						|
		return `{
 | 
						|
			"_id": "` + packageName + `",
 | 
						|
			"name": "` + packageName + `",
 | 
						|
			"description": "` + packageDescription + `",
 | 
						|
			"dist-tags": {
 | 
						|
			  "` + packageTag + `": "` + version + `"
 | 
						|
			},
 | 
						|
			"versions": {
 | 
						|
			  "` + version + `": {
 | 
						|
				"name": "` + packageName + `",
 | 
						|
				"version": "` + version + `",
 | 
						|
				"description": "` + packageDescription + `",
 | 
						|
				"author": {
 | 
						|
				  "name": "` + packageAuthor + `"
 | 
						|
				},
 | 
						|
				"dist": {
 | 
						|
				  "integrity": "sha512-yA4FJsVhetynGfOC1jFf79BuS+jrHbm0fhh+aHzCQkOaOBXKf9oBnC4a6DnLLnEsHQDRLYd00cwj8sCXpC+wIg==",
 | 
						|
				  "shasum": "aaa7eaf852a948b0aa05afeda35b1badca155d90"
 | 
						|
				}
 | 
						|
			  }
 | 
						|
			},
 | 
						|
			"_attachments": {
 | 
						|
			  "` + packageName + `-` + version + `.tgz": {
 | 
						|
				"data": "` + data + `"
 | 
						|
			  }
 | 
						|
			}
 | 
						|
		  }`
 | 
						|
	}
 | 
						|
 | 
						|
	root := fmt.Sprintf("/api/packages/%s/npm/%s", user.Name, url.QueryEscape(packageName))
 | 
						|
	tagsRoot := fmt.Sprintf("/api/packages/%s/npm/-/package/%s/dist-tags", user.Name, url.QueryEscape(packageName))
 | 
						|
	filename := fmt.Sprintf("%s-%s.tgz", strings.Split(packageName, "/")[1], packageVersion)
 | 
						|
 | 
						|
	t.Run("Upload", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequestWithBody(t, "PUT", root, strings.NewReader(buildUpload(packageVersion)))
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		MakeRequest(t, req, http.StatusCreated)
 | 
						|
 | 
						|
		pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
		assert.NoError(t, err)
 | 
						|
		assert.Len(t, pvs, 1)
 | 
						|
 | 
						|
		pd, err := packages.GetPackageDescriptor(db.DefaultContext, pvs[0])
 | 
						|
		assert.NoError(t, err)
 | 
						|
		assert.NotNil(t, pd.SemVer)
 | 
						|
		assert.IsType(t, &npm.Metadata{}, pd.Metadata)
 | 
						|
		assert.Equal(t, packageName, pd.Package.Name)
 | 
						|
		assert.Equal(t, packageVersion, pd.Version.Version)
 | 
						|
		assert.Len(t, pd.VersionProperties, 1)
 | 
						|
		assert.Equal(t, npm.TagProperty, pd.VersionProperties[0].Name)
 | 
						|
		assert.Equal(t, packageTag, pd.VersionProperties[0].Value)
 | 
						|
 | 
						|
		pfs, err := packages.GetFilesByVersionID(db.DefaultContext, pvs[0].ID)
 | 
						|
		assert.NoError(t, err)
 | 
						|
		assert.Len(t, pfs, 1)
 | 
						|
		assert.Equal(t, filename, pfs[0].Name)
 | 
						|
		assert.True(t, pfs[0].IsLead)
 | 
						|
 | 
						|
		pb, err := packages.GetBlobByID(db.DefaultContext, pfs[0].BlobID)
 | 
						|
		assert.NoError(t, err)
 | 
						|
		assert.Equal(t, int64(192), pb.Size)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("UploadExists", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequestWithBody(t, "PUT", root, strings.NewReader(buildUpload(packageVersion)))
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		MakeRequest(t, req, http.StatusBadRequest)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("Download", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequest(t, "GET", fmt.Sprintf("%s/-/%s/%s", root, packageVersion, filename))
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
		b, _ := base64.StdEncoding.DecodeString(data)
 | 
						|
		assert.Equal(t, b, resp.Body.Bytes())
 | 
						|
 | 
						|
		pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
		assert.NoError(t, err)
 | 
						|
		assert.Len(t, pvs, 1)
 | 
						|
		assert.Equal(t, int64(1), pvs[0].DownloadCount)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("PackageMetadata", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequest(t, "GET", fmt.Sprintf("/api/packages/%s/npm/%s", user.Name, "does-not-exist"))
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		MakeRequest(t, req, http.StatusNotFound)
 | 
						|
 | 
						|
		req = NewRequest(t, "GET", root)
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
		var result npm.PackageMetadata
 | 
						|
		DecodeJSON(t, resp, &result)
 | 
						|
 | 
						|
		assert.Equal(t, packageName, result.ID)
 | 
						|
		assert.Equal(t, packageName, result.Name)
 | 
						|
		assert.Equal(t, packageDescription, result.Description)
 | 
						|
		assert.Contains(t, result.DistTags, packageTag)
 | 
						|
		assert.Equal(t, packageVersion, result.DistTags[packageTag])
 | 
						|
		assert.Equal(t, packageAuthor, result.Author.Name)
 | 
						|
		assert.Contains(t, result.Versions, packageVersion)
 | 
						|
		pmv := result.Versions[packageVersion]
 | 
						|
		assert.Equal(t, fmt.Sprintf("%s@%s", packageName, packageVersion), pmv.ID)
 | 
						|
		assert.Equal(t, packageName, pmv.Name)
 | 
						|
		assert.Equal(t, packageDescription, pmv.Description)
 | 
						|
		assert.Equal(t, packageAuthor, pmv.Author.Name)
 | 
						|
		assert.Equal(t, "sha512-yA4FJsVhetynGfOC1jFf79BuS+jrHbm0fhh+aHzCQkOaOBXKf9oBnC4a6DnLLnEsHQDRLYd00cwj8sCXpC+wIg==", pmv.Dist.Integrity)
 | 
						|
		assert.Equal(t, "aaa7eaf852a948b0aa05afeda35b1badca155d90", pmv.Dist.Shasum)
 | 
						|
		assert.Equal(t, fmt.Sprintf("%s%s/-/%s/%s", setting.AppURL, root[1:], packageVersion, filename), pmv.Dist.Tarball)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("AddTag", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		test := func(t *testing.T, status int, tag, version string) {
 | 
						|
			req := NewRequestWithBody(t, "PUT", fmt.Sprintf("%s/%s", tagsRoot, tag), strings.NewReader(`"`+version+`"`))
 | 
						|
			req = addTokenAuthHeader(req, token)
 | 
						|
			MakeRequest(t, req, status)
 | 
						|
		}
 | 
						|
 | 
						|
		test(t, http.StatusBadRequest, "1.0", packageVersion)
 | 
						|
		test(t, http.StatusBadRequest, "v1.0", packageVersion)
 | 
						|
		test(t, http.StatusNotFound, packageTag2, "1.2")
 | 
						|
		test(t, http.StatusOK, packageTag, packageVersion)
 | 
						|
		test(t, http.StatusOK, packageTag2, packageVersion)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("ListTags", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequest(t, "GET", tagsRoot)
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
		var result map[string]string
 | 
						|
		DecodeJSON(t, resp, &result)
 | 
						|
 | 
						|
		assert.Len(t, result, 2)
 | 
						|
		assert.Contains(t, result, packageTag)
 | 
						|
		assert.Equal(t, packageVersion, result[packageTag])
 | 
						|
		assert.Contains(t, result, packageTag2)
 | 
						|
		assert.Equal(t, packageVersion, result[packageTag2])
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("PackageMetadataDistTags", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequest(t, "GET", root)
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
		var result npm.PackageMetadata
 | 
						|
		DecodeJSON(t, resp, &result)
 | 
						|
 | 
						|
		assert.Len(t, result.DistTags, 2)
 | 
						|
		assert.Contains(t, result.DistTags, packageTag)
 | 
						|
		assert.Equal(t, packageVersion, result.DistTags[packageTag])
 | 
						|
		assert.Contains(t, result.DistTags, packageTag2)
 | 
						|
		assert.Equal(t, packageVersion, result.DistTags[packageTag2])
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("DeleteTag", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		test := func(t *testing.T, status int, tag string) {
 | 
						|
			req := NewRequest(t, "DELETE", fmt.Sprintf("%s/%s", tagsRoot, tag))
 | 
						|
			req = addTokenAuthHeader(req, token)
 | 
						|
			MakeRequest(t, req, status)
 | 
						|
		}
 | 
						|
 | 
						|
		test(t, http.StatusBadRequest, "v1.0")
 | 
						|
		test(t, http.StatusBadRequest, "1.0")
 | 
						|
		test(t, http.StatusOK, "dummy")
 | 
						|
		test(t, http.StatusOK, packageTag2)
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("Search", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		url := fmt.Sprintf("/api/packages/%s/npm/-/v1/search", user.Name)
 | 
						|
 | 
						|
		cases := []struct {
 | 
						|
			Query           string
 | 
						|
			Skip            int
 | 
						|
			Take            int
 | 
						|
			ExpectedTotal   int64
 | 
						|
			ExpectedResults int
 | 
						|
		}{
 | 
						|
			{"", 0, 0, 1, 1},
 | 
						|
			{"", 0, 10, 1, 1},
 | 
						|
			{"gitea", 0, 10, 0, 0},
 | 
						|
			{"test", 0, 10, 1, 1},
 | 
						|
			{"test", 1, 10, 1, 0},
 | 
						|
		}
 | 
						|
 | 
						|
		for i, c := range cases {
 | 
						|
			req := NewRequest(t, "GET", fmt.Sprintf("%s?text=%s&from=%d&size=%d", url, c.Query, c.Skip, c.Take))
 | 
						|
			resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
			var result npm.PackageSearch
 | 
						|
			DecodeJSON(t, resp, &result)
 | 
						|
 | 
						|
			assert.Equal(t, c.ExpectedTotal, result.Total, "case %d: unexpected total hits", i)
 | 
						|
			assert.Len(t, result.Objects, c.ExpectedResults, "case %d: unexpected result count", i)
 | 
						|
		}
 | 
						|
	})
 | 
						|
 | 
						|
	t.Run("Delete", func(t *testing.T) {
 | 
						|
		defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
		req := NewRequestWithBody(t, "PUT", root, strings.NewReader(buildUpload(packageVersion+"-dummy")))
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		MakeRequest(t, req, http.StatusCreated)
 | 
						|
 | 
						|
		req = NewRequest(t, "PUT", root+"/-rev/dummy")
 | 
						|
		MakeRequest(t, req, http.StatusUnauthorized)
 | 
						|
 | 
						|
		req = NewRequest(t, "PUT", root+"/-rev/dummy")
 | 
						|
		req = addTokenAuthHeader(req, token)
 | 
						|
		MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
		t.Run("Version", func(t *testing.T) {
 | 
						|
			defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
			pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
			assert.NoError(t, err)
 | 
						|
			assert.Len(t, pvs, 2)
 | 
						|
 | 
						|
			req := NewRequest(t, "DELETE", fmt.Sprintf("%s/-/%s/%s/-rev/dummy", root, packageVersion, filename))
 | 
						|
			MakeRequest(t, req, http.StatusUnauthorized)
 | 
						|
 | 
						|
			req = NewRequest(t, "DELETE", fmt.Sprintf("%s/-/%s/%s/-rev/dummy", root, packageVersion, filename))
 | 
						|
			req = addTokenAuthHeader(req, token)
 | 
						|
			MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
			pvs, err = packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
			assert.NoError(t, err)
 | 
						|
			assert.Len(t, pvs, 1)
 | 
						|
		})
 | 
						|
 | 
						|
		t.Run("Full", func(t *testing.T) {
 | 
						|
			defer tests.PrintCurrentTest(t)()
 | 
						|
 | 
						|
			pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
			assert.NoError(t, err)
 | 
						|
			assert.Len(t, pvs, 1)
 | 
						|
 | 
						|
			req := NewRequest(t, "DELETE", root+"/-rev/dummy")
 | 
						|
			MakeRequest(t, req, http.StatusUnauthorized)
 | 
						|
 | 
						|
			req = NewRequest(t, "DELETE", root+"/-rev/dummy")
 | 
						|
			req = addTokenAuthHeader(req, token)
 | 
						|
			MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
			pvs, err = packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypeNpm)
 | 
						|
			assert.NoError(t, err)
 | 
						|
			assert.Len(t, pvs, 0)
 | 
						|
		})
 | 
						|
	})
 | 
						|
}
 |