Gitea/modules/citation/cff_test.go

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

package citation

import (
	"strings"
	"testing"

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

func TestFormatCFF(t *testing.T) {
	cases := []struct{ cff, apa, bibtex string }{
		{
			cff: `title: Overridden
message: &mit MIT
authors: [{family-names: Haines, given-names: Robert}, {name: "The {curly_braces} Collective"}]
title: "Software that uses the following symbols: &, %, $, #"
version: 2024-01-16
license: [*mit, Apache-2.0]
date-released: 2024-01-16
`,
			apa: "Haines, R., & The {curly_braces} Collective. (2024). Software that uses the following symbols: &, %, $, # (Version 2024-01-16) [Computer software]",
			bibtex: `@software{Haines_Software_that_uses_2024,
author = {Haines, Robert and {The \{curly\_braces\} Collective}},
license = {["MIT", "Apache-2.0"]},
month = jan,
title = {{Software that uses the following symbols: \&, \%, \$, \#}},
version = {2024-01-16},
year = {2024}
}`,
		},
		{
			cff: `authors:
  - family-names: Smith
    given-names: Arfon M.
title: "Software citation principles"
license: MIT
preferred-citation:
  authors:
    - family-names: Smith
      given-names: A. M.
    - name: "FORCE11 Software Citation Working Group"
  doi: "10.7717/peerj-cs.86"
  journal: "PeerJ Computer Science"
  month: 9
  start: e86
  title: "Software citation principles"
  type: article
  volume: 2
  issue: 123
  year: 2016
  publisher:
    - name: The Open Journal
`,
			apa: "Smith, A. M., & FORCE11 Software Citation Working Group. (2016). Software citation principles. PeerJ Computer Science, 2(123), e86. https://doi.org/10.7717/peerj-cs.86",
			bibtex: `@article{Smith_Software_citation_principles_2016,
author = {Smith, A. M. and {FORCE11 Software Citation Working Group}},
doi = {10.7717/peerj-cs.86},
journal = {PeerJ Computer Science},
month = sep,
number = {123},
pages = {e86},
title = {{Software citation principles}},
volume = {2},
year = {2016}
}`,
		},
		{
			cff: `preferred-citation:
  type: conference-paper
  version: 1.10
  title: "Über tools"
  authors:
    - family-names: Ørsted
      given-names: ǰan christian
      name-particle: van
      name-suffix: Jr.
  collection-title: "Proceedings of X & Y"
  conference:
    name: "Conf_2020"
    city: Berlin
    country: DE
    date-start: 30.06.2020
    date-end: 2020-07-02
  start: 10
  end: 20
  editors:
    - affiliation: Press
  editors-series:
    - family-names: Editor
      given-names: Eve
`,
			apa: "van Ørsted, J̌. C., Jr. (2020, June 30–July 2). Über tools (Version 1.10) [Conference paper]. Proceedings of X & Y, 10–20",
			bibtex: `@inproceedings{van_Orsted_Uber_tools_2020,
address = {Berlin, DE},
author = {van Ørsted, Jr., ǰan christian},
booktitle = {Proceedings of X \& Y},
month = jun,
pages = {10--20},
series = {Conf\_2020},
title = {{Über tools}},
year = {2020}
}`,
		},
		{
			cff: `thesis: &thesis {type: phdthesis, title: Thesis}
preferred-citation:
  <<: *thesis
  authors:
    - family-names: Nguyễn
      given-names: Sam
      affiliation: "Uni_A"
  institution: {city: Hanoi}
  license: &loop [*loop]
  status: in-press
  notes: A note
`,
			apa: "Nguyễn, S. (in press). Thesis. [Doctoral dissertation, ]",
			bibtex: `@phdthesis{Nguyn_Thesis_in_press,
author = {Nguyễn, Sam},
note = {A note},
title = {{Thesis}},
year = {in press}
}`,
		},
		{cff: "title: No authors\nauthor:\n  - name: Typo\n"},
		{cff: "title: T\nauthors: [{name: A}]\nmessage: " + strings.Repeat("x", MaxContentSize)},
		{cff: "title: T\nauthors: [{name: A}]\nmessage: &s " + strings.Repeat("x", maxAliasExpansion/2) + "\nlicense: [*s, *s]\n"},
		{cff: "%TAG !e! tag:example.com,2000:\n---\ntitle: T\nauthors: [{name: A}]\n"},
		{cff: "preferred-citation: &m {title: T, name: A, authors: [*m]}\n"},
	}
	for _, tc := range cases {
		t.Run("", func(t *testing.T) {
			t.Parallel()
			apa, bibtex := FormatCFF(tc.cff)
			assert.Equal(t, tc.apa, apa)
			assert.Equal(t, tc.bibtex, bibtex)
		})
	}
}

func TestIsLikelyBibTeX(t *testing.T) {
	assert.True(t, IsLikelyBibTeX("@article{key, title={Title}}"))
	assert.True(t, IsLikelyBibTeX("Inproceedings\n{\n}\n"))
	assert.True(t, IsLikelyBibTeX("% comment\n\n@misc{key}\n% comment\n"))
	assert.False(t, IsLikelyBibTeX("not bib {}"))
}