Refactoring *-PSResourceRepository cmdlets (Register, Get, Unregister) #346
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…s for Register can work
…me names without error
alerickson
reviewed
Mar 2, 2021
PaulHigin
suggested changes
Mar 2, 2021
…me is just whitespace
anamnavi
changed the title
Update name parameter description to say it now supports wildcards in Name
PaulHigin
suggested changes
Mar 30, 2021
anamnavi
changed the title
|
@anamnavi Can you look at the test failures? |
alerickson
reviewed
Apr 2, 2021
alerickson
reviewed
Apr 2, 2021
alerickson
approved these changes
Apr 5, 2021
anamnavi
added a commit
that referenced
this pull request
Sep 7, 2022
#346) * added new RegisterPSResourceRepository.cs with parameters so far * add PSRepositoryItemInfo * added passthru, need to complete implementation * added code and tests for REgister-PSResourceRepository * add code for Get-PSResourceRepository and move to srcNew * add files to srcNew * moved cmdlets and added Set-PSResourceRepository cmdlet * removed set, get, unregister resource repository cmdlets to put in later PRs * rename Register-PSResourceRepository cmdlet and references to previous name of cmdlet * added comemnts where needed * revert changes accidentally made * add Get-PSResourceRepository, Unregister-PSResourceRepository so tests for Register can work * reset changes to settings.json * revert unintended changes to srcOld folder * revert unintended changes to testOld * revert unintended changes to PowerShellGet.psd1 script * add EOL to some files that were missing it * remove commented out code from PSGetTestUtils.cs * changed using statements so that namespace and class name can have same names without error * fix reference in ArgumentCompleter.cs * fix some codacy warnings * make RepositorySettings.cs a static class and update rest of classes that use it * remove not so helpful comments * explicitly type variables that were previously implicitly typed as var * remove unintended writeDebug message * use yield to return IEnumerable for ArgumentCompleter and remove private helper method * remove unncessary parameter set names from cmdlets which don't have multiple parameter sets * store parameter set names as const fields * remove unused RemotingCapability field from Cmdlets * RepositorySettings and PSRepositoryItem now belong to UtilClasses namespace and removed older using statements * replace private fields with Properties, use switch case for parameter set names * Remove comments * create helper method to search if repo with name already exists * change error handling to be non terminating where needed, and continue looping through rest of repositories if error arises * remove some unneccessary comments * refactor so there's a helper method calling the Add() API * call Read() to find existing repo by name in Add() * make commented description of Add() clearer * refactor FindRepositoryXML() * throw error if non implemented parameters are attempted to be used * refactor CheckRepositoryStore() and how/where it throws errors * wrap RepositorySettings file handling code with try/catch * minor fix * remove unneccessary using statements * Delete UnregisterPSResourceRepository.Tests.ps1 * include error specific tests for Register-PSResourceRepository * change Repositories parameter type from List<Hashtable> to Hashtable[] * add tests for Unregister and refactor RepositorySettings to handle Unregister related errors * add out errorMsgs to RepositorySettings Read() and refactor GetPSResourceRepository and its tests * fix ArgumentCompleter issue * remove uneccesary comments from RepositorySettings * rename FindRepositoryElement helper method * refactor FindRepositoryElement code to just return and be more readable * styling with if keywords * fix indentation and bracket placement according to PowerShell style standards * added Debug statements to register * added try catch to Get and Unregister, changed out string[] errorMsgs syntax * fix Debug statements and remove unneccessary try catch * remove shouldSupportProcess from Get * put check for repo store in BeginProcessing() and change default switch case to use dbg assert * check if repo name is whitespace * correct error message typo * remove unncessary comment * fix typo in tests, rename errorMsgs to errorList * make PSRepositoryItem sealed class, add ShouldProcess() support to Register * add ShouldSupportProcess = true to Unregister * don't write error if names matching wildcard aren't found * not set errorList to null as not needed * add powershell helper to add quotes to ArgumentCompleter to deal with Name with spaces * tests use now * changed Get and Unregister tests to use FullyQualifiedErrorId * remove setters from PSRepositoryItem * remove ValueByPipeline tag from Proxy, ProxyCredential and add onto Repositories * use ErrorId for Unregister tests * all tests now rely on FullyQualifiedErrorId * make shouldsupport() target action message more intuitive * fix target name formatting for ShouldProcess() * add newline after brackets and #endregion per powershell style guidelines * add newline in Utils.cs * trim trailing and leading whitespaces from Name and throw error if Name is just whitespace * add test for throwing error if Name is whitespace for register * rename Get and Unregister to remove hype in cmdlet name * fix codacy warning * fixed some naming conventions in test to fix codacy warnings * renamed PSRepositoryItem -> PSRepositoryInfo to match Amber's output class naming * Update Name parameter description Update name parameter description to say it now supports wildcards in Name * fix styling issues * change Repository settings fields to private * change testcases syntax to Pester v4 syntax * change temp variable name, update PSResourceRepository.xml file comment * add newline to end of Utils.cs * organize using directive statements alphabetically * change error type for checkRepositoryStore error thrown
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes refactoring for Register-PSResourceRepository, Get-PSResourceRepository, and Unregister-PSResourceRepository. Each of these cmdlets performs some CRUD operation on the repository store (APIs for this are in the RepositorySettings class). For the cmdlets that produce output I've created a strongly typed output class (PSRespositoryInfo). I've also added tests for each cmdlet.
Notes:
PR Summary
PassThruparameter support for Get-PSResourceRepository cmdlet)Repositoriesparameter is of typeHashtable[]Nameparameter.)PR Context
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.