forgejo/modules/packages/cran/metadata_test.go

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

package cran

import (
	"archive/tar"
	"archive/zip"
	"bytes"
	"compress/gzip"
	"fmt"
	"testing"

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

const (
	packageName    = "gitea"
	packageVersion = "1.0.1"
	author         = "KN4CK3R"
	description    = "Package Description"
	projectURL     = "https://gitea.io"
	license        = "GPL (>= 2)"
)

func createDescription(name, version string) *bytes.Buffer {
	var buf bytes.Buffer
	fmt.Fprintln(&buf, "Package:", name)
	fmt.Fprintln(&buf, "Version:", version)
	fmt.Fprintln(&buf, "Description:", "Package\n\n  Description")
	fmt.Fprintln(&buf, "URL:", projectURL)
	fmt.Fprintln(&buf, "Imports: abc,\n123")
	fmt.Fprintln(&buf, "NeedsCompilation: yes")
	fmt.Fprintln(&buf, "License:", license)
	fmt.Fprintln(&buf, "Author:", author)
	return &buf
}

func TestParsePackage(t *testing.T) {
	t.Run(".tar.gz", func(t *testing.T) {
		createArchive := func(filename string, content []byte) *bytes.Reader {
			var buf bytes.Buffer
			gw := gzip.NewWriter(&buf)
			tw := tar.NewWriter(gw)
			hdr := &tar.Header{
				Name: filename,
				Mode: 0o600,
				Size: int64(len(content)),
			}
			tw.WriteHeader(hdr)
			tw.Write(content)
			tw.Close()
			gw.Close()
			return bytes.NewReader(buf.Bytes())
		}

		t.Run("MissingDescriptionFile", func(t *testing.T) {
			buf := createArchive(
				"dummy.txt",
				[]byte{},
			)

			p, err := ParsePackage(buf, buf.Size())
			assert.Nil(t, p)
			require.ErrorIs(t, err, ErrMissingDescriptionFile)
		})

		t.Run("Valid", func(t *testing.T) {
			buf := createArchive(
				"package/DESCRIPTION",
				createDescription(packageName, packageVersion).Bytes(),
			)

			p, err := ParsePackage(buf, buf.Size())

			assert.NotNil(t, p)
			require.NoError(t, err)

			assert.Equal(t, packageName, p.Name)
			assert.Equal(t, packageVersion, p.Version)
		})
	})

	t.Run(".zip", func(t *testing.T) {
		createArchive := func(filename string, content []byte) *bytes.Reader {
			var buf bytes.Buffer
			archive := zip.NewWriter(&buf)
			w, _ := archive.Create(filename)
			w.Write(content)
			archive.Close()
			return bytes.NewReader(buf.Bytes())
		}

		t.Run("MissingDescriptionFile", func(t *testing.T) {
			buf := createArchive(
				"dummy.txt",
				[]byte{},
			)

			p, err := ParsePackage(buf, buf.Size())
			assert.Nil(t, p)
			require.ErrorIs(t, err, ErrMissingDescriptionFile)
		})

		t.Run("Valid", func(t *testing.T) {
			buf := createArchive(
				"package/DESCRIPTION",
				createDescription(packageName, packageVersion).Bytes(),
			)

			p, err := ParsePackage(buf, buf.Size())
			assert.NotNil(t, p)
			require.NoError(t, err)

			assert.Equal(t, packageName, p.Name)
			assert.Equal(t, packageVersion, p.Version)
		})
	})
}

func TestParseDescription(t *testing.T) {
	t.Run("InvalidName", func(t *testing.T) {
		for _, name := range []string{"123abc", "ab-cd", "ab cd", "ab/cd"} {
			p, err := ParseDescription(createDescription(name, packageVersion))
			assert.Nil(t, p)
			require.ErrorIs(t, err, ErrInvalidName)
		}
	})

	t.Run("InvalidVersion", func(t *testing.T) {
		for _, version := range []string{"1", "1 0", "1.2.3.4.5", "1-2-3-4-5", "1.", "1.0.", "1-", "1-0-"} {
			p, err := ParseDescription(createDescription(packageName, version))
			assert.Nil(t, p)
			require.ErrorIs(t, err, ErrInvalidVersion)
		}
	})

	t.Run("Valid", func(t *testing.T) {
		p, err := ParseDescription(createDescription(packageName, packageVersion))
		require.NoError(t, err)
		assert.NotNil(t, p)

		assert.Equal(t, packageName, p.Name)
		assert.Equal(t, packageVersion, p.Version)
		assert.Equal(t, description, p.Metadata.Description)
		assert.ElementsMatch(t, []string{projectURL}, p.Metadata.ProjectURL)
		assert.ElementsMatch(t, []string{author}, p.Metadata.Authors)
		assert.Equal(t, license, p.Metadata.License)
		assert.ElementsMatch(t, []string{"abc", "123"}, p.Metadata.Imports)
		assert.True(t, p.Metadata.NeedsCompilation)
	})
}