Skip to content
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.

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

BREAKING CHANGE: xSQLServerSetup: Removed SourceFolder & default value #301

Merged
merged 4 commits into from
Jan 14, 2017

Conversation

johlju
Copy link
Member

@johlju johlju commented Jan 9, 2017

  • Changes to xSQLServerSetup
    • BREAKING CHANGE: Removed parameter SourceFolder.
    • BREAKING CHANGE: Removed default value "$PSScriptRoot...." from parameter SourcePath.
    • Old code, that no longer filled any function, has been replaced.
      • Function ResolvePath has been replaced with [Environment]::ExpandEnvironmentVariables($SourcePath) so that environment variables still can be used in Source Path.
      • Function NetUse has been replaced with New-SmbMapping and Remove-SmbMapping.
    • Renamed function GetSQLVersion to Get-SqlMajorVersion.
  • Changes to xSQLServerHelper
    • Resolved all the white space in xSQLServerHelper.psm1

This Pull Request (PR) fixes the following issues:
Fixes #40
Fixes #196

  • Change details added to Unreleased section of CHANGELOG.md?
  • Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate?
  • Examples appropriately updated?
  • New/changed code adheres to Style Guidelines?
  • Unit and (optional) Integration tests created/updated where possible?

This change is Reviewable

@johlju johlju added needs review The pull request needs a code review. breaking change When used on an issue, the issue has been determined to be a breaking change. labels Jan 9, 2017
@johlju johlju changed the title BREAKING CHANGE: Removed SourceFolder, Removed default value BREAKING CHANGE: xSQLServerSetup: Removed SourceFolder & default value Jan 9, 2017
Removed default value "$PSScriptRoot\..\..\" from parameter SourcePath.
Removed default value "Source" from parameter SourceFolder.
  - Removed parameter SourceFolder.
  - Function `ResolvePath` has been replaced with `[Environment]::ExpandEnvironmentVariables($SourcePath)` so that environment variables still can be used in Source Path.
  - Function `NetUse` has been replaced with `New-SmbMapping` and `Remove-SmbMapping`.
  - Renamed function `GetSQLVersion` to `Get-SqlMajorVersion`.
- Resolved all the white space in xSQLServerHelper.psm1
@johlju
Copy link
Member Author

johlju commented Jan 14, 2017

Reviewed 6 of 6 files at r1.
Review status: all files reviewed at latest revision, 5 unresolved discussions.


README.md, line 749 at r1 (raw file):

If the path set in parameter SourcePath contains

If the path, that is assigned to parameter SourcePath, contains

then the that leaf folder

then that leaf folder

If the path set in parameter SourcePath does not have

If the path, that is assigned to parameter SourcePath, does not have


DSCResources/MSFT_xSQLServerSetup/MSFT_xSQLServerSetup.psm1, line 20 at r1 (raw file):

        For any subsequent calls to the resource, the parameter `SourceCredential` is used to evaluate what major version the file 'setup.exe'
        has in the path set, again, by the parameter `SourcePath`.
        If the path set in parameter `SourcePath` contains a leaf folder, for example '\\server\share\folder', then the that leaf

Same as the comment above


DSCResources/MSFT_xSQLServerSetup/MSFT_xSQLServerSetup.psm1, line 332 at r1 (raw file):

        has in the path set, again, by the parameter `SourcePath`.
        If the path set in parameter `SourcePath` contains a leaf folder, for example '\\server\share\folder', then the that leaf
        folder will be used as the name of the temporary folder. If the path set in parameter `SourcePath` does not have a leaf folder,

Same as the comment above


DSCResources/MSFT_xSQLServerSetup/MSFT_xSQLServerSetup.psm1, line 902 at r1 (raw file):

        has in the path set, again, by the parameter `SourcePath`.
        If the path set in parameter `SourcePath` contains a leaf folder, for example '\\server\share\folder', then the that leaf
        folder will be used as the name of the temporary folder. If the path set in parameter `SourcePath` does not have a leaf folder,

Same as the comment above


DSCResources/MSFT_xSQLServerSetup/MSFT_xSQLServerSetup.schema.mof, line 6 at r1 (raw file):

    [Write, Description("The path to the root of the source files for installation. I.e and UNC path to a shared resource. Environment variables can be used in the path.")] String SourcePath;
    [Required, EmbeddedInstance("MSFT_Credential"), Description("Credential to be used to perform the installation.")] String SetupCredential;
    [Write, EmbeddedInstance("MSFT_Credential"), Description("Credentials used to access the path set in the parameter 'SourcePath'. Using this parameter will trigger a copy of the installation media to a temp folder on the target node. Setup will then be started from the temp folder on the target node. For any subsequent calls to the resource, the parameter 'SourceCredential' is used to evaluate what major version the file 'setup.exe' has in the path set, again, by the parameter 'SourcePath'.")] String SourceCredential;

Make this a shorter description than the one in README.md and comment-based help, to align with PSDscResources


Comments from Reviewable

@johlju johlju added waiting for author response The pull request is waiting for the author to respond to comments in the pull request. and removed needs review The pull request needs a code review. labels Jan 14, 2017
@johlju johlju added needs review The pull request needs a code review. and removed waiting for author response The pull request is waiting for the author to respond to comments in the pull request. labels Jan 14, 2017
@johlju
Copy link
Member Author

johlju commented Jan 14, 2017

:lgtm:


Reviewed 3 of 3 files at r2.
Review status: all files reviewed at latest revision, all discussions resolved.


Comments from Reviewable

@johlju johlju merged commit 290db32 into dsccommunity:dev Jan 14, 2017
@vors vors removed the needs review The pull request needs a code review. label Jan 14, 2017
@johlju johlju deleted the changes-to-xSQLServerSetup branch January 14, 2017 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change When used on an issue, the issue has been determined to be a breaking change.
Projects
None yet
3 participants