[Prefix] Added job to generate verified auxiliary file (#202)

Author: loic-sharma

src/Search.GenerateAuxiliaryData/Job.cs

@@ -31,6 +31,9 @@ internal class Job
         private const string ScriptRankingsTotal = "SqlScripts.Rankings.sql";
         private const string OutputNameRankings = "rankings.v1.json";
 
+        private const string ScriptVerifiedPackages = "SqlScripts.VerifiedPackages.sql";
+        private const string OutputNameVerifiedPackages = "verifiedPackages.json";
+
         private List<SqlExporter> _sqlExportScriptsToRun;
         private CloudBlobContainer _destContainer;
 
@@ -52,6 +55,7 @@ public override void Init(IDictionary<string, string> jobArgsDictionary)
             _destContainer = destination.CreateCloudBlobClient().GetContainerReference(destinationContainerName);
 
             _sqlExportScriptsToRun = new List<SqlExporter> {
+                new VerifiedPackagesExporter(LoggerFactory.CreateLogger<VerifiedPackagesExporter>(), packageDatabaseConnString, _destContainer, ScriptVerifiedPackages, OutputNameVerifiedPackages),
                 new NestedJArrayExporter(LoggerFactory.CreateLogger<NestedJArrayExporter>(), packageDatabaseConnString, _destContainer, ScriptCuratedFeed, OutputNameCuratedFeed, Col0CuratedFeed, Col1CuratedFeed),
                 new NestedJArrayExporter(LoggerFactory.CreateLogger<NestedJArrayExporter>(), packageDatabaseConnString, _destContainer, ScriptOwners, OutputNameOwners, Col0Owners, Col1Owners),
                 new RankingsExporter(LoggerFactory.CreateLogger<RankingsExporter>(), statisticsDatabaseConnString, _destContainer, ScriptRankingsTotal, OutputNameRankings)

src/Search.GenerateAuxiliaryData/Properties/AssemblyInfo.cs

@@ -1,4 +1,5 @@
 using System.Reflection;
+using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
 [assembly: AssemblyTitle("Search.GenerateAuxiliaryData")]
@@ -12,4 +13,5 @@
 [assembly: ComVisible(false)]
 [assembly: Guid("cf7645a4-b4c0-4827-b6b0-ae42108071c6")]
 [assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: InternalsVisibleTo("Tests.Search.GenerateAuxiliaryData")]

src/Search.GenerateAuxiliaryData/Search.GenerateAuxiliaryData.csproj

@@ -91,6 +91,7 @@
     <Compile Include="RankingsExporter.cs" />
     <Compile Include="SqlExporter.cs" />
     <Compile Include="SqlExporterException.cs" />
+    <Compile Include="VerifiedPackagesExporter.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
@@ -113,6 +114,9 @@
   <ItemGroup>
     <EmbeddedResource Include="SqlScripts\Rankings.sql" />
   </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="SqlScripts\VerifiedPackages.sql" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="..\..\build\sign.targets" Condition="Exists('..\..\build\sign.targets')" />
   <Import Project="..\..\packages\Microsoft.Bcl.Build.1.0.21\build\Microsoft.Bcl.Build.targets" Condition="Exists('..\..\packages\Microsoft.Bcl.Build.1.0.21\build\Microsoft.Bcl.Build.targets')" />

src/Search.GenerateAuxiliaryData/SqlScripts/VerifiedPackages.sql

@@ -0,0 +1,3 @@
+SELECT  [PackageRegistrations].[Id] 'Id'
+FROM    [PackageRegistrations] (NOLOCK)
+WHERE   [PackageRegistrations].[IsVerified] = 1

src/Search.GenerateAuxiliaryData/VerifiedPackagesExporter.cs

@@ -0,0 +1,64 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Data;
+using System.Data.SqlClient;
+using Microsoft.Extensions.Logging;
+using Microsoft.WindowsAzure.Storage.Blob;
+using Newtonsoft.Json.Linq;
+
+namespace Search.GenerateAuxiliaryData
+{
+    internal sealed class VerifiedPackagesExporter : SqlExporter
+    {
+        private const string _colPackageId = "Id";
+        private readonly string _verifiedPackagesScript;
+
+        public VerifiedPackagesExporter(
+            ILogger<SqlExporter> logger,
+            string defaultConnectionString,
+            CloudBlobContainer defaultDestinationContainer,
+            string defaultVerifiedPackagesScript,
+            string defaultName)
+            : base(logger, defaultConnectionString, defaultDestinationContainer, defaultName)
+        {
+            _verifiedPackagesScript = defaultVerifiedPackagesScript;
+        }
+
+        protected override JContainer GetResultOfQuery(SqlConnection connection)
+        {
+            var verifiedPackagesCommand = new SqlCommand(GetEmbeddedSqlScript(_verifiedPackagesScript), connection);
+            verifiedPackagesCommand.CommandType = CommandType.Text;
+            verifiedPackagesCommand.CommandTimeout = 60;
+
+            SqlDataReader reader = null;
+
+            try
+            {
+                reader = verifiedPackagesCommand.ExecuteReader();
+
+                return GetVerifiedPackages(reader);
+            }
+            finally
+            {
+                reader?.Close();
+            }
+        }
+
+        internal JArray GetVerifiedPackages(IDataReader reader)
+        {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+
+            var colNames = GetColMappingFromSqlDataReader(reader);
+            var result = new JArray();
+
+            while (reader.Read())
+            {
+                result.Add(reader.GetString(colNames[_colPackageId]));
+            }
+
+            return result;
+        }
+    }
+}

tests/Tests.Search.GenerateAuxiliaryData/Tests.Search.GenerateAuxiliaryData.csproj

@@ -107,6 +107,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="RankingsExporterTests.cs" />
+    <Compile Include="VerifiedPackagesExporterTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="app.config" />

tests/Tests.Search.GenerateAuxiliaryData/VerifiedPackagesExporterTests.cs

@@ -0,0 +1,50 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Data;
+using Microsoft.Extensions.Logging;
+using Moq;
+using Newtonsoft.Json;
+using Search.GenerateAuxiliaryData;
+using Xunit;
+
+namespace Tests.Search.GenerateAuxiliaryData
+{
+    public class VerifiedPackagesExporterTests
+    {
+        [Fact]
+        public void GetVerifiedPackagesReturnsJsonString()
+        {
+            var dataReader = new Mock<IDataReader>(MockBehavior.Strict);
+
+            dataReader.SetupGet(x => x.FieldCount)
+                .Returns(1);
+            dataReader.Setup(x => x.GetName(It.Is<int>(i => i == 0)))
+                .Returns("Id");
+            dataReader.SetupSequence(x => x.Read())
+                .Returns(true)
+                .Returns(true)
+                .Returns(false);
+            dataReader.SetupSequence(x => x.GetString(It.Is<int>(i => i == 0)))
+                .Returns("My.Test.Package")
+                .Returns("Hello.World");
+
+            var exporter = CreateExporter();
+            var actualResult = exporter.GetVerifiedPackages(dataReader.Object);
+
+            Assert.Equal("[\"My.Test.Package\",\"Hello.World\"]", actualResult.ToString(Formatting.None));
+
+            dataReader.VerifyAll();
+        }
+
+        private static VerifiedPackagesExporter CreateExporter()
+        {
+            return new VerifiedPackagesExporter(
+                new LoggerFactory().CreateLogger<VerifiedPackagesExporter>(),
+                defaultConnectionString: "a",
+                defaultDestinationContainer: null,
+                defaultVerifiedPackagesScript: "b",
+                defaultName: "c");
+        }
+    }
+}