Quantum Development Kit Telemetry Library (#1199)

Co-authored-by: Sarah Marshall <[email protected]>
Co-authored-by: Scott Carda <[email protected]>

Author: 3 people

.gitignore

@@ -368,6 +368,8 @@ src/ProjectTemplates/Quantum.Test1/.template.config/template.json
 src/QsCompiler/QirGeneration/QirGeneration.nuspec
 /examples/QIR/Development/qir/*
 /examples/QIR/Development/build
+src/Telemetry/Tests/coverage.json
+src/Telemetry/.vscode/settings.json
 
 # MSBuild logs
 MSBuild_Logs/

build/build.ps1

@@ -142,6 +142,7 @@ $all_ok = $True
 Build-One '../QsCompiler.sln'
 Build-One '../examples/QIR/QIR.sln'
 Build-One '../src/QuantumSdk/Tools/Tools.sln'
+Build-One '../src/Telemetry/Telemetry.sln'
 Build-One '../QsFmt.sln'
 
 if ($Env:ENABLE_VSIX -ne "false") {

build/init.yml

@@ -31,3 +31,4 @@ steps:
   inputs:
     command: 'custom'
     customCommand: 'install -g npm@latest'
+

build/set-env.ps1

@@ -5,6 +5,11 @@ $ErrorActionPreference = 'Stop'
 
 Write-Host "Setting up build environment variables"
 
+# Enable the QDK Telemetry Library to throw exceptions
+# This is useful to capture unexpected unhandled exceptions as we
+# test telemetry-related code
+$env:ENABLE_QDK_TELEMETRY_EXCEPTIONS = "1"
+
 If ($Env:BUILD_CONFIGURATION -eq $null) { $Env:BUILD_CONFIGURATION ="Debug" }
 If ($Env:BUILD_VERBOSITY -eq $null) { $Env:BUILD_VERBOSITY ="m" }
 If ($Env:ASSEMBLY_VERSION -eq $null) { $Env:ASSEMBLY_VERSION ="0.0.1.0" }

build/test.ps1

@@ -40,6 +40,7 @@ function Test-One {
 
 
 Test-One '../QsCompiler.sln'
+Test-One '../src/Telemetry/Telemetry.sln'
 Test-One '../QsFmt.sln'
 
 if (-not $all_ok) {

src/Telemetry/.vscode/launch.json

@@ -0,0 +1,43 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "C# Sample App",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/Samples/CSharp/bin/Debug/netcoreapp3.1/sampleTelAppCs.dll",
+            "args": [],
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": "F# Sample App",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/Samples/FSharp/bin/Debug/netcoreapp3.1/sampleTelAppFs.dll",
+            "args": [],
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": "Tests.OutOfProcessExe",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/Tests.OutOfProcessExe/bin/Debug/netcoreapp3.1/outofprocess.dll",
+            "args": ["--OUT_OF_PROCESS_TELEMETRY_UPLOAD", "--TELEMETRY_TEST_MODE"],
+            "console": "integratedTerminal",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach"
+        }
+    ]
+}

src/Telemetry/.vscode/tasks.json

@@ -0,0 +1,42 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/Telemetry.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/Telemetry.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "${workspaceFolder}/Telemetry.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

src/Telemetry/Build/Build.ps1

@@ -0,0 +1,8 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Push-Location $PSScriptRoot/../
+
+dotnet build
+
+Pop-Location

src/Telemetry/Build/Test.ps1

@@ -0,0 +1,8 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Push-Location $PSScriptRoot/../
+
+dotnet test
+
+Pop-Location

src/Telemetry/Build/test-coverage.ps1

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Push-Location $PSScriptRoot/../
+
+dotnet test --collect:"XPlat Code Coverage"
+
+$coverageFile = (Get-ChildItem  $PSScriptRoot/../Tests/TestResults/*/coverage.cobertura.xml -Recurse |
+                Sort-Object  -pro LastWriteTime -Descending |
+                Select -First 1).FullName
+
+Push-Location $PSScriptRoot/../Tests/
+dotnet reportgenerator "-reports:$coverageFile" "-targetdir:TestResults/html" -reporttypes:HTML;
+Pop-Location
+
+$reportFile = Resolve-Path "$PSScriptRoot/../Tests/TestResults/html/index.htm"
+
+Write-Output "Attempting to open: file:///$reportFile"
+
+Start-Process "file:///$reportFile"
+
+Pop-Location