mirror of
https://github.com/go-gitea/gitea
synced 2024-07-07 10:35:48 +00:00
Fixes #30265 1. Read second type of dependencies 2. Render `Description` and `ReleaseNotes` old: ![grafik](https://github.com/go-gitea/gitea/assets/1666336/abac057c-11cd-4d25-b196-01ff899d948e) new: ![grafik](https://github.com/go-gitea/gitea/assets/1666336/35302273-740c-481a-a031-1f80d2d7d336) The NuGet spec does not specify what kind of text can be stored in the description but we can best guess markdown. The official NuGet registry just [converts the newlines to html lines](https://www.nuget.org/packages/rb.Firefox#readme-body-tab). 3. Extract and render the readme. This is the new and better place to store larger text than in the description. The content is markdown. ![grafik](https://github.com/go-gitea/gitea/assets/1666336/f442264e-3735-4b55-92c4-3b89a8ebafb0) --------- Co-authored-by: Benjamin Heemann <benjamin.heemann@raith.de>
188 lines
6.0 KiB
Go
188 lines
6.0 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package nuget
|
|
|
|
import (
|
|
"archive/zip"
|
|
"bytes"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const (
|
|
id = "System.Gitea"
|
|
semver = "1.0.1"
|
|
authors = "Gitea Authors"
|
|
projectURL = "https://gitea.io"
|
|
description = "Package Description"
|
|
releaseNotes = "Package Release Notes"
|
|
readme = "Readme"
|
|
repositoryURL = "https://gitea.io/gitea/gitea"
|
|
targetFramework = ".NETStandard2.1"
|
|
dependencyID = "System.Text.Json"
|
|
dependencyVersion = "5.0.0"
|
|
)
|
|
|
|
const nuspecContent = `<?xml version="1.0" encoding="utf-8"?>
|
|
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
|
<metadata>
|
|
<id>` + id + `</id>
|
|
<version>` + semver + `</version>
|
|
<authors>` + authors + `</authors>
|
|
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
|
<projectUrl>` + projectURL + `</projectUrl>
|
|
<description>` + description + `</description>
|
|
<releaseNotes>` + releaseNotes + `</releaseNotes>
|
|
<repository url="` + repositoryURL + `" />
|
|
<readme>README.md</readme>
|
|
<dependencies>
|
|
<group targetFramework="` + targetFramework + `">
|
|
<dependency id="` + dependencyID + `" version="` + dependencyVersion + `" exclude="Build,Analyzers" />
|
|
</group>
|
|
</dependencies>
|
|
</metadata>
|
|
</package>`
|
|
|
|
const symbolsNuspecContent = `<?xml version="1.0" encoding="utf-8"?>
|
|
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
|
<metadata>
|
|
<id>` + id + `</id>
|
|
<version>` + semver + `</version>
|
|
<description>` + description + `</description>
|
|
<packageTypes>
|
|
<packageType name="SymbolsPackage" />
|
|
</packageTypes>
|
|
<dependencies>
|
|
<group targetFramework="` + targetFramework + `" />
|
|
</dependencies>
|
|
</metadata>
|
|
</package>`
|
|
|
|
func TestParsePackageMetaData(t *testing.T) {
|
|
createArchive := func(files map[string]string) []byte {
|
|
var buf bytes.Buffer
|
|
archive := zip.NewWriter(&buf)
|
|
for name, content := range files {
|
|
w, _ := archive.Create(name)
|
|
w.Write([]byte(content))
|
|
}
|
|
archive.Close()
|
|
return buf.Bytes()
|
|
}
|
|
|
|
t.Run("MissingNuspecFile", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"dummy.txt": ""})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.Nil(t, np)
|
|
assert.ErrorIs(t, err, ErrMissingNuspecFile)
|
|
})
|
|
|
|
t.Run("MissingNuspecFileInRoot", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"sub/package.nuspec": ""})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.Nil(t, np)
|
|
assert.ErrorIs(t, err, ErrMissingNuspecFile)
|
|
})
|
|
|
|
t.Run("InvalidNuspecFile", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": ""})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.Nil(t, np)
|
|
assert.Error(t, err)
|
|
})
|
|
|
|
t.Run("InvalidPackageId", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": `<?xml version="1.0" encoding="utf-8"?>
|
|
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
|
<metadata></metadata>
|
|
</package>`})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.Nil(t, np)
|
|
assert.ErrorIs(t, err, ErrNuspecInvalidID)
|
|
})
|
|
|
|
t.Run("InvalidPackageVersion", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": `<?xml version="1.0" encoding="utf-8"?>
|
|
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
|
<metadata>
|
|
<id>` + id + `</id>
|
|
</metadata>
|
|
</package>`})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.Nil(t, np)
|
|
assert.ErrorIs(t, err, ErrNuspecInvalidVersion)
|
|
})
|
|
|
|
t.Run("MissingReadme", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": nuspecContent})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, np)
|
|
assert.Empty(t, np.Metadata.Readme)
|
|
})
|
|
|
|
t.Run("Dependency Package", func(t *testing.T) {
|
|
data := createArchive(map[string]string{
|
|
"package.nuspec": nuspecContent,
|
|
"README.md": readme,
|
|
})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, np)
|
|
assert.Equal(t, DependencyPackage, np.PackageType)
|
|
|
|
assert.Equal(t, id, np.ID)
|
|
assert.Equal(t, semver, np.Version)
|
|
assert.Equal(t, authors, np.Metadata.Authors)
|
|
assert.Equal(t, projectURL, np.Metadata.ProjectURL)
|
|
assert.Equal(t, description, np.Metadata.Description)
|
|
assert.Equal(t, releaseNotes, np.Metadata.ReleaseNotes)
|
|
assert.Equal(t, readme, np.Metadata.Readme)
|
|
assert.Equal(t, repositoryURL, np.Metadata.RepositoryURL)
|
|
assert.Len(t, np.Metadata.Dependencies, 1)
|
|
assert.Contains(t, np.Metadata.Dependencies, targetFramework)
|
|
deps := np.Metadata.Dependencies[targetFramework]
|
|
assert.Len(t, deps, 1)
|
|
assert.Equal(t, dependencyID, deps[0].ID)
|
|
assert.Equal(t, dependencyVersion, deps[0].Version)
|
|
|
|
t.Run("NormalizedVersion", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": `<?xml version="1.0" encoding="utf-8"?>
|
|
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
|
<metadata>
|
|
<id>test</id>
|
|
<version>1.04.5.2.5-rc.1+metadata</version>
|
|
</metadata>
|
|
</package>`})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, np)
|
|
assert.Equal(t, "1.4.5.2-rc.1", np.Version)
|
|
})
|
|
})
|
|
|
|
t.Run("Symbols Package", func(t *testing.T) {
|
|
data := createArchive(map[string]string{"package.nuspec": symbolsNuspecContent})
|
|
|
|
np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, np)
|
|
assert.Equal(t, SymbolsPackage, np.PackageType)
|
|
|
|
assert.Equal(t, id, np.ID)
|
|
assert.Equal(t, semver, np.Version)
|
|
assert.Equal(t, description, np.Metadata.Description)
|
|
assert.Empty(t, np.Metadata.Dependencies)
|
|
})
|
|
}
|