GIS Converter -Unit Tests Projects -Set Aspose License.

Question

GIS Converter -Unit Tests Projects -Set Aspose License.

Dani_S 5,261

Hi Michel,

Thank you very much for your help !!!

I implemented all your remarks from ticket:

https://learn.microsoft.com/en-us/answers/questions/5658212/gis-cli-commands

1,How do I set the Aspose license to all my unit tests in one place ?

2.This the code I used in GisConverter.ConsoleApp

// Apply license once at startup

if (!AsposeLicenseManager.ApplyLicense())

{

Console.Error.WriteLine("⚠️ Failed to apply Aspose license.  Conversions may fail or produce watermarked output.");

Environment.Exit((int)ExitCode.AppError);
}

6.This code I used for manual testings is it a good practice?

warnings.txt

Thanks in advance,

Answer accepted by question author

0 additional answers

Your answer

Answer 1

Michael Le (WICLOUD CORPORATION) 7,795 Microsoft External Staff Moderator

Hello @Dani_S ,

The current approach is okay, but you could also do something like this:

private static void Main(string[] args)
{
    Console.OutputEncoding = System.Text.Encoding.UTF8;
    args = EnsureDebugArgs(args);
    Environment.Exit(Run(args));
}

public static int Run(string[] args)
{
    // apply license FIRST before doing anything else
    if (!AsposeLicenseManager.ApplyLicense())
    {
        Console.Error.WriteLine("failed to apply aspose license.");
        Console.Error.WriteLine("the program cannot continue without a valid license.");
        return (int)ExitCode.AppError; // <-- RETURN the exit code, don't kill the process
    }

    // help flags
    if (args.Length == 0 || args[0] == "help" || args[0] == "--help" || args[0] == "-h")
    {
        ShowHelp();
        return (int)ExitCode.Success;
    }
    if (args[0] == "--help-formats")
    {
        ShowHelpFormats();
        return (int)ExitCode.Success;
    }

    // extract the command from the first argument
    string command = args[0].ToLowerInvariant();

    try
    {
        switch (command)
        {
            case "gis_convert":
                return RunGisConverter(args);
            default:
                Console.WriteLine($"unknown command:  {command}\n");
                ShowHelp();
                return (int)ExitCode.AppError;
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine("error:");
        Console.WriteLine(ex.Message);
        return (int)ExitCode.Unexpected;
    }
}

Happy holidays.

Dani_S 5,261 Reputation points

2025-12-19T03:49:39.8066667+00:00

Hi Michel,

1.I fixed it.

2.Set License is the responsibility of Run method and not the Main method ? Is It ?

3.Can you see how to fix the warnings?

Warnings.txt

4.Updated Program Files

README.md.txt

Program.cs.txt

5.How do I set the Aspose license to all my unit tests project in one place ?

Thanks in advance,

Michael Le (WICLOUD CORPORATION) 7,795 Microsoft External Staff Moderator

Set License is the responsibility of the Run method and not the Main method? Is it?

Yes, that's correct. Run() owns the application logic including argument parsing, validation, and license application.

If you put it in Main(), your tests would bypass the check entirely and behave differently than production code.

Can you see how to fix the warnings?

Your GetOptionalLogArguments() method returns (string, string) but sometimes returns (null, null). The compiler sees this mismatch and warns you.

Fix the return type signature by making both strings explicitly nullable:

static (string? logPath, string? logLevel) GetOptionalLogArguments(string[] args, int searchFromIndex)
{
    if (args == null || args.Length < searchFromIndex + 2) 
        return (null, null);

    for (int i = searchFromIndex; i < args.Length - 1; i++)
    {
        if (string.Equals(args[i], "Log", StringComparison.OrdinalIgnoreCase))
        {
            var knownLevels = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
            {
                "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "ALL", "OFF"
            };

            var pathTokens = new List<string>();
            string? detectedLevel = null; // Explicitly nullable

            for (int j = i + 1; j < args.Length; j++)
            {
                var token = args[j];
                if (knownLevels.Contains(token))
                {
                    detectedLevel = token.ToUpperInvariant();
                    break;
                }
                pathTokens.Add(token);
            }

            var logPath = string.Join(" ", pathTokens).Trim();
            if (string.IsNullOrWhiteSpace(logPath)) 
                return (null, null);

            return (logPath, detectedLevel);
        }
    }
    return (null, null);
}

Update SetLogger to accept nullable parameters:

private static void SetLogger(string? logFilePath, string? logLevel = null)
{
    if (string.IsNullOrWhiteSpace(logFilePath))
    {
        Log.Disable();
        return;
    }

    var path = logFilePath.Trim().Trim('"');
    try
    {
        Log.SetFile(path, logLevel ?? "All");
        Log.Enable();
    }
    catch (Exception ex)
    {
        Console.Error.WriteLine($"⚠️ Warning: logging disabled — could not initialize file logger: {ex.Message}");
        Log.Disable();
    }
}

Fix the null dereference in EnsureDebugArgs where you call .Trim() on a potentially null environment variable:

private static string[] EnsureDebugArgs(string[] args)
{
#if DEBUG
    if (args != null && args.Length >= 6)
        return args;

    var debugTarget = Environment.GetEnvironmentVariable("GISCONVERTER_DEBUG_TARGET");
    if (string.IsNullOrWhiteSpace(debugTarget))
        return args ?? Array.Empty<string>();

    switch (debugTarget.Trim().ToLowerInvariant())
    {
        case "shapefile1":
            return new[] { /* ... */ };
        // Other cases
        default:
            return args ?? Array.Empty<string>();
    }
#else
    return args ?? Array.Empty<string>();
#endif
}

How do I set the Aspose license for all my unit test projects in one place?

Since you're using xUnit and already have [Collection("Logging")] on your test classes, the easiest approach is to use a collection fixture.

Create a fixture class that applies the license once when the collection initializes:

// File: AsposeLicenseFixture.cs in your test project
using GisConverter.Lib.Licensing;
using Xunit;

public class AsposeLicenseFixture : IDisposable
{
    public AsposeLicenseFixture()
    {
        if (!AsposeLicenseManager.ApplyLicense())
        {
            Console.Error.WriteLine("⚠️ Aspose license not available in test environment");
        }
    }

    public void Dispose()
    {
        // Cleanup if needed (usually not required for licensing)
    }
}

Then update your collection definition to use this fixture:

// File: TestCollections.cs
[CollectionDefinition("Logging")]
public class LoggingCollection : ICollectionFixture<AsposeLicenseFixture>
{
    // This class is never instantiated, it's just metadata for xUnit
}

Since you already have [Collection("Logging")] on your test classes, this will automatically apply the license before any tests in that collection run. No changes needed to your individual test methods.

Dani_S 5,261

1.Regarding the warnings, only one warning us left:

Error:

Severity Code Description Project File Line Suppression State Details

Warning (active) CS8625 Cannot convert null literal to non-nullable reference type. GisConverter.ConsoleApp D:\GIT\GitConverterEngine\GisConverter\GitConverter.ConsoleApp\Program.cs 355

Code

    **try**

    **{**

        **ConversionResult result = converter.Convert(gisInputFilePath, detectedSourceFormat, gisTargetFormatOption, outputFolderPath, tempFolderPath);**

        **if (result == null) // here is the warning**

        **{**

            **Console.WriteLine("❌ Conversion finished with no result returned.");**

            **return (int)ExitCode.ConversionFailed;**

        **}**

        **else**

        **{**

            **// Always present timestamps to the user in local time, keep UTC for diagnostics.**

            **var utc = result.TimestampUtc;**

            **var timeLine = ConverterUtils.FormatTimestampForDisplay(utc);**

            **if (result.IsSuccess)**

            **{**

                **Console.WriteLine("✅ Conversion finished successfully.");**

                **Console.WriteLine(timeLine);**

                **if (!string.IsNullOrWhiteSpace(result.Message))**

                    **Console.WriteLine(result.Message);**

                **return (int)ExitCode.Success;**

            **}**

            **else**

            **{**

                **Console.WriteLine("❌ Conversion failed.");**

                **Console.WriteLine(timeLine);**

                **if (!string.IsNullOrWhiteSpace(result.Message))**

                    **Console.WriteLine(result.Message);**

                **return (int)ExitCode.ConversionFailed;**

            **}**

        **}**

    **}**

    **catch (Exception ex)**

    **{**

        **// Defensive: unexpected exceptions from converters**

        **Console.WriteLine("❌ Conversion encountered an unexpected error:");**

        **Console.WriteLine(ex.Message);**

        **return (int)ExitCode.Unexpected;**

    **}**

2.Regarding the license in Tests project , please see:

https://app.screencast.com/HyQu5W9qtA80T

Can you give a full solution for the license for all tests in tests project ?

3.First can you please explain what is LoggingCollection ? when w e used , and how?

and what is the best practice?

4.Where do you suggest to put this class :AsposeLicenseFixture in a new folder, how to call the folder?

5.This class: LoggingCollection is a new one, where to put in my tests project ?

6.I have in GitConverter.TestsApp\Logging\LoggingCollectionDefinition.cs this class

**namespace GisConverter.TestsApp.Logging**

**{**
**/// <summary>**

**/// Test collection that disables parallelization for tests that touch global logging or the filesystem.**

**/// </summary>**

**[CollectionDefinition("Logging", DisableParallelization = true)]**

**public class LoggingCollectionDefinition { }**
**}**

is it duplicated with your LoggingCollection ? if yes how to handle it?

7.What about other tests ? they needed ? they can have other names like

[CollectionDefinition("ConsoleApp")]

[CollectionDefinition("Converters")]

8.When we used [CollectionDefinition("Logging")], for tests that use license only?

9.Tests folders structure:

Dani_S 5,261 Reputation points

2025-12-19T06:25:29.05+00:00

Added the folder structure.
Dani_S 5,261 Reputation points

2025-12-19T06:26:14.9666667+00:00

Hi Michel,

Did you understand my questions?
Michael Le (WICLOUD CORPORATION) 7,795 Reputation points Microsoft External Staff Moderator

2025-12-19T06:59:56.9133333+00:00

Yes, I’ll try to work on this and provide an update soon.
Michael Le (WICLOUD CORPORATION) 7,795 Reputation points Microsoft External Staff Moderator

2025-12-22T05:07:56.2633333+00:00
Regarding the warnings, only one warning is left: CS8625 Cannot convert null literal to non-nullable reference type on the line if (result == null)

If you're unsure or want to be extra safe, change the declaration to ConversionResult? result which tells the compiler you're allowing for null.

ConversionResult? result = converter. Convert(gisInputFilePath, detectedSourceFormat, gisTargetFormatOption, outputFolderPath, tempFolderPath);

Regarding the license in Tests project, can you give a full solution for the license for all tests in tests project?

Create GisConverter.TestsApp/Licensing/AsposeLicenseFixture.cs:

using System; using GisConverter.Lib.Licensing; using Xunit; namespace GisConverter.TestsApp.Licensing { public class AsposeLicenseFixture : IDisposable { public bool LicenseApplied { get; private set; } public AsposeLicenseFixture() { LicenseApplied = AsposeLicenseManager.ApplyLicense(); if (!LicenseApplied) { Console.Error.WriteLine("⚠️ Aspose license not available in test environment."); Console.Error.WriteLine("Tests will run but may produce watermarked output or fail."); } } public void Dispose() { } } }

Then update GisConverter.TestsApp/Logging/LoggingCollectionDefinition.cs:

using GisConverter.TestsApp.Licensing; using Xunit; namespace GisConverter.TestsApp.Logging { [CollectionDefinition("Logging", DisableParallelization = true)] public class LoggingCollectionDefinition : ICollectionFixture<AsposeLicenseFixture> { } }

First can you please explain what is LoggingCollection? When we used, and how? And what is the best practice?

A collection in xUnit groups tests that shouldn't run in parallel. Your LoggingCollectionDefinition does three things: Groups all tests marked with [Collection("Logging")], disables parallel execution for those tests, and provides shared setup via fixtures. Use it for tests that write to shared files, redirect console output, or modify global state. Best practice is to use collections only when needed since parallelization speeds up tests.

For more details, see: https://xunit.net/docs/shared-context#collection-fixture

Questions about LoggingCollection, folder structure, and whether you need multiple collections

Your existing LoggingCollectionDefinition.cs is the right file in the right place. Just add the :ICollectionFixture<AsposeLicenseFixture> line to it. Put AsposeLicenseFixture.cs in your existing Licensing folder.

You don't need separate collections for different folders - one "Logging" collection handles all tests that need the license or touch shared state. Your test classes already have [Collection("Logging")] so you're good.
Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.
Dani_S 5,261 Reputation points

2025-12-22T06:00:56.1933333+00:00

1.Why in Create GisConverter.TestsApp/Licensing/AsposeLicenseFixture.cs , you print to Console , is ok ? where the results will be when the error happened?

2.Then update with GisConverter.TestsApp/Logging/LoggingCollectionDefinition.cs

3.How can I know that no more tests need [Collection("Logging")]?

Does running all tests successfully is a good evidence ?
Michael Le (WICLOUD CORPORATION) 7,795 Reputation points Microsoft External Staff Moderator

2025-12-22T06:13:42.5566667+00:00
It is fine to print to console. You will the message in the VS test explorer output panel.

How can I know that no more tests need [Collection("Logging")]? Does running all tests successfully is a good evidence?

Search your test project for these patterns:

Console.SetOut or Console.SetError - any test class with these needs the attribute

converter.Convert - any test calling aspose converters needs it

Tests writing to log files need it

If all tests pass consistently, that's a good sign. But the safest approach is: any test that redirects console, uses aspose, or writes to shared files should have [Collection("Logging")].

Dani_S 5,261

1.Regarding ConversionResult class, I changed the declaration to ConversionResult? result which tells the compiler you're allowing for null.

Is it OK?

C#

ConversionResult? result = converter.Convert(gisInputFilePath, detectedSourceFormat, gisTargetFormatOption, outputFolderPath, tempFolderPath);

if (result is null)
{
    Console.WriteLine("❌ Conversion finished with no result returned.");
    return (int)ExitCode.ConversionFailed;
}
else

Dani_S 5,261 Reputation points

2025-12-22T09:00:56.4433333+00:00

2.In addition I change all ConversionResult class as follow:

README.md.txt

ConversionResult.cs.txt

3.Does the null addition is ok in this class, because it add a lot of warnings to fix?

Before I fix all this warnings can you please

say if it OK this class ?
Michael Le (WICLOUD CORPORATION) 7,795 Reputation points Microsoft External Staff Moderator

2025-12-22T09:30:32.3533333+00:00
Regarding ConversionResult class, I changed the declaration to ConversionResult? result which tells the compiler you're allowing for null.

Yes, that is fine.

In addition I change all ConversionResult class as follow:

No, keep the factory methods non-nullable. They always construct and return a new instance. Please change them back.

public static ConversionResult Success(string? message = null) => new ConversionResult(ConversionStatus.Success, message ?? string. Empty); public static ConversionResult Failure(string? message = null) => new ConversionResult(ConversionStatus. Failure, message ?? string.Empty);

Everything else looks good.

Dani_S 5,261

1.Regarding the Convert interface is ok?

 ConversionResult? Convert(
     string gisInputFilePath,
     string gisSourceFormatOption,
     string gisTargetFormatOption,
     string outputFolderPath,
     string tempFolderPath);

Dani_S 5,261 Reputation points

2025-12-22T10:01:49.08+00:00

2.No, keep the factory methods non-nullable. They always construct and return a new instance. Please change them back.

Because this a new instance and can't be null ?
Michael Le (WICLOUD CORPORATION) 7,795 Reputation points Microsoft External Staff Moderator

2025-12-23T02:18:13.84+00:00

Before adding ? to any type, you need to ask yourself: "Can this actually be null?"

Regarding the Convert interface is ok?

No, it's not ideal. Your converter implementations always will return a non-null ConversionResult, either Success or Failure.

Because this a new instance and can't be null ?

Yes, exactly. The new keyword creates a new instance of the ConversionResult class. Therefore, it cannot be null.
Dani_S 5,261 Reputation points

2025-12-23T10:21:46.99+00:00

I fixed the signature of IConverter + UniversalGisConverter.

Thank you very much for your help and details explanations.

You are a very professional programmer !!!.

Share via

GIS Converter -Unit Tests Projects -Set Aspose License.

0 additional answers

Your answer