Auto-create PSResourceRepository.xml file if the file does not already exist. (#450)

alerickson · web-flow · commit e6208fd279b3 · 2021-08-09T11:13:13.000-07:00
diff --git a/src/code/FindPSResource.cs b/src/code/FindPSResource.cs
@@ -134,7 +134,11 @@ public sealed class FindPSResource : PSCmdlet
         protected override void BeginProcessing()
         {
             _source = new CancellationTokenSource();
-            _cancellationToken = _source.Token;
+            _cancellationToken = _source.Token;
+
+            // Create a respository story (the PSResourceRepository.xml file) if it does not already exist
+            // This is to create a better experience for those who have just installed v3 and want to get up and running quickly
+            RepositorySettings.CheckRepositoryStore();
         }
 
         protected override void StopProcessing()
diff --git a/src/code/GetPSResourceRepository.cs b/src/code/GetPSResourceRepository.cs
@@ -39,19 +39,7 @@ class GetPSResourceRepository : PSCmdlet
 
         protected override void BeginProcessing()
         {
-            try
-            {
-                WriteVerbose("Calling API to check repository store exists in non-corrupted state");
-                RepositorySettings.CheckRepositoryStore();
-            }
-            catch (PSInvalidOperationException e)
-            {
-                ThrowTerminatingError(new ErrorRecord(
-                    new PSInvalidOperationException(e.Message),
-                    "RepositoryStoreException",
-                    ErrorCategory.ReadError,
-                    this));
-            }
+            RepositorySettings.CheckRepositoryStore();
         }
         protected override void ProcessRecord()
         {
diff --git a/src/code/InstallPSResource.cs b/src/code/InstallPSResource.cs
@@ -103,6 +103,10 @@ class InstallPSResource : PSCmdlet
 
         protected override void BeginProcessing()
         {
+            // Create a respository story (the PSResourceRepository.xml file) if it does not already exist
+            // This is to create a better experience for those who have just installed v3 and want to get up and running quickly
+            RepositorySettings.CheckRepositoryStore();
+
             // validate that if a -Version param is passed in that it can be parsed into a NuGet version range. 
             // An exact version will be formatted into a version range.
             if (ParameterSetName.Equals(NameParameterSet) && Version != null && !Utils.TryParseVersionOrVersionRange(Version, out _versionRange))
diff --git a/src/code/PublishPSResource.cs b/src/code/PublishPSResource.cs
@@ -156,10 +156,16 @@ public PSCredential ProxyCredential {
         private NuGetVersion _pkgVersion;
         private string _pkgName;
         private static char[] _PathSeparators = new [] { System.IO.Path.DirectorySeparatorChar, System.IO.Path.AltDirectorySeparatorChar };
-        
+
         #endregion
 
         #region Method overrides
+        protected override void BeginProcessing()
+        {
+            // Create a respository story (the PSResourceRepository.xml file) if it does not already exist
+            // This is to create a better experience for those who have just installed v3 and want to get up and running quickly
+            RepositorySettings.CheckRepositoryStore();
+        }
 
         protected override void ProcessRecord()
         {
diff --git a/src/code/RegisterPSResourceRepository.cs b/src/code/RegisterPSResourceRepository.cs
@@ -118,19 +118,8 @@ protected override void BeginProcessing()
                     ErrorCategory.NotImplemented,
                     this));
             }
-
-            try
-            {
-                RepositorySettings.CheckRepositoryStore();
-            }
-            catch (PSInvalidOperationException e)
-            {
-                ThrowTerminatingError(new ErrorRecord(
-                    new PSInvalidOperationException(e.Message),
-                    "RepositoryStoreException",
-                    ErrorCategory.ReadError,
-                    this));
-            }
+            
+            RepositorySettings.CheckRepositoryStore();
         }
         protected override void ProcessRecord()
         {
diff --git a/src/code/RepositorySettings.cs b/src/code/RepositorySettings.cs
@@ -19,16 +19,19 @@ namespace Microsoft.PowerShell.PowerShellGet.UtilClasses
     /// </summary>
 
     internal static class RepositorySettings
-    {
+    {
         /// <summary>
         /// File name for a user's repository store file is 'PSResourceRepository.xml'
         /// The repository store file's location is currently only at '%LOCALAPPDATA%\PowerShellGet' for the user account.
         /// </summary>
-        private static readonly string RepositoryFileName = "PSResourceRepository.xml";
+        private const string PSGalleryRepoName = "PSGallery";
+        private const string PSGalleryRepoURL = "https://www.powershellgallery.com/api/v2";
+        private const int defaultPriority = 50;
+        private const bool defaultTrusted = false;
+        private const string RepositoryFileName = "PSResourceRepository.xml";
         private static readonly string RepositoryPath = Path.Combine(Environment.GetFolderPath(SpecialFolder.LocalApplicationData), "PowerShellGet");
         private static readonly string FullRepositoryPath = Path.Combine(RepositoryPath, RepositoryFileName);
 
-
         /// <summary>
         /// Check if repository store xml file exists, if not then create
         /// </summary>
@@ -52,6 +55,10 @@ public static void CheckRepositoryStore()
                 {
                     throw new PSInvalidOperationException(string.Format(CultureInfo.InvariantCulture, "Repository store creation failed with error: {0}.", e.Message));
                 }
+
+                // Add PSGallery to the newly created store
+                Uri psGalleryUri = new Uri(PSGalleryRepoURL);
+                Add(PSGalleryRepoName, psGalleryUri, defaultPriority, defaultTrusted);
             }
 
             // Open file (which should exist now), if cannot/is corrupted then throw error
diff --git a/src/code/SavePSResource.cs b/src/code/SavePSResource.cs
@@ -125,6 +125,10 @@ public string Path
 
         protected override void BeginProcessing()
         {
+            // Create a respository story (the PSResourceRepository.xml file) if it does not already exist
+            // This is to create a better experience for those who have just installed v3 and want to get up and running quickly
+            RepositorySettings.CheckRepositoryStore();
+
             // validate that if a -Version param is passed in that it can be parsed into a NuGet version range. 
             // an exact version will be formatted into a version range.
             if (ParameterSetName.Equals("NameParameterSet") && 
diff --git a/src/code/SetPSResourceRepository.cs b/src/code/SetPSResourceRepository.cs
@@ -95,19 +95,7 @@ public SwitchParameter Trusted
         #region Methods
         protected override void BeginProcessing()
         {
-            try
-            {
-                WriteVerbose("Calling API to check repository store exists in non-corrupted state");
-                RepositorySettings.CheckRepositoryStore();
-            }
-            catch (PSInvalidOperationException e)
-            {
-                ThrowTerminatingError(new ErrorRecord(
-                    new PSInvalidOperationException(e.Message),
-                    "RepositoryStoreException",
-                    ErrorCategory.ReadError,
-                    this));
-            }
+            RepositorySettings.CheckRepositoryStore();
         }
 
         protected override void ProcessRecord()
diff --git a/src/code/UnregisterPSResourceRepository.cs b/src/code/UnregisterPSResourceRepository.cs
@@ -37,19 +37,7 @@ class UnregisterPSResourceRepository : PSCmdlet
 
         protected override void BeginProcessing()
         {
-            try
-            {
-                WriteVerbose("Calling API to check repository store exists in non-corrupted state");
-                RepositorySettings.CheckRepositoryStore();
-            }
-            catch (PSInvalidOperationException e)
-            {
-                ThrowTerminatingError(new ErrorRecord(
-                    new PSInvalidOperationException(e.Message),
-                    "RepositoryStoreException",
-                    ErrorCategory.ReadError,
-                    this));
-            }
+            RepositorySettings.CheckRepositoryStore();
         }
         protected override void ProcessRecord()
         {
diff --git a/src/code/UpdatePSResource.cs b/src/code/UpdatePSResource.cs
@@ -103,7 +103,11 @@ public sealed class UpdatePSResource : PSCmdlet
         #region Override Methods
 
         protected override void BeginProcessing()
-        {
+        {
+            // Create a respository story (the PSResourceRepository.xml file) if it does not already exist
+            // This is to create a better experience for those who have just installed v3 and want to get up and running quickly
+            RepositorySettings.CheckRepositoryStore();
+
             _pathsToInstallPkg = Utils.GetAllInstallationPaths(this, Scope);
         }
 
@@ -166,6 +170,7 @@ protected override void ProcessRecord()
         }
 
         #endregion
+
         #region Private Methods
 
         /// <Summary>

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,11 @@ public sealed class FindPSResource : PSCmdlet`
`134`	`134`	`protected override void BeginProcessing()`
`135`	`135`	`{`
`136`	`136`	`_source = new CancellationTokenSource();`
`137`		`- _cancellationToken = _source.Token;`
	`137`	`+ _cancellationToken = _source.Token;`
	`138`	`+`
	`139`	`+ // Create a respository story (the PSResourceRepository.xml file) if it does not already exist`
	`140`	`+ // This is to create a better experience for those who have just installed v3 and want to get up and running quickly`
	`141`	`+ RepositorySettings.CheckRepositoryStore();`
`138`	`142`	`}`
`139`	`143`
`140`	`144`	`protected override void StopProcessing()`