gitea/modules/packages/nuget/metadata_test.go

// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package nuget

import (
	"archive/zip"
	"bytes"
	"maps"
	"slices"
	"testing"

	"github.com/stretchr/testify/assert"
)

const (
	authors                  = "Gitea Authors"
	copyright                = "Package Copyright"
	dependencyID             = "System.Text.Json"
	dependencyVersion        = "5.0.0"
	developmentDependency    = true
	description              = "Package Description"
	iconURL                  = "https://gitea.io/favicon.png"
	id                       = "System.Gitea"
	language                 = "Package Language"
	licenseURL               = "https://gitea.io/license"
	minClientVersion         = "1.0.0.0"
	owners                   = "Package Owners"
	projectURL               = "https://gitea.io"
	readme                   = "Readme"
	releaseNotes             = "Package Release Notes"
	repositoryURL            = "https://gitea.io/gitea/gitea"
	requireLicenseAcceptance = true
	tags                     = "tag_1 tag_2 tag_3"
	targetFramework          = ".NETStandard2.1"
	title                    = "Package Title"
	versionStr               = "1.0.1"
)

const nuspecContent = `<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
	<metadata minClientVersion="` + minClientVersion + `">
		<authors>` + authors + `</authors>
		<copyright>` + copyright + `</copyright>
		<description>` + description + `</description>
		<developmentDependency>true</developmentDependency>
		<iconUrl>` + iconURL + `</iconUrl>
		<id>` + id + `</id>
		<language>` + language + `</language>
		<licenseUrl>` + licenseURL + `</licenseUrl>
		<owners>` + owners + `</owners>
		<projectUrl>` + projectURL + `</projectUrl>
		<readme>README.md</readme>
		<releaseNotes>` + releaseNotes + `</releaseNotes>
		<repository url="` + repositoryURL + `" />
		<requireLicenseAcceptance>true</requireLicenseAcceptance>
		<tags>` + tags + `</tags>
		<title>` + title + `</title>
		<version>` + versionStr + `</version>
		<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>` + versionStr + `</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 := range slices.Sorted(maps.Keys(files)) {
			w, _ := archive.Create(name)
			w.Write([]byte(files[name]))
		}
		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("IgnoresNuspecShadowingRootNuspec", func(t *testing.T) {
		data := createArchive(map[string]string{"/package.nuspec": "", "package.nuspec": nuspecContent})

		np, err := ParsePackageMetaData(bytes.NewReader(data), int64(len(data)))
		assert.NoError(t, err)
		assert.Equal(t, id, np.ID)
	})

	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, authors, np.Metadata.Authors)
		assert.Equal(t, description, np.Metadata.Description)
		assert.Equal(t, id, np.ID)
		assert.Equal(t, versionStr, np.Version)

		assert.Equal(t, copyright, np.Metadata.Copyright)
		assert.Equal(t, developmentDependency, np.Metadata.DevelopmentDependency)
		assert.Equal(t, iconURL, np.Metadata.IconURL)
		assert.Equal(t, language, np.Metadata.Language)
		assert.Equal(t, licenseURL, np.Metadata.LicenseURL)
		assert.Equal(t, minClientVersion, np.Metadata.MinClientVersion)
		assert.Equal(t, owners, np.Metadata.Owners)
		assert.Equal(t, projectURL, np.Metadata.ProjectURL)
		assert.Equal(t, readme, np.Metadata.Readme)
		assert.Equal(t, releaseNotes, np.Metadata.ReleaseNotes)
		assert.Equal(t, repositoryURL, np.Metadata.RepositoryURL)
		assert.Equal(t, requireLicenseAcceptance, np.Metadata.RequireLicenseAcceptance)
		assert.Equal(t, tags, np.Metadata.Tags)
		assert.Equal(t, title, np.Metadata.Title)

		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, versionStr, np.Version)
		assert.Equal(t, description, np.Metadata.Description)
		assert.Empty(t, np.Metadata.Dependencies)
	})
}