feat: Support credential type parameter for NLog.

Author: robertvoinescu-work

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.IntegrationTests/CredentialTest.cs

@@ -0,0 +1,143 @@
+// Copyright 2025 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Newtonsoft.Json;
+using NLog;
+using System;
+using System.IO;
+using Xunit;
+
+namespace Google.Cloud.Logging.NLog.Tests;
+
+public class CredentialTests
+{
+    private const string FakeServiceAccountCredential = @"{
+        ""private_key_id"": ""PRIVATE_KEY_ID"",
+        ""private_key"": ""-----BEGIN PRIVATE KEY-----
+        MIICdgIBADANBgkqhkiG9w0BAQEFAASCAmAwggJcAgEAAoGBAJJM6HT4s6btOsfe
+        2x4zrzrwSUtmtR37XTTi0sPARTDF8uzmXy8UnE5RcVJzEH5T2Ssz/ylX4Sl/CI4L
+        no1l8j9GiHJb49LSRjWe4Yx936q0Xj9H0R1HTxvjUPqwAsTwy2fKBTog+q1frqc9
+        o8s2r6LYivUGDVbhuUzCaMJsf+x3AgMBAAECgYEAi0FTXsu/zRswAUGaViQiHjrL
+        uU65BSHXNVjV/2fLNEKnGWGqpli68z1IXY+S2nwbUak7rnGsq9/0F6jtsW+hZbLk
+        KXUOuuExpeC5Kd6ngWX/f2jqmhlUabiQijU9cVk7pMq8EHkRtvlosnMTUAEzempu
+        QUPwn1PZHhmJkBvZ4lECQQDCErrxl+e3BwUDcS0yVEEmCNSG6xdXs2878b8rzbe7
+        3Mmi6SuuOLi3PU92J+j+f/MOdtYrk13mEDdYmd5dhrt5AkEAwPvDEsDT/W4y4h5n
+        gv1awGBA5aLFE1JNWM/Gwn4D1cGpEDHKFREaBtxMDCASpHJuw8r7zUywpKhmBZcf
+        GS37bwJANdSAKfbafLfjuhqwUJ9yGpykZm/a36aTmerp/bpn1iHdg+RtCzwMcDb/
+        TWSwibbvsflgWmHbz657y4WSWhq+8QJAWrpCNN/ZCk2zuGDo80lfUBAwkoVat8G6
+        wWU1oZyS+vzIGef+hLb8kHsjeZPej9eIwZ39kcBbT54oELrCkRjwGwJAQ8V2A7lT
+        ZUp8AsbVqF6rbLiiUfJMo2btGclQu4DEVyS+ymFA65tXDLUuR9EDqJYdqHNZJ5B8
+        4Z5p2prkjWTLcA\u003d\u003d
+        -----END PRIVATE KEY-----"",
+        ""client_email"": ""CLIENT_EMAIL"",
+        ""client_id"": ""CLIENT_ID"",
+        ""project_id"": ""PROJECT_ID"",
+        ""type"": ""service_account""}";
+
+    private const string FakeUserCredential = @"{
+        ""client_id"": ""CLIENT_ID"",
+        ""client_secret"": ""CLIENT_SECRET"",
+        ""refresh_token"": ""REFRESH_TOKEN"",
+        ""type"": ""authorized_user""}";
+
+    [Fact]
+    public void LoadCredentialFromFile_Succeeds()
+    {
+        using var tempCredFile = new TempFile(FakeServiceAccountCredential);
+        InitializeNLog(GetXml($"credentialFile='{tempCredFile.Path}'"));
+    }
+
+    [Fact]
+    public void LoadCredentialFromJson_Succeeds() =>  InitializeNLog(GetXml($"credentialJson='{FakeServiceAccountCredential}'"));
+
+    [Fact]
+    public void LoadCredentialFromFile_BadFormat_Fails()
+    {
+        using var tempCredFile = new TempFile("bad json");
+        var exception = Record.Exception(() => InitializeNLog(GetXml($"credentialFile='{tempCredFile.Path}'")));
+        Assert.IsType<InvalidOperationException>(exception);
+        Assert.IsType<JsonReaderException>(exception.InnerException);
+    }
+
+    [Fact]
+    public void LoadCredentialFromJson_BadFormat_Fails()
+    {
+        var exception = Record.Exception(() => InitializeNLog(GetXml("credentialJson='terrible json'")));
+        Assert.IsType<InvalidOperationException>(exception);
+        Assert.IsType<JsonReaderException>(exception.InnerException);
+    }
+
+    [Fact]
+    public void LoadCredentialFromFile_FileDoesNotExist_Fails() =>
+        Assert.Throws<FileNotFoundException>(() => InitializeNLog(GetXml("credentialFile='non-existent-file'")));
+
+
+    [Fact]
+    public void LoadCredential_MultipleCredentials_Fails()
+    {
+        using var tempCredFile = new TempFile(FakeServiceAccountCredential);
+        var exception = Assert.Throws<InvalidOperationException>(() =>
+                InitializeNLog(GetXml($"credentialFile='{tempCredFile.Path}' credentialJson='{FakeServiceAccountCredential}'")));
+        Assert.IsType<InvalidOperationException>(exception);
+        Assert.Contains("CredentialFile", exception.Message);
+        Assert.Contains("CredentialJson", exception.Message);
+    }
+
+    [Fact]
+    public void LoadUserCredentialFromJson_WithCredentialType_Succeeds() =>
+        InitializeNLog(GetXml($"credentialJson='{FakeUserCredential}' credentialType='authorized_user'"));
+
+    [Fact]
+    public void LoadUserCredentialFromJson_WithWrongCredentialType_Fails() =>
+        Assert.Throws<InvalidOperationException>(() => InitializeNLog(GetXml($"credentialJson='{FakeServiceAccountCredential}' credentialType='authorized_user'")));
+
+    private static string GetXml(string attributes) =>
+        "<nlog xmlns='http://www.nlog-project.org/schemas/NLog.xsd' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>" +
+        "<extensions><add assembly='Google.Cloud.Logging.NLog'/></extensions>" +
+        "<targets>" +
+        $"<target name='stackdriver' xsi:type='GoogleStackdriver' projectId='test-project-id' {attributes} />" +
+        "</targets>" +
+        "</nlog>";
+
+    private static void InitializeNLog(string config)
+    {
+        using var tempConfigFile = new TempFile(config);
+        using var logFactory = new LogFactory();
+        logFactory.ThrowExceptions = true;
+        logFactory.Setup().LoadConfigurationFromFile(tempConfigFile.Path);
+        Assert.NotNull(logFactory.Configuration);
+    }
+
+    private sealed class TempFile : IDisposable
+    {
+        public string Path { get; }
+
+        public TempFile(string content = null)
+        {
+            Path = System.IO.Path.GetTempFileName();
+            if (content != null)
+            {
+                File.WriteAllText(Path, content);
+            }
+        }
+
+        public void Dispose()
+        {
+            if(File.Exists(Path))
+            {
+                File.Delete(Path);
+            }
+        }
+    }
+}

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.IntegrationTests/Google.Cloud.Logging.NLog.IntegrationTests.csproj

@@ -5,8 +5,6 @@ VisualStudioVersion = 17.2.32516.85
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Google.Cloud.Logging.NLog", "Google.Cloud.Logging.NLog\Google.Cloud.Logging.NLog.csproj", "{6D49EF6F-7560-6F97-397E-078969D8757B}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Google.Cloud.Logging.NLog.IntegrationTests", "Google.Cloud.Logging.NLog.IntegrationTests\Google.Cloud.Logging.NLog.IntegrationTests.csproj", "{ACEC53F3-0EFD-91A5-CF74-305332D20A9F}"
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Google.Cloud.Logging.NLog.Snippets", "Google.Cloud.Logging.NLog.Snippets\Google.Cloud.Logging.NLog.Snippets.csproj", "{881DAAA0-40C6-1230-750F-3A3190D4F3A7}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Google.Cloud.Logging.NLog.Tests", "Google.Cloud.Logging.NLog.Tests\Google.Cloud.Logging.NLog.Tests.csproj", "{940DDEF4-FECB-9507-8D65-591A7A7D8BD6}"
@@ -23,10 +21,6 @@ Global
 		{6D49EF6F-7560-6F97-397E-078969D8757B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6D49EF6F-7560-6F97-397E-078969D8757B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6D49EF6F-7560-6F97-397E-078969D8757B}.Release|Any CPU.Build.0 = Release|Any CPU
-		{ACEC53F3-0EFD-91A5-CF74-305332D20A9F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{ACEC53F3-0EFD-91A5-CF74-305332D20A9F}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{ACEC53F3-0EFD-91A5-CF74-305332D20A9F}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{ACEC53F3-0EFD-91A5-CF74-305332D20A9F}.Release|Any CPU.Build.0 = Release|Any CPU
 		{881DAAA0-40C6-1230-750F-3A3190D4F3A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{881DAAA0-40C6-1230-750F-3A3190D4F3A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{881DAAA0-40C6-1230-750F-3A3190D4F3A7}.Release|Any CPU.ActiveCfg = Release|Any CPU

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.IntegrationTests/NLogFixture.cs

@@ -9,7 +9,8 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="ConfigureAwaitChecker.Analyzer" PrivateAssets="All" />
-    <PackageReference Include="Google.Api.Gax.Grpc" />
+    <PackageReference Include="Google.Api.Gax" VersionOverride="[4.13.0, 5.0.0)" />
+    <PackageReference Include="Google.Api.Gax.Grpc" VersionOverride="[4.13.0, 5.0.0)" />
     <PackageReference Include="Google.Cloud.DevTools.Common" VersionOverride="[3.3.0, 4.0.0)" />
     <PackageReference Include="Google.Cloud.Logging.V2" VersionOverride="[4.5.0, 5.0.0)" />
     <PackageReference Include="Grpc.Core" PrivateAssets="None" Condition="'$(TargetFramework)'=='net462'" />

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.Tests/CredentialTests.cs

@@ -276,13 +276,12 @@ private GoogleCredential GetCredentialFromConfiguration()
             var nullLogEvent = LogEventInfo.CreateNullEvent();
             var credentialFile = CredentialFile?.Render(nullLogEvent);
             var credentialJson = CredentialJson?.Render(nullLogEvent);
+            var credentialType = CredentialType?.Render(nullLogEvent);
             GaxPreconditions.CheckState(string.IsNullOrWhiteSpace(credentialFile) || string.IsNullOrWhiteSpace(credentialJson),
                 $"{nameof(CredentialFile)} and {nameof(CredentialJson)} must not both be set.");
             var credential =
-#pragma warning disable CS0618 // Temporarily disable warnings for obsolete methods. See b/453009677 for more details.
-                !string.IsNullOrWhiteSpace(credentialFile) ? GoogleCredential.FromFile(credentialFile) :
-                !string.IsNullOrWhiteSpace(credentialJson) ? GoogleCredential.FromJson(credentialJson) :
-#pragma warning restore CS0618
+                !string.IsNullOrWhiteSpace(credentialFile) ? CredentialFactory.FromFile(credentialFile, credentialType) :
+                !string.IsNullOrWhiteSpace(credentialJson) ? CredentialFactory.FromJson(credentialJson, credentialType) :
                 null;
             if (credential == null)
             {

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.sln

@@ -1,4 +1,4 @@
-// Copyright 2018 Google LLC
+// Copyright 2018 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using Google.Apis.Auth.OAuth2;
 using Google.Cloud.Logging.V2;
 using Google.Protobuf.WellKnownTypes;
 using NLog.Config;
@@ -40,6 +41,13 @@ public partial class GoogleStackdriverTarget
         /// </summary>
         public Layout CredentialJson { get; set; }
 
+        /// <summary>
+        /// The type of credential to load when either <see cref="CredentialFile"/> or <see cref="CredentialJson"/> is specified.
+        /// Valid strings can be found in the <see cref="JsonCredentialParameters"/> class.
+        /// Defaults to <see cref="JsonCredentialParameters.ServiceAccountCredentialType"/>. Must not be null.
+        /// </summary>
+        public Layout CredentialType { get; set; } = JsonCredentialParameters.ServiceAccountCredentialType;
+
         /// <summary>
         /// If set, disables resource-type detection based on platform,
         /// so ResourceType will default to "global" if not manually set.

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog.csproj

@@ -46,6 +46,7 @@ then the `projectId="PROJECT_ID"` configuration setting can be omitted; it will
 - `ContextProperty` - Allows custom labels to be added to the log entries as extra metadata.
 - `CredentialFile` - Credentials using a JSON file, instead of using the application default credentials
 - `CredentialJson` - Credentials using raw JSON input, instead of using the application default credentials
+- `CredentialType` - Specifies the type of credential being used (Default = "service_account"). The value must be a valid type as defined on [JsonCredentialParameters](https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.JsonCredentialParameters); possible values include "service_account", "authorized_user", "external_account", and "impersonated_service_account".
 - `IncludeCallSite` - Include `LogEntrySourceLocation` extracted from NLog callsite. (This only includes the function name.)
 - `IncludeCallSiteStackTrace` - Include `LogEntrySourceLocation` extracted from NLog callsite. (This also includes file name and line number.)
 - `IncludeEventProperties` - Includes structured logging properties from NLog `LogEventInfo.Properties`.