xref: /aosp_15_r20/external/spdx-tools/tvloader/parser2v3/parse_annotation_test.go (revision ba677afa8f67bb56cbc794f4d0e378e0da058e16)

// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
package parser2v3

import (
	"testing"

	"github.com/spdx/tools-golang/spdx/v2_3"
)

// ===== Annotation section tests =====
func TestParser2_3FailsIfAnnotationNotSet(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	err := parser.parsePairForAnnotation2_3("Annotator", "Person: John Doe ([email protected])")
	if err == nil {
		t.Errorf("expected error when calling parsePairFromAnnotation2_3 without setting ann pointer")
	}
}

func TestParser2_3FailsIfAnnotationTagUnknown(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	// start with valid annotator
	err := parser.parsePair2_3("Annotator", "Person: John Doe ([email protected])")
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	// parse invalid tag, using parsePairForAnnotation2_3(
	err = parser.parsePairForAnnotation2_3("blah", "oops")
	if err == nil {
		t.Errorf("expected non-nil error, got nil")
	}
}

func TestParser2_3FailsIfAnnotationFieldsWithoutAnnotation(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	err := parser.parsePair2_3("AnnotationDate", "2018-09-15T17:25:00Z")
	if err == nil {
		t.Errorf("expected error when calling parsePair2_3 for AnnotationDate without Annotator first")
	}
	err = parser.parsePair2_3("AnnotationType", "REVIEW")
	if err == nil {
		t.Errorf("expected error when calling parsePair2_3 for AnnotationType without Annotator first")
	}
	err = parser.parsePair2_3("SPDXREF", "SPDXRef-45")
	if err == nil {
		t.Errorf("expected error when calling parsePair2_3 for SPDXREF without Annotator first")
	}
	err = parser.parsePair2_3("AnnotationComment", "comment whatever")
	if err == nil {
		t.Errorf("expected error when calling parsePair2_3 for AnnotationComment without Annotator first")
	}
}

func TestParser2_3CanParseAnnotationTags(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}

	// Annotator without email address
	err := parser.parsePair2_3("Annotator", "Person: John Doe")
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	if parser.ann.Annotator.Annotator != "John Doe" {
		t.Errorf("got %+v for Annotator, expected John Doe", parser.ann.Annotator.Annotator)
	}
	if parser.ann.Annotator.AnnotatorType != "Person" {
		t.Errorf("got %v for AnnotatorType, expected Person", parser.ann.Annotator.AnnotatorType)
	}

	// Annotation Date
	dt := "2018-09-15T17:32:00Z"
	err = parser.parsePair2_3("AnnotationDate", dt)
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	if parser.ann.AnnotationDate != dt {
		t.Errorf("got %v for AnnotationDate, expected %v", parser.ann.AnnotationDate, dt)
	}

	// Annotation type
	aType := "REVIEW"
	err = parser.parsePair2_3("AnnotationType", aType)
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	if parser.ann.AnnotationType != aType {
		t.Errorf("got %v for AnnotationType, expected %v", parser.ann.AnnotationType, aType)
	}

	// SPDX Identifier Reference
	ref := "SPDXRef-30"
	err = parser.parsePair2_3("SPDXREF", ref)
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	deID := parser.ann.AnnotationSPDXIdentifier
	if deID.DocumentRefID != "" || deID.ElementRefID != "30" {
		t.Errorf("got %v for SPDXREF, expected %v", parser.ann.AnnotationSPDXIdentifier, "30")
	}

	// Annotation Comment
	cmt := "this is a comment"
	err = parser.parsePair2_3("AnnotationComment", cmt)
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	if parser.ann.AnnotationComment != cmt {
		t.Errorf("got %v for AnnotationComment, expected %v", parser.ann.AnnotationComment, cmt)
	}
}

func TestParser2_3FailsIfAnnotatorInvalid(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	err := parser.parsePair2_3("Annotator", "John Doe ([email protected])")
	if err == nil {
		t.Errorf("expected non-nil error, got nil")
	}
}

func TestParser2_3FailsIfAnnotatorTypeInvalid(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	err := parser.parsePair2_3("Annotator", "Human: John Doe ([email protected])")
	if err == nil {
		t.Errorf("expected non-nil error, got nil")
	}
}

func TestParser2_3FailsIfAnnotationRefInvalid(t *testing.T) {
	parser := tvParser2_3{
		doc: &v2_3.Document{},
		st:  psCreationInfo2_3,
	}
	// start with valid annotator
	err := parser.parsePair2_3("Annotator", "Person: John Doe ([email protected])")
	if err != nil {
		t.Errorf("expected nil error, got %v", err)
	}
	err = parser.parsePair2_3("SPDXREF", "blah:other")
	if err == nil {
		t.Errorf("expected non-nil error, got nil")
	}
}