feat: Support credential type parameter for NLog.

Author: robertvoinescu-work

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

@@ -14,6 +14,7 @@
 
 using Google.Api;
 using Google.Api.Gax;
+using Google.Apis.Auth.OAuth2;
 using Google.Cloud.Logging.V2;
 using Google.Protobuf.WellKnownTypes;
 using Newtonsoft.Json.Linq;
@@ -29,6 +30,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Linq;
 using System.Reflection;
 using System.Runtime.CompilerServices;
@@ -56,6 +58,19 @@ private void LogInfo(IEnumerable<string> messages)
         private const string s_projectId = "projectId";
         private const string s_logId = "logId";
 
+        private const string s_DummyServiceAccountCredentialJson = @"{
+          ""type"": ""service_account"",
+          ""project_id"": ""test-project"",
+          ""private_key_id"": ""a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"",
+          ""private_key"": ""-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"",
+          ""client_email"": ""test-service-account@test-project.iam.gserviceaccount.com"",
+          ""client_id"": ""123456789012"",
+          ""auth_uri"": ""https://accounts.google.com/o/oauth2/auth"",
+          ""token_uri"": ""https://oauth2.googleapis.com/token"",
+          ""auth_provider_x509_cert_url"": ""https://www.googleapis.com/oauth2/v1/certs"",
+          ""client_x509_cert_url"": ""https://www.googleapis.com/robot/v1/metadata/x509/test-service-account%40test-project.iam.gserviceaccount.com""
+        }";
+
         private async Task RunTest(
             Func<IEnumerable<LogEntry>, Task<WriteLogEntriesResponse>> handlerFn,
             Func<GoogleStackdriverTarget, Task> testFn,
@@ -152,6 +167,41 @@ public async Task InvalidOptions_MultipleCredentials()
             Assert.True(innerEx.Message.Contains("CredentialFile") && innerEx.Message.Contains("CredentialJson"));
         }
 
+        [Fact]
+        public async Task GoogleStackdriverTarget_FromFile_InvalidType_ThrowsArgumentException()
+        {
+            var tempFile = Path.GetTempFileName();
+            File.WriteAllText(tempFile, s_DummyServiceAccountCredentialJson);
+            try
+            {
+                var target = new GoogleStackdriverTarget
+                {
+                    ProjectId = "a_project_id",
+                    CredentialFile = Layout.FromString(tempFile),
+                    CredentialType = Layout.FromString("invalid_type"),
+                };
+                var nlogEx = await Assert.ThrowsAsync<NLogRuntimeException>(() => ActivateTargetAsync(target));
+                Assert.IsType<InvalidOperationException>(nlogEx.InnerException);
+            }
+            finally
+            {
+                File.Delete(tempFile);
+            }
+        }
+
+        [Fact]
+        public async Task GoogleStackdriverTarget_FromJson_InvalidType_ThrowsArgumentException()
+        {
+            var target = new GoogleStackdriverTarget
+            {
+                ProjectId = "a_project_id",
+                CredentialJson = Layout.FromString(s_DummyServiceAccountCredentialJson),
+                CredentialType = Layout.FromString("invalid_type"),
+            };
+            var nlogEx = await Assert.ThrowsAsync<NLogRuntimeException>(() => ActivateTargetAsync(target));
+            Assert.IsType<InvalidOperationException>(nlogEx.InnerException);
+        }
+
         [Fact]
         public async Task InvalidOptions_MultipleJsonConverters()
         {

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

@@ -14,5 +14,10 @@
     <PackageReference Include="Google.Cloud.Logging.V2" VersionOverride="[4.5.0, 5.0.0)" />
     <PackageReference Include="Grpc.Core" PrivateAssets="None" Condition="'$(TargetFramework)'=='net462'" />
     <PackageReference Include="NLog" />
+    <!--
+      This should typically be pulled in as a transitive dependency of GAX, but for now
+      GAX doesn't reference the latest version.
+    -->
+    <PackageReference Include="Google.Apis.Auth" VersionOverride="1.73.0" />
   </ItemGroup>
 </Project>

apis/Google.Cloud.Logging.NLog/Google.Cloud.Logging.NLog/GoogleStackdriverTarget.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/GoogleStackdriverTarget_Configuration.cs

@@ -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"/>.
+        /// </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.