Skip to content

Log MSAL events to debug stream #2036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2023
Merged

Log MSAL events to debug stream #2036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b85ece
Write MSAL logs to debug stream.
peombwa May 24, 2023
ed13246
Add pester test to validate debug logs.
peombwa May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/Authentication/Authentication.Core/Utilities/AuthenticationHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------
using Azure.Core;
using Azure.Core.Diagnostics;
using Azure.Identity;
using Microsoft.Graph.PowerShell.Authentication.Core.Extensions;
using Microsoft.Identity.Client;
using Microsoft.Identity.Client.Extensions.Msal;
using System;
using System.Diagnostics.Tracing;
using System.Globalization;
using System.IO;
using System.Linq;
Expand Down Expand Up @@ -201,8 +203,14 @@ public static async Task<IAuthContext> AuthenticateAsync(IAuthContext authContex
{
try
{
signInAuthContext = await SignInAsync(authContext, cancellationToken).ConfigureAwait(false);
retrySignIn = false;
// Write MSAL logs to debug stream.
using (AzureEventSourceListener listener = new AzureEventSourceListener(
(args, message) => GraphSession.Instance.OutputWriter.WriteDebug($"{message}"),
level: EventLevel.Informational))
{
signInAuthContext = await SignInAsync(authContext, cancellationToken).ConfigureAwait(false);
retrySignIn = false;
};
}
catch (AuthenticationFailedException authEx)
{
Expand Down
8 changes: 8 additions & 0 deletions src/Authentication/Authentication/test/Connect-MgGraph.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,17 @@ Describe 'Connect-MgGraph In App Mode' {
}

}

Describe 'Connect-MgGraph Dependency Resolution' {
It 'Should load Mg module side by side with Az module.' {
{ Connect-AzAccount -ApplicationId $RandomClientId -CertificateThumbprint "Invalid" -Tenant "Invalid" -ErrorAction Stop } | Should -Throw -ExpectedMessage "*Could not find tenant id*"
{ Connect-MgGraph -TenantId "thisdomaindoesnotexist.com" -ErrorAction Stop -UseDeviceAuthentication } | Should -Throw -ExpectedMessage "*AADSTS90002*"
}
}

Describe 'Connect-MgGraph Logging' {
It 'Should write MSAL logs to debug stream.' {
$MgDebugStream = $(Connect-MgGraph -TenantId "thisdomaindoesnotexist.com" -UseDeviceAuthentication -Debug -ErrorAction SilentlyContinue) 5>&1
$MgDebugStream[0] | Should -Match "DeviceCodeCredential.Authenticate invoked. Scopes: \[ User.Read \]"
}
}