arelle-release 2.17.1__py3-none-any.whl → 2.37.71__py3-none-any.whl

tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/ArelleGUITest.csproj

@@ -1,30 +0,0 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>
-    <TargetFramework>net7.0-windows10.0.17763.0</TargetFramework>
-    <ImplicitUsings>enable</ImplicitUsings>
-    <Nullable>enable</Nullable>
-
-    <IsPackable>false</IsPackable>
-
-    <Platforms>AnyCPU;ARM64;x64</Platforms>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <PackageReference Include="FlaUI.TestUtilities" Version="4.0.0" />
-    <PackageReference Include="FlaUI.UIA3.Signed" Version="4.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-    <PackageReference Include="Microsoft.Windows.Compatibility" Version="7.0.3" />
-    <PackageReference Include="NUnit" Version="3.13.3" />
-    <PackageReference Include="NUnit3TestAdapter" Version="4.3.1" />
-    <PackageReference Include="NUnit.Analyzers" Version="3.5.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.2.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-  </ItemGroup>
-
-</Project>

tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/Tests.cs

@@ -1,381 +0,0 @@
-using FlaUI.Core;
-using FlaUI.Core.AutomationElements;
-using FlaUI.Core.Conditions;
-using FlaUI.Core.Definitions;
-using FlaUI.Core.Input;
-using FlaUI.Core.Logging;
-using FlaUI.Core.Tools;
-using FlaUI.Core.WindowsAPI;
-using FlaUI.TestUtilities;
-using FlaUI.UIA3;
-using System.Diagnostics;
-using System.Drawing;
-using System.IO.Compression;
-using System.Text;
-
-namespace ArelleGUITest
-{
-    [TestFixture]
-    public class ArelleGUITests : FlaUITestBase
-    {
-        protected override ApplicationStartMode ApplicationStartMode => ApplicationStartMode.OncePerTest;
-        protected override VideoRecordingMode VideoRecordingMode => VideoRecordingMode.OnePerTest;
-
-        abstract record ExecutionTypeT(string? ArellePath, string ArelleResourcesPath)
-        {
-            public record Source(string? ArellePath, string ArelleResourcesPath, bool UseVirtualEnv, string PythonExe)
-                : ExecutionTypeT(ArellePath, ArelleResourcesPath);
-            public record Build(string? ArellePath, string ArelleResourcesPath) : ExecutionTypeT(ArellePath, ArelleResourcesPath);
-        }
-
-        readonly ExecutionTypeT ExecutionType;
-        Window Window;
-
-        public ArelleGUITests()
-        {
-            bool useSource = Environment.GetEnvironmentVariable("ARELLE_USE_BUILD") != "true";
-            // ARELLE_PATH
-            // source - path to checkout
-            // portable build - path to extract directory
-            // installed build - absent/empty, checks Program Files
-            // convert empty string to null to simplify GitHub Actions conditionals
-            string? arellePathEnv1 = Environment.GetEnvironmentVariable("ARELLE_PATH");
-            string? arellePathEnv = String.IsNullOrEmpty(arellePathEnv1) ? null : arellePathEnv1;
-            string? arelleResourcesPathEnv = Environment.GetEnvironmentVariable("ARELLE_RESOURCES_PATH");
-            const string sourceRoot = @"..\..\..\..\..\..\..\..\..";
-            if (useSource)
-            {
-                bool inTree = arellePathEnv == null;
-                string? arellePath = inTree ? sourceRoot : arellePathEnv;
-                string pythonExe = Environment.GetEnvironmentVariable("ARELLE_PYTHON_EXE") ?? Path.Combine(arellePath!, "venv", "Scripts", "python.exe");
-                ExecutionType = new ExecutionTypeT.Source(
-                    ArellePath: arellePath,
-                    ArelleResourcesPath: arelleResourcesPathEnv ?? Path.GetFullPath(Path.Join(sourceRoot, @"tests\integration_tests\ui_tests\resources")),
-                    UseVirtualEnv: inTree,
-                    PythonExe: pythonExe);
-            }
-            else
-            {
-                if (arelleResourcesPathEnv == null)
-                {
-                    throw new ArgumentNullException("ARELLE_RESOURCES_PATH", "must be specified for non-source runs");
-                }
-                ExecutionType = new ExecutionTypeT.Build(ArellePath: arellePathEnv, ArelleResourcesPath: arelleResourcesPathEnv);
-            }
-        }
-
-        protected override AutomationBase GetAutomation()
-        {
-            Logger.Default.SetLevel(LogLevel.Debug);
-            Retry.DefaultTimeout = TimeSpan.FromSeconds(10);
-            UIA3Automation automation = new()
-            {
-                ConnectionTimeout = TimeSpan.FromSeconds(10),
-                TransactionTimeout = TimeSpan.FromSeconds(10),
-            };
-            return automation;
-        }
-
-        void OutputDataReceived(object sender, DataReceivedEventArgs e)
-        {
-            Logger.Default.Debug("stdout: {0}", e.Data);
-        }
-
-        void ErrorDataReceived(object sender, DataReceivedEventArgs e)
-        {
-            Logger.Default.Debug("stderr: {0}", e.Data);
-        }
-
-        Process StartProcess(string cmd) => StartProcess(cmd, null);
-        Process StartProcess(string cmd, string? args)
-        {
-            ProcessStartInfo startInfo = args == null ? new(cmd) : new(cmd, args)
-            {
-                RedirectStandardOutput = true,
-                RedirectStandardError = true,
-            };
-            Process p = new() { StartInfo = startInfo };
-            p.OutputDataReceived += OutputDataReceived;
-            p.ErrorDataReceived += ErrorDataReceived;
-            p.Start();
-            return p;
-        }
-
-        protected override Application StartApplication()
-        {
-            Directory.CreateDirectory(TestsMediaPath);
-            Application app;
-            switch (ExecutionType)
-            {
-            case ExecutionTypeT.Source executionType:
-            {
-                string arelleGUIPyPath = Path.Combine(executionType.ArellePath!, "arelleGUI.pyw");
-                Process parentProcess = StartProcess(executionType.PythonExe, arelleGUIPyPath);
-                Process? process = executionType.UseVirtualEnv
-                    ? Retry.WhileNull(() =>
-                        Process.GetProcessesByName("python").FirstOrDefault(p => GetParentProcessId(p) == parentProcess.Id),
-                        timeout: TimeSpan.FromSeconds(10), interval: TimeSpan.FromMilliseconds(500)).Result
-                    : parentProcess;
-                app = Retry.WhileException(() => Application.Attach(process)).Result;
-            };
-            break;
-            case ExecutionTypeT.Build executionType:
-            {
-                string programFilesPath = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
-                string arelleGUIExePath = Path.Join(executionType.ArellePath ?? Path.Join(programFilesPath, "Arelle"), "arelleGUI.exe");
-                Process process = StartProcess(arelleGUIExePath);
-                app = Retry.WhileException(() => Application.Attach(process)).Result;
-            };
-            break;
-            default:
-                throw new ArgumentException();
-            }
-            return app;
-        }
-
-        [SetUp]
-        public void Init()
-        {
-            Window = Application.GetMainWindow(Automation);
-        }
-
-        [TearDown]
-        public void LogDebugInformation()
-        {
-            AutomationElement[] descendants = Window.FindAllDescendants();
-            foreach (var d in descendants)
-            {
-                try
-                {
-                    StringBuilder sb = new($"name='{d.Name}' type={d.ControlType}");
-                    if (d.ControlType == ControlType.Window)
-                    {
-                        sb.Append($" modal={d.AsWindow().IsModal}");
-                    }
-                    Logger.Default.Debug(sb.ToString());
-                }
-                // certain properties might not be available on an element, so log and continue
-                catch (Exception e)
-                {
-                    Logger.Default.Error("error dumping element tree", e);
-                }
-            }
-        }
-
-        [Test]
-        public void TestOpen()
-        {
-            string title = Retry.WhileEmpty(() => Window.Title).Result;
-            Assert.That(Window.Title, Does.Contain("arelle"));
-        }
-
-        [Test]
-        public void TestLoadDocument()
-        {
-            Logger.Default.Info("start TestLoadDocument");
-            Keyboard.TypeSimultaneously(VirtualKeyShort.CONTROL, VirtualKeyShort.KEY_O);
-            Wait.UntilInputIsProcessed();
-            Logger.Default.Info("find the Open File dialog");
-            // more reliable than Window.ModalWindows because that searches all descendants whereas this only searches children
-            AutomationElement openFileWindow = Retry.WhileNull(() => Window.FindFirstChild(cf =>
-                cf.ByControlType(ControlType.Window).And(new PropertyCondition(Automation.PropertyLibrary.Window.IsModal, true))),
-                timeout: TimeSpan.FromSeconds(20)).Result;
-            Assert.That(openFileWindow, Is.Not.Null);
-
-            string exampleDocumentPath = Path.Join(ExecutionType.ArelleResourcesPath, "workiva.zip");
-            string exampleDocumentEntryPoint = "wk-20220331.htm";
-            int nFilesInDocumentZip, indexOfEntryPoint;
-            using (ZipArchive archive = ZipFile.OpenRead(exampleDocumentPath))
-            {
-                nFilesInDocumentZip = archive.Entries.Count;
-                indexOfEntryPoint = archive.Entries.Select((e, i) => new { e, i }).Where(x => x.e.Name == exampleDocumentEntryPoint).Single().i;
-            }
-            ComboBox fileNameComboBox = Retry.WhileNull(
-                () => openFileWindow.FindFirstDescendant(cf => cf.ByControlType(ControlType.ComboBox).And(cf.ByName("File name:")))).Result.AsComboBox();
-            Logger.Default.Info("enter path to document");
-            fileNameComboBox.EditableText = exampleDocumentPath;
-            Wait.UntilInputIsProcessed();
-            Logger.Default.Info("open document");
-            Keyboard.Type(VirtualKeyShort.ENTER);
-            Wait.UntilInputIsProcessed();
-
-            Logger.Default.Info("select file inside document archive");
-            AutomationElement selectFileFromArchiveWindow = Retry.WhileNull(
-                () => Window.FindFirstChild(Automation.ConditionFactory.ByControlType(ControlType.Window))).Result;
-            AutomationElement selectFileFromArchivePane = selectFileFromArchiveWindow.FindFirstByXPath("/Pane/Pane/Pane/Pane[1]");
-            Mouse.LeftClick(new Point(
-                (int)(selectFileFromArchivePane.BoundingRectangle.X + selectFileFromArchivePane.BoundingRectangle.Width / 2.0f),
-                (int)(selectFileFromArchivePane.BoundingRectangle.Y
-                // +1 for the header, +0.5 to end up in the middle
-                + selectFileFromArchivePane.BoundingRectangle.Height * (indexOfEntryPoint + 1.5) / (nFilesInDocumentZip + 1))
-            ));
-            Keyboard.Type(VirtualKeyShort.TAB, VirtualKeyShort.ENTER);
-
-            Logger.Default.Info("wait for document to load and UI to populate");
-            // wait for the panes corresponding to tabs and their content to be created,
-            // e.g. Tables/DTS on the left and Fact Table/Fact List on the right.
-            Retry.WhileNull(() => Window.FindFirstByXPath("/Pane/Pane/Pane/Pane/Pane/Pane/Pane"), timeout: TimeSpan.FromMinutes(1), ignoreException: true);
-            AutomationElement iconsAndMainArea = Window.FindFirstByXPath("/Pane/Pane");
-            AutomationElement[] iconsAndMainAreaChildren = iconsAndMainArea.FindAllChildren();
-            AutomationElement mainArea = iconsAndMainAreaChildren[0];
-            AutomationElement icons = iconsAndMainAreaChildren[1];
-            AutomationElement statusBar = iconsAndMainAreaChildren[2];
-            AutomationElement[] mainAreaChildren = mainArea.FindAllChildren();
-            AutomationElement messagesAreaAndTabBar = mainAreaChildren[0];
-            AutomationElement tablesAndFactView = mainAreaChildren[1];
-            AutomationElement messagesArea = messagesAreaAndTabBar.FindFirstChild();
-            AutomationElement[] tablesAndFactViewChildren = tablesAndFactView.FindAllChildren();
-            AutomationElement factViewAndTabBar = tablesAndFactViewChildren[0];
-            AutomationElement tablesAndTabBar = tablesAndFactViewChildren[1];
-            AutomationElement factView = factViewAndTabBar.FindFirstChild();
-            AutomationElement tables = tablesAndTabBar.FindFirstChild();
-
-            Logger.Default.Info("copy presentation structure to clipboard");
-            Mouse.RightClick(tables.BoundingRectangle.Center());
-            Wait.UntilInputIsProcessed();
-            MenuItem copyToClipboardMenuItem = Window.ContextMenu.Items[4];
-            copyToClipboardMenuItem.Click();
-            Wait.UntilInputIsProcessed();
-            Menu copyToClipboardSubMenu = Automation.GetDesktop()
-                .FindAllChildren(cf => cf.ByControlType(ControlType.Menu).And(cf.ByProcessId(Application.ProcessId)))
-                .Select(e => e.AsMenu())
-                .Single(e => e.Items.Length == 3);
-            MenuItem copyTableMenuItem = copyToClipboardSubMenu.Items[2];
-            copyTableMenuItem.Click();
-            Wait.UntilInputIsProcessed();
-            Logger.Default.Info("get clipboard text");
-            string tableText = GetClipboardText();
-            Assert.That(tableText, Is.EqualTo(PRESENTATION_STRUCTURE.Replace("\r", "")));
-        }
-
-        static int? GetParentProcessId(Process process)
-        {
-            return (int?)typeof(Process)
-                    .GetProperty("ParentProcessId", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance)!
-                    .GetGetMethod(true)!
-                    .Invoke(process, null);
-        }
-
-        static string GetClipboardText()
-        {
-            string s = "";
-            Thread t = new(() => { s = System.Windows.Forms.Clipboard.GetText(); });
-            t.SetApartmentState(ApartmentState.STA);
-            t.Start();
-            t.Join();
-            return s;
-        }
-
-        const string PRESENTATION_STRUCTURE =
-@"Table Index
-Cover
-    Cover Page
-Financial Statements
-    CONDENSED CONSOLIDATED BALANCE SHEETS
-        CONDENSED CONSOLIDATED BALANCE SHEETS (Parenthetical)
-    CONDENSED CONSOLIDATED BALANCE SHEETS (Parenthetical)
-    CONDENSED CONSOLIDATED STATEMENTS OF OPERATIONS
-        CONDENSED CONSOLIDATED STATEMENTS OF COMPREHENSIVE LOSS
-            CONDENSED CONSOLIDATED STATEMENTS OF CASH FLOWS
-    CONDENSED CONSOLIDATED STATEMENTS OF COMPREHENSIVE LOSS
-        CONDENSED CONSOLIDATED STATEMENTS OF CASH FLOWS
-    CONSOLIDATED STATEMENTS OF CHANGES IN STOCKHOLDERS' EQUITY
-    CONDENSED CONSOLIDATED STATEMENTS OF CASH FLOWS
-Notes to Financial Statements
-    Organization and Significant Accounting Policies
-        Organization and Significant Accounting Policies (Policies)
-            Organization and Significant Accounting Policies - Accounting Pronouncements (Details)
-    Supplemental Consolidated Balance Sheet Information
-        Supplemental Consolidated Balance Sheet Information (Tables)
-            Supplemental Consolidated Balance Sheet Information - Accrued Expenses and Other Current Liabilities (Details)
-    Cash Equivalents and Marketable Securities
-        Cash Equivalents and Marketable Securities (Tables)
-            Cash Equivalents and Marketable Securities - Schedule of Marketable Securities (Details)
-                Cash Equivalents and Marketable Securities - Schedule of Contractual Maturities (Details)
-    Fair Value Measurements
-        Fair Value Measurements (Tables)
-            Fair Value Measurements (Details)
-    Convertible Senior Notes
-        Convertible Senior Notes (Tables)
-            Convertible Senior Notes (Details)
-                Convertible Senior Notes - Summary of Convertible Debt (Details)
-                    Convertible Senior Notes - Summary of Interest Expense (Details)
-    Commitments and Contingencies
-    Stock-Based Compensation
-        Stock-Based Compensation (Tables)
-            Stock-Based Compensation - Expense (Details)
-                Stock-Based Compensation - Employee Stock Purchase Plan (Details)
-    Revenue Recognition
-        Revenue Recognition (Tables)
-            Revenue Recognition - Disaggregation of Revenue (Details)
-                Revenue Recognition - Deferred Revenue and Transaction Price Allocated to the Remaining Performance Obligations (Details)
-    Net Loss Per Share
-        Net Loss Per Share (Tables)
-            Net Loss Per Share - Earnings Per Share Basic and Diluted (Details)
-                Net Loss Per Share - Antidilutive Securities Excluded from Computation of Earnings Per Share (Details)
-    Intangible Assets
-        Intangible Assets (Tables)
-            Intangible Assets - Intangible Asset Components (Details)
-                Intangible Assets - Amortization of Intangible Assets by Fiscal Year (Details)
-    Subsequent Events
-        Subsequent Events (Details)
-Accounting Policies
-    Organization and Significant Accounting Policies (Policies)
-        Organization and Significant Accounting Policies - Accounting Pronouncements (Details)
-Notes Tables
-    Supplemental Consolidated Balance Sheet Information (Tables)
-        Supplemental Consolidated Balance Sheet Information - Accrued Expenses and Other Current Liabilities (Details)
-    Cash Equivalents and Marketable Securities (Tables)
-        Cash Equivalents and Marketable Securities - Schedule of Marketable Securities (Details)
-            Cash Equivalents and Marketable Securities - Schedule of Contractual Maturities (Details)
-    Fair Value Measurements (Tables)
-        Fair Value Measurements (Details)
-    Convertible Senior Notes (Tables)
-        Convertible Senior Notes (Details)
-            Convertible Senior Notes - Summary of Convertible Debt (Details)
-                Convertible Senior Notes - Summary of Interest Expense (Details)
-    Stock-Based Compensation (Tables)
-        Stock-Based Compensation - Expense (Details)
-            Stock-Based Compensation - Employee Stock Purchase Plan (Details)
-    Revenue Recognition (Tables)
-        Revenue Recognition - Disaggregation of Revenue (Details)
-            Revenue Recognition - Deferred Revenue and Transaction Price Allocated to the Remaining Performance Obligations (Details)
-    Net Loss Per Share (Tables)
-        Net Loss Per Share - Earnings Per Share Basic and Diluted (Details)
-            Net Loss Per Share - Antidilutive Securities Excluded from Computation of Earnings Per Share (Details)
-    Intangible Assets (Tables)
-        Intangible Assets - Intangible Asset Components (Details)
-            Intangible Assets - Amortization of Intangible Assets by Fiscal Year (Details)
-Notes Details
-    Organization and Significant Accounting Policies - Accounting Pronouncements (Details)
-    Supplemental Consolidated Balance Sheet Information - Accrued Expenses and Other Current Liabilities (Details)
-    Cash Equivalents and Marketable Securities - Schedule of Marketable Securities (Details)
-        Cash Equivalents and Marketable Securities - Schedule of Contractual Maturities (Details)
-    Cash Equivalents and Marketable Securities - Schedule of Contractual Maturities (Details)
-    Cash Equivalents and Marketable Securities - Continuous Unrealized Loss Position (Details)
-    Fair Value Measurements (Details)
-    Convertible Senior Notes (Details)
-        Convertible Senior Notes - Summary of Convertible Debt (Details)
-            Convertible Senior Notes - Summary of Interest Expense (Details)
-    Convertible Senior Notes - Summary of Convertible Debt (Details)
-        Convertible Senior Notes - Summary of Interest Expense (Details)
-    Convertible Senior Notes - Summary of Interest Expense (Details)
-    Stock-Based Compensation - Expense (Details)
-        Stock-Based Compensation - Employee Stock Purchase Plan (Details)
-    Stock-Based Compensation - Stock Options (Details)
-        Stock-Based Compensation - Restricted Stock Units (Details)
-    Stock-Based Compensation - Restricted Stock Units (Details)
-    Stock-Based Compensation - Employee Stock Purchase Plan (Details)
-    Revenue Recognition - Disaggregation of Revenue (Details)
-        Revenue Recognition - Deferred Revenue and Transaction Price Allocated to the Remaining Performance Obligations (Details)
-    Revenue Recognition - Deferred Revenue and Transaction Price Allocated to the Remaining Performance Obligations (Details)
-    Net Loss Per Share - Earnings Per Share Basic and Diluted (Details)
-        Net Loss Per Share - Antidilutive Securities Excluded from Computation of Earnings Per Share (Details)
-    Net Loss Per Share - Antidilutive Securities Excluded from Computation of Earnings Per Share (Details)
-    Intangible Assets - Intangible Asset Components (Details)
-        Intangible Assets - Amortization of Intangible Assets by Fiscal Year (Details)
-    Intangible Assets (Details)
-    Intangible Assets - Amortization of Intangible Assets by Fiscal Year (Details)
-    Subsequent Events (Details)";
-    }
-}

tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/Usings.cs

@@ -1 +0,0 @@
-global using NUnit.Framework;

tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest.sln

@@ -1,31 +0,0 @@
-
-Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 17
-VisualStudioVersion = 17.3.32929.385
-MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ArelleGUITest", "ArelleGUITest\ArelleGUITest.csproj", "{0CEE6A09-141B-4DAA-9409-4416A50E60F0}"
-EndProject
-Global
-	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|Any CPU = Debug|Any CPU
-		Debug|x64 = Debug|x64
-		Release|Any CPU = Release|Any CPU
-		Release|x64 = Release|x64
-	EndGlobalSection
-	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Debug|x64.ActiveCfg = Debug|x64
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Debug|x64.Build.0 = Debug|x64
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Release|Any CPU.Build.0 = Release|Any CPU
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Release|x64.ActiveCfg = Release|x64
-		{0CEE6A09-141B-4DAA-9409-4416A50E60F0}.Release|x64.Build.0 = Release|x64
-	EndGlobalSection
-	GlobalSection(SolutionProperties) = preSolution
-		HideSolutionNode = FALSE
-	EndGlobalSection
-	GlobalSection(ExtensibilityGlobals) = postSolution
-		SolutionGuid = {E565DE3C-E22B-46B8-8EDA-E2048FA65336}
-	EndGlobalSection
-EndGlobal

tests/integration_tests/validation/README.md

@@ -1,50 +0,0 @@
-# Running Conformance Suites
-
-### Run conformance suites as a script:
-Run the following to view conformance suite runner options:
-```
-python -m tests.integration_tests.validation.run_conformance_suites --help
-
-  -h, --help            show this help message and exit
-  --all                 Select all configured conformance suites
-  --download-overwrite  Download (and overwrite) selected conformance suite
-                        files
-  --download-missing    Download missing selected conformance suite files
-  --list                List names of all configured conformance suites
-  --log-to-file         Writes logs and results to .txt and .csv files
-  --name NAME           Select only conformance suites with given names, comma
-                        delimited
-  --offline             Run without loading anything from the internet (local
-                        files and cache only)
-  --public              Select all public conformance suites
-  --test                Run selected conformance suite tests
-```
-One of the following options *must* be provided to select which suites to use:
-* `--all`: select all configured conformance suites
-* `--public`: select only those conformance suites available for public download
-* `--name`: provide a comma-delimited list of conformance suite names (use `--list` to see names)
-
-Example that runs the XBRL 2.1 conformance suite:
-```
-python -m tests.integration_tests.validation.run_conformance_suites --test --name xbrl_2_1
-```
-
-### Run conformance suites via pytest:
-The same options for `run_conformance_suites` can be passed through `pytest`.
-
-This example runs all publicly downloadable conformance suites through pytest:
-```
-pytest ./tests/integration_tests/validation/test_conformance_suites.py --public
-```
-
-### Download conformance suite files:
-The files needed to run conformance suite tests can be downloaded by running with `--download-missing` or `--download-overwrite` options.
-```
-python -m tests.integration_tests.validation.run_conformance_suites --download-overwrite --test --name xbrl_2_1
-```
-Download options can be provided alongside `--test` to download before running tests, or alone to download without running tests.
-
-This example attempts to download all configured conformance suites and will output messages for those without public downloads available:
-```
-python -m tests.integration_tests.validation.run_conformance_suites --download-missing --all
-```

tests/integration_tests/validation/conformance_suite_config.py

@@ -1,59 +0,0 @@
-from __future__ import annotations
-
-import itertools
-import os
-from dataclasses import dataclass, field
-
-
-CONFORMANCE_SUITE_PATH_PREFIX = 'tests/resources/conformance_suites'
-
-
-@dataclass(frozen=True)
-class ConformanceSuiteConfig:
-    file: str
-    info_url: str
-    local_filepath: str
-    name: str
-    additional_downloads: dict[str, str] = field(default_factory=dict)
-    additional_plugins_by_prefix: list[tuple[str, frozenset[str]]] = field(default_factory=list)
-    approximate_relative_timing: dict[str, float] = field(default_factory=dict)  # by uri
-    args: list[str] = field(default_factory=list)
-    capture_warnings: bool = True
-    expected_empty_testcases: frozenset[str] = frozenset()
-    expected_failure_ids: frozenset[str] = frozenset()
-    expected_model_errors: frozenset[str] = frozenset()
-    extract_path: str | None = None
-    membership_url: str | None = None
-    plugins: frozenset[str] = frozenset()
-    public_download_url: str | None = None
-    shards: int = 1
-    url_replace: str | None = None
-
-    def __post_init__(self) -> None:
-        redundant_plugins = [(prefix, overlap)
-            for prefix, additional_plugins in self.additional_plugins_by_prefix
-            for overlap in [self.plugins & additional_plugins]
-            if overlap]
-        assert not redundant_plugins, \
-            f'Plugins specified both as default and additional: {redundant_plugins}'
-        overlapping_prefixes = [(p1, p2)
-            for (p1, _), (p2, _) in itertools.combinations(self.additional_plugins_by_prefix, 2)
-            if p1.startswith(p2) or p2.startswith(p1)]
-        assert not overlapping_prefixes, \
-            f'Overlapping prefixes are not supported: {overlapping_prefixes}'
-        assert not (self.shards == 1 and self.additional_plugins_by_prefix), \
-            'Cannot specify additional_plugins_by_prefix with only one shard.'
-        plugin_combinations = len({plugins for _, plugins in self.additional_plugins_by_prefix}) + 1
-        assert plugin_combinations <= self.shards, \
-            'Too few shards to accommodate the number of plugin combinations:' \
-            f' combinations={plugin_combinations} shards={self.shards}'
-
-    @property
-    def prefixed_extract_filepath(self) -> str | None:
-        if self.extract_path is None:
-            return None
-        return os.path.join(CONFORMANCE_SUITE_PATH_PREFIX, self.extract_path)
-
-    @property
-    def prefixed_local_filepath(self) -> str:
-        return os.path.join(CONFORMANCE_SUITE_PATH_PREFIX, self.local_filepath)

tests/integration_tests/validation/conformance_suite_configs.py

@@ -1,63 +0,0 @@
-from __future__ import annotations
-
-from tests.integration_tests.validation.conformance_suite_config import ConformanceSuiteConfig
-from tests.integration_tests.validation.conformance_suite_configurations.efm_current import config as efm_current
-from tests.integration_tests.validation.conformance_suite_configurations.esef_ixbrl_2021 import config as esef_ixbrl_2021
-from tests.integration_tests.validation.conformance_suite_configurations.esef_ixbrl_2022 import config as esef_ixbrl_2022
-from tests.integration_tests.validation.conformance_suite_configurations.esef_xhtml_2021 import config as esef_xhtml_2021
-from tests.integration_tests.validation.conformance_suite_configurations.esef_xhtml_2022 import config as esef_xhtml_2022
-from tests.integration_tests.validation.conformance_suite_configurations.nl_nt16 import config as nl_nt16
-from tests.integration_tests.validation.conformance_suite_configurations.nl_nt17 import config as nl_nt17
-from tests.integration_tests.validation.conformance_suite_configurations.nl_nt18 import config as nl_nt18
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_2_1 import config as xbrl_2_1
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_calculations_1_1 import config as xbrl_calculations_1_1
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_dimensions_1_0 import config as xbrl_dimensions_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_extensible_enumerations_1_0 import config as xbrl_extensible_enumerations_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_extensible_enumerations_2_0 import config as xbrl_extensible_enumerations_2_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_formula_1_0 import config as xbrl_formula_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_formula_1_0_assertion_severity_2_0 import config as xbrl_formula_1_0_assertion_severity_2_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_formula_1_0_function_registry import config as xbrl_formula_1_0_function_registry
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_ixbrl_1_1 import config as xbrl_ixbrl_1_1
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_link_role_registry_1_0 import config as xbrl_link_role_registry_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_oim_1_0 import config as xbrl_oim_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_table_linkbase_1_0 import config as xbrl_table_linkbase_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_taxonomy_packages_1_0 import config as xbrl_taxonomy_packages_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_transformation_registry_3 import config as xbrl_transformation_registry_3
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_transformation_registry_4 import config as xbrl_transformation_registry_4
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_transformation_registry_5 import config as xbrl_transformation_registry_5
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_utr_malformed_1_0 import configs as xbrl_utr_malformed_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_utr_registry_1_0 import config as xbrl_utr_registry_1_0
-from tests.integration_tests.validation.conformance_suite_configurations.xbrl_utr_structure_1_0 import config as xbrl_utr_structure_1_0
-
-
-ALL_CONFORMANCE_SUITE_CONFIGS: tuple[ConformanceSuiteConfig, ...] = (
-    efm_current,
-    esef_ixbrl_2021,
-    esef_ixbrl_2022,
-    esef_xhtml_2021,
-    esef_xhtml_2022,
-    nl_nt16,
-    nl_nt17,
-    nl_nt18,
-    xbrl_2_1,
-    xbrl_calculations_1_1,
-    xbrl_dimensions_1_0,
-    xbrl_extensible_enumerations_1_0,
-    xbrl_extensible_enumerations_2_0,
-    xbrl_formula_1_0,
-    xbrl_formula_1_0_assertion_severity_2_0,
-    xbrl_formula_1_0_function_registry,
-    xbrl_ixbrl_1_1,
-    xbrl_link_role_registry_1_0,
-    xbrl_oim_1_0,
-    xbrl_table_linkbase_1_0,
-    xbrl_taxonomy_packages_1_0,
-    xbrl_transformation_registry_3,
-    xbrl_transformation_registry_4,
-    xbrl_transformation_registry_5,
-    *xbrl_utr_malformed_1_0,
-    xbrl_utr_registry_1_0,
-    xbrl_utr_structure_1_0,
-)
-
-PUBLIC_CONFORMANCE_SUITE_CONFIGS = tuple(c for c in ALL_CONFORMANCE_SUITE_CONFIGS if c.public_download_url)