Skip to content

Commit 132652d

Browse files
committed
Added support for Pub packages.
1 parent ff9b6fa commit 132652d

File tree

22 files changed

+908
-4
lines changed

22 files changed

+908
-4
lines changed

docs/content/doc/packages/overview.en-us.md

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The following package managers are currently supported:
3434
| [Maven]({{< relref "doc/packages/maven.en-us.md" >}}) | Java | `mvn`, `gradle` |
3535
| [npm]({{< relref "doc/packages/npm.en-us.md" >}}) | JavaScript | `npm`, `yarn` |
3636
| [NuGet]({{< relref "doc/packages/nuget.en-us.md" >}}) | .NET | `nuget` |
37+
| [Pub]({{< relref "doc/packages/nuget.en-us.md" >}}) | Dart | `dart`, `flutter` |
3738
| [PyPI]({{< relref "doc/packages/pypi.en-us.md" >}}) | Python | `pip`, `twine` |
3839
| [RubyGems]({{< relref "doc/packages/rubygems.en-us.md" >}}) | Ruby | `gem`, `Bundler` |
3940

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
date: "2022-07-31T00:00:00+00:00"
3+
title: "Pub Packages Repository"
4+
slug: "packages/pub"
5+
draft: false
6+
toc: false
7+
menu:
8+
sidebar:
9+
parent: "packages"
10+
name: "Pub"
11+
weight: 90
12+
identifier: "pub"
13+
---
14+
15+
# Pub Packages Repository
16+
17+
Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.
18+
19+
**Table of Contents**
20+
21+
{{< toc >}}
22+
23+
## Requirements
24+
25+
To work with the Pub package registry, you need to use the tools [dart](https://dart.dev/tools/dart-tool) and/or [flutter](https://docs.flutter.dev/reference/flutter-cli).
26+
27+
The following examples use dart.
28+
29+
## Configuring the package registry
30+
31+
To register the package registry and provide credentials, execute:
32+
33+
```shell
34+
dart pub token add https://gitea.example.com/api/packages/{owner}/pub
35+
```
36+
37+
| Placeholder | Description |
38+
| ------------ | ----------- |
39+
| `owner` | The owner of the package. |
40+
41+
You need to provide your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).
42+
43+
## Publish a package
44+
45+
To publish a package, edit the `pubspec.yaml` and add the following line:
46+
47+
```yaml
48+
publish_to: https://gitea.example.com/api/packages/{owner}/pub
49+
```
50+
51+
| Placeholder | Description |
52+
| ------------ | ----------- |
53+
| `owner` | The owner of the package. |
54+
55+
Now you can publish the package by running the following command:
56+
57+
```shell
58+
dart pub publish
59+
```
60+
61+
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
62+
63+
## Install a package
64+
65+
To install a Pub package from the package registry, execute the following command:
66+
67+
```shell
68+
dart pub add {package_name} --hosted-url=https://gitea.example.com/api/packages/{owner}/pub/
69+
```
70+
71+
| Parameter | Description |
72+
| ----------------- | ----------- |
73+
| `owner` | The owner of the package. |
74+
| `package_name` | The package name. |
75+
76+
For example:
77+
78+
```shell
79+
# use latest version
80+
dart pub add mypackage --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
81+
# specify version
82+
dart pub add mypackage:1.0.8 --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
83+
```

docs/content/doc/packages/pypi.en-us.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
sidebar:
99
parent: "packages"
1010
name: "PyPI"
11-
weight: 90
11+
weight: 100
1212
identifier: "pypi"
1313
---
1414

docs/content/doc/packages/rubygems.en-us.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
sidebar:
99
parent: "packages"
1010
name: "RubyGems"
11-
weight: 100
11+
weight: 110
1212
identifier: "rubygems"
1313
---
1414

integrations/api_packages_pub_test.go

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
// Copyright 2022 The Gitea Authors. All rights reserved.
2+
// Use of this source code is governed by a MIT-style
3+
// license that can be found in the LICENSE file.
4+
5+
package integrations
6+
7+
import (
8+
"archive/tar"
9+
"bytes"
10+
"compress/gzip"
11+
"fmt"
12+
"io"
13+
"mime/multipart"
14+
"net/http"
15+
"net/http/httptest"
16+
"testing"
17+
"time"
18+
19+
"code.gitea.io/gitea/models/db"
20+
"code.gitea.io/gitea/models/packages"
21+
"code.gitea.io/gitea/models/unittest"
22+
user_model "code.gitea.io/gitea/models/user"
23+
pub_module "code.gitea.io/gitea/modules/packages/pub"
24+
25+
"github.com/stretchr/testify/assert"
26+
)
27+
28+
func TestPackagePub(t *testing.T) {
29+
defer prepareTestEnv(t)()
30+
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}).(*user_model.User)
31+
32+
token := "Bearer " + getUserToken(t, user.Name)
33+
34+
packageName := "test_package"
35+
packageVersion := "1.0.1"
36+
packageDescription := "Test Description"
37+
38+
filename := fmt.Sprintf("%s.tar.gz", packageVersion)
39+
40+
pubspecContent := `name: ` + packageName + `
41+
version: ` + packageVersion + `
42+
description: ` + packageDescription
43+
44+
var buf bytes.Buffer
45+
zw := gzip.NewWriter(&buf)
46+
archive := tar.NewWriter(zw)
47+
archive.WriteHeader(&tar.Header{
48+
Name: "pubspec.yaml",
49+
Mode: 0o600,
50+
Size: int64(len(pubspecContent)),
51+
})
52+
archive.Write([]byte(pubspecContent))
53+
archive.Close()
54+
zw.Close()
55+
content := buf.Bytes()
56+
57+
root := fmt.Sprintf("/api/packages/%s/pub", user.Name)
58+
59+
t.Run("Upload", func(t *testing.T) {
60+
defer PrintCurrentTest(t)()
61+
62+
uploadURL := root + "/api/packages/versions/new"
63+
64+
req := NewRequest(t, "GET", uploadURL)
65+
MakeRequest(t, req, http.StatusUnauthorized)
66+
67+
req = NewRequest(t, "GET", uploadURL)
68+
addTokenAuthHeader(req, token)
69+
resp := MakeRequest(t, req, http.StatusOK)
70+
71+
type UploadRequest struct {
72+
URL string `json:"url"`
73+
Fields map[string]string `json:"fields"`
74+
}
75+
76+
var result UploadRequest
77+
DecodeJSON(t, resp, &result)
78+
79+
assert.Empty(t, result.Fields)
80+
81+
uploadFile := func(t *testing.T, url string, content []byte, expectedStatus int) *httptest.ResponseRecorder {
82+
body := &bytes.Buffer{}
83+
writer := multipart.NewWriter(body)
84+
part, _ := writer.CreateFormFile("file", "dummy.tar.gz")
85+
_, _ = io.Copy(part, bytes.NewReader(content))
86+
87+
_ = writer.Close()
88+
89+
req := NewRequestWithBody(t, "POST", url, body)
90+
req.Header.Add("Content-Type", writer.FormDataContentType())
91+
addTokenAuthHeader(req, token)
92+
return MakeRequest(t, req, expectedStatus)
93+
}
94+
95+
resp = uploadFile(t, result.URL, content, http.StatusNoContent)
96+
97+
req = NewRequest(t, "GET", resp.Header().Get("Location"))
98+
addTokenAuthHeader(req, token)
99+
MakeRequest(t, req, http.StatusOK)
100+
101+
pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypePub)
102+
assert.NoError(t, err)
103+
assert.Len(t, pvs, 1)
104+
105+
pd, err := packages.GetPackageDescriptor(db.DefaultContext, pvs[0])
106+
assert.NoError(t, err)
107+
assert.NotNil(t, pd.SemVer)
108+
assert.IsType(t, &pub_module.Metadata{}, pd.Metadata)
109+
assert.Equal(t, packageName, pd.Package.Name)
110+
assert.Equal(t, packageVersion, pd.Version.Version)
111+
112+
pfs, err := packages.GetFilesByVersionID(db.DefaultContext, pvs[0].ID)
113+
assert.NoError(t, err)
114+
assert.Len(t, pfs, 1)
115+
assert.Equal(t, filename, pfs[0].Name)
116+
assert.True(t, pfs[0].IsLead)
117+
118+
pb, err := packages.GetBlobByID(db.DefaultContext, pfs[0].BlobID)
119+
assert.NoError(t, err)
120+
assert.Equal(t, int64(len(content)), pb.Size)
121+
122+
resp = uploadFile(t, result.URL, content, http.StatusBadRequest)
123+
})
124+
125+
t.Run("Download", func(t *testing.T) {
126+
defer PrintCurrentTest(t)()
127+
128+
req := NewRequest(t, "GET", fmt.Sprintf("%s/api/packages/%s/%s", root, packageName, packageVersion))
129+
resp := MakeRequest(t, req, http.StatusOK)
130+
131+
type VersionMetadata struct {
132+
Version string `json:"version"`
133+
ArchiveURL string `json:"archive_url"`
134+
Published time.Time `json:"published"`
135+
Pubspec interface{} `json:"pubspec,omitempty"`
136+
}
137+
138+
var result VersionMetadata
139+
DecodeJSON(t, resp, &result)
140+
141+
assert.Equal(t, packageVersion, result.Version)
142+
assert.NotNil(t, result.Pubspec)
143+
144+
req = NewRequest(t, "GET", result.ArchiveURL)
145+
resp = MakeRequest(t, req, http.StatusOK)
146+
147+
assert.Equal(t, content, resp.Body.Bytes())
148+
})
149+
150+
t.Run("EnumeratePackageVersions", func(t *testing.T) {
151+
defer PrintCurrentTest(t)()
152+
153+
req := NewRequest(t, "GET", fmt.Sprintf("%s/api/packages/%s", root, packageName))
154+
resp := MakeRequest(t, req, http.StatusOK)
155+
156+
type VersionMetadata struct {
157+
Version string `json:"version"`
158+
ArchiveURL string `json:"archive_url"`
159+
Published time.Time `json:"published"`
160+
Pubspec interface{} `json:"pubspec,omitempty"`
161+
}
162+
163+
type PackageVersions struct {
164+
Name string `json:"name"`
165+
Latest *VersionMetadata `json:"latest"`
166+
Versions []*VersionMetadata `json:"versions"`
167+
}
168+
169+
var result PackageVersions
170+
DecodeJSON(t, resp, &result)
171+
172+
assert.Equal(t, packageName, result.Name)
173+
assert.NotNil(t, result.Latest)
174+
assert.Len(t, result.Versions, 1)
175+
assert.Equal(t, result.Latest.Version, result.Versions[0].Version)
176+
assert.Equal(t, packageVersion, result.Latest.Version)
177+
assert.NotNil(t, result.Latest.Pubspec)
178+
})
179+
}

models/packages/descriptor.go

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
"code.gitea.io/gitea/modules/packages/maven"
2020
"code.gitea.io/gitea/modules/packages/npm"
2121
"code.gitea.io/gitea/modules/packages/nuget"
22+
"code.gitea.io/gitea/modules/packages/pub"
2223
"code.gitea.io/gitea/modules/packages/pypi"
2324
"code.gitea.io/gitea/modules/packages/rubygems"
2425

@@ -143,6 +144,8 @@ func GetPackageDescriptor(ctx context.Context, pv *PackageVersion) (*PackageDesc
143144
metadata = &npm.Metadata{}
144145
case TypeMaven:
145146
metadata = &maven.Metadata{}
147+
case TypePub:
148+
metadata = &pub.Metadata{}
146149
case TypePyPI:
147150
metadata = &pypi.Metadata{}
148151
case TypeRubyGems:

models/packages/package.go

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ const (
3939
TypeMaven Type = "maven"
4040
TypeNpm Type = "npm"
4141
TypeNuGet Type = "nuget"
42+
TypePub Type = "pub"
4243
TypePyPI Type = "pypi"
4344
TypeRubyGems Type = "rubygems"
4445
)
@@ -62,6 +63,8 @@ func (pt Type) Name() string {
6263
return "npm"
6364
case TypeNuGet:
6465
return "NuGet"
66+
case TypePub:
67+
return "Pub"
6568
case TypePyPI:
6669
return "PyPI"
6770
case TypeRubyGems:
@@ -89,6 +92,8 @@ func (pt Type) SVGName() string {
8992
return "gitea-npm"
9093
case TypeNuGet:
9194
return "gitea-nuget"
95+
case TypePub:
96+
return "gitea-pub"
9297
case TypePyPI:
9398
return "gitea-python"
9499
case TypeRubyGems:

0 commit comments

Comments
 (0)