VR4Medical/ICI/Library/PackageCache/com.unity.xr.interaction.toolkit@42ef3600567b/Tests/Editor/EditorDocumentationTests.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text.RegularExpressions;
using NUnit.Framework;
using UnityEditor.PackageManager;
using UnityEngine;
using UnityEngine.XR.Interaction.Toolkit;

namespace UnityEditor.XR.Interaction.Toolkit.Editor.Tests
{
    [TestFixture]
    class EditorDocumentationTests
    {
        /// <summary>
        /// <see cref="PackageManager.PackageInfo"/> for com.unity.xr.interaction.toolkit.
        /// </summary>
        PackageManager.PackageInfo m_PackageInfo;

        [OneTimeSetUp]
        public void SetUp()
        {
            var assembly = Assembly.Load("Unity.XR.Interaction.Toolkit");
            Assert.That(assembly, Is.Not.Null);

            m_PackageInfo = PackageManager.PackageInfo.FindForAssembly(assembly);
            Assert.That(m_PackageInfo, Is.Not.Null);
            Assert.That(m_PackageInfo.version, Is.Not.Null);
            Assert.That(m_PackageInfo.version, Is.Not.Empty);
        }

        [Test]
        public void HelpURLVersionMatchesPackageVersion()
        {
            var majorMinorVersionString = GetMajorMinor(m_PackageInfo.version);
            Assert.AreEqual(majorMinorVersionString, XRHelpURLConstants.currentDocsVersion);
        }

        [Test]
        public void PackageDependencyLinksToCurrentVersionDependency()
        {
            // Verify that within the documentation, any package references to a specific version
            // matches the dependency versions of this package.

            var documentationDirectory = new DirectoryInfo("Packages/com.unity.xr.interaction.toolkit/Documentation~");
            Assert.That(documentationDirectory, Is.Not.Null);
            Assert.That(documentationDirectory.Exists, Is.True);

            // Create two lists of all package dependencies in the forms:
            // name
            // name@major.minor
            var nameNoVersions = new List<string>(m_PackageInfo.dependencies.Length);
            var nameAndVersions = new List<string>(m_PackageInfo.dependencies.Length);
            nameNoVersions.AddRange(m_PackageInfo.dependencies.Select(dependency => dependency.name));
            nameAndVersions.AddRange(m_PackageInfo.dependencies.Select(dependency => $"{dependency.name}@{GetMajorMinor(dependency)}"));

            // Package name must contain only lowercase letters, digits, hyphens(-), underscores (_), and periods (.)
            // See https://docs.unity3d.com/Manual/cus-naming.html
            // Regex in pattern name@major.minor
            var regex = new Regex(@"com\.unity\.[a-z0-9-_.]+@\d+\.\d+");
            foreach (var nameAndVersion in nameAndVersions)
            {
                Assert.That(regex.IsMatch(nameAndVersion), Is.True);
            }

            foreach (var fileInfo in documentationDirectory.EnumerateFiles("*.md"))
            {
                var lines = File.ReadAllLines(fileInfo.FullName);
                var lineNumber = 0;
                foreach (var line in lines)
                {
                    ++lineNumber;
                    foreach (Match match in regex.Matches(line))
                    {
                        var reference = match.ToString();
                        // Skip requiring external references to specific versions of the package that aren't a package dependency.
                        // This is because we do not have a dependency on com.unity.xr.openxr
                        // but sometimes want to link to a specific version of that package.
                        var referencePackageName = reference.Split('@')[0];
                        if (nameNoVersions.Contains(referencePackageName))
                        {
                            Assert.That(nameAndVersions, Has.Member(reference), $"{reference} in {fileInfo.Name}:{lineNumber} does not match dependency version.");
                        }
                        else
                        {
                            Debug.LogWarning($"{reference} in {fileInfo.Name}:{lineNumber} has a specific version but {referencePackageName} is not a package dependency.");
                        }
                    }
                }
            }
        }

        [Test]
        public void PackageCopyrightUpToDate()
        {
            // Verify that within the package folder that the LICENSE file is current.
            var packageDirectory = new DirectoryInfo("Packages/com.unity.xr.interaction.toolkit");
            Assert.That(packageDirectory, Is.Not.Null);
            Assert.That(packageDirectory.Exists, Is.True);

            var licenseFilePath = Path.Combine(packageDirectory.FullName, "LICENSE.md");
            Assert.That(File.Exists(licenseFilePath), Is.True);

            var copyrightRegex = new Regex(@"copyright © \d+\d+\d+\d+ Unity Technologies");
            var yearRegex = new Regex(@"\d+\d+\d+\d+");

            var lines = File.ReadAllLines(licenseFilePath);
            bool hasCopyrightString = false;
            for (int lineNumber = 0; lineNumber < lines.Length; ++lineNumber)
            {
                var line = lines[lineNumber];
                foreach (Match match in copyrightRegex.Matches(line))
                {
                    hasCopyrightString = true;
                    var yearMatch = yearRegex.Match(match.Value);
                    Assert.That(yearMatch.Success, Is.True);

                    var licenseYear = yearMatch.Value;
                    var currentYear = DateTime.Now.Year.ToString();

                    Assert.AreEqual(currentYear, licenseYear, "Year is out of date in LICENSE.md file.");
                }
            }

            Assert.That(hasCopyrightString, "Correct copyright string not found in LICENSE.md file.");
        }

        static string GetMajorMinor(DependencyInfo dependency) => GetMajorMinor(dependency.version);

        static string GetMajorMinor(string version)
        {
            // Return major.minor from the string.
            // For example, "1.2.3" would return "1.2"
            Assert.That(version, Is.Not.Null);
            Assert.That(version, Is.Not.Empty);
            var secondDotIndex = version.IndexOf('.', version.IndexOf('.') + 1);
            Assert.That(secondDotIndex, Is.GreaterThan(0));
            return version.Substring(0, secondDotIndex);
        }
    }
}