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.

Sign up for GitHub

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

Jump to bottom

Publish-WikiContent: Does not fail when push fails, for example invalid or expired token #90

Closed
johlju opened this issue Jul 7, 2021 · 1 comment · Fixed by #96
Closed

Publish-WikiContent: Does not fail when push fails, for example invalid or expired token #90

johlju opened this issue Jul 7, 2021 · 1 comment · Fixed by #96
Labels
bug The issue is a bug.

Comments

@johlju
Copy link
Member

johlju commented Jul 7, 2021 •
edited
Loading

Details of the scenario you tried and the problem that is occurring

When the content is published (pushed) to the GitHub repository Wiki git repository it never fails if there is an invalid or expired token.

Steps to reproduce the problem

Add a debug stage to the azure-pipelines.yml after the stage Build. This pipeline job set a fake token and starts the correct task.

  - stage: Debug
    dependsOn: Build
    jobs:
      - job: debugWiki
        displayName: 'Debug Wiki'
        timeoutInMinutes: 0
        pool:
          vmImage: 'vs2017-win2016'
        steps:
          - task: DownloadPipelineArtifact@2
            displayName: 'Download Pipeline Artifact'
            inputs:
              buildType: 'current'
              artifactName: $(buildArtifactName)
              targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
          - pwsh: |
              $env:GitHubToken = 'anyFakeToken'
              ./build.ps1 -tasks Publish_GitHub_Wiki_Content
            name: runDebugTask
            displayName: 'Run Publish_GitHub_Wiki_Content'

On the lines:

DscResource.DocGenerator/source/tasks/Publish_GitHub_Wiki_Content.build.ps1

Lines 197 to 198 in d79b424

OwnerName = $GHRepo.Owner
RepositoryName = $GHRepo.Repository

Temporary hard-code to the real GitHub repository Wiki git repository repo:

            OwnerName         = 'dsccommunity'
            RepositoryName    = 'DscResource.DocGenerator'

Expected behavior

The task should fail if an error is encountered, especially when pushing to a repo with an invalid token.

Current behavior

Passes without any error. Below is pipeline output when running with the debug stage above.

2021-07-07T06:49:34.2679354Z ===============================================================================
2021-07-07T06:49:34.2680203Z 			PUBLISH GITHUB WIKI CONTENT
2021-07-07T06:49:34.2886411Z This task publishes documentation to a GitHub Wiki repository.
2021-07-07T06:49:34.2887175Z -------------------------------------------------------------------------------
2021-07-07T06:49:34.2893541Z   /Publish_GitHub_Wiki_Content
2021-07-07T06:49:34.2894092Z   D:\a\1\s\source\tasks\Publish_GitHub_Wiki_Content.build.ps1:102
2021-07-07T06:49:34.2894445Z 
2021-07-07T06:49:34.3082433Z 	OutputDirectory       = 'D:\a\1\s\output'
2021-07-07T06:49:34.3156782Z 	Built Module Manifest         = 'D:\a\1\s\output\DscResource.DocGenerator\0.9.0\DscResource.DocGenerator.psd1'
2021-07-07T06:49:34.3183823Z 	Built Module Base             = 'D:\a\1\s\output\DscResource.DocGenerator\0.9.0'
2021-07-07T06:49:34.3315318Z 	Module Version                = '0.9.0-debug'
2021-07-07T06:49:34.3315831Z 	Module Version Folder         = '0.9.0'
2021-07-07T06:49:34.3316623Z 	Pre-release Tag               = 'debug'
2021-07-07T06:49:34.3317133Z 	Project Path                  = D:\a\1\s
2021-07-07T06:49:34.3317689Z 	Project Name                  = DscResource.DocGenerator
2021-07-07T06:49:34.3326977Z 	Source Path                   = D:\a\1\s\source
2021-07-07T06:49:34.3327617Z 	Built Module Base             = D:\a\1\s\output\DscResource.DocGenerator\0.9.0
2021-07-07T06:49:34.3366172Z Set GitHubConfigUserName to dscbot
2021-07-07T06:49:34.3414091Z Set GitHubConfigUserEmail to [email protected]
2021-07-07T06:49:36.1835920Z 	Wiki Output Path              = D:\a\1\s\output\WikiContent
2021-07-07T06:49:36.1838311Z Publishing Wiki content.
2021-07-07T06:49:41.1314998Z Done /Publish_GitHub_Wiki_Content 00:00:06.8730315

Suggested solution to the issue

We should, at minimum, add error handling here:

DscResource.DocGenerator/source/Public/Publish-WikiContent.ps1

Lines 162 to 166 in d79b424

$null = Invoke-Git -WorkingDirectory $tempPath.FullName `
-Arguments @( 'push', 'origin' )
$null = Invoke-Git -WorkingDirectory $tempPath.FullName `
-Arguments @( 'push', 'origin', $ModuleVersion )

The operating system the target node is running

Ubuntu or Windows.

Version and build of PowerShell the target node is running

7.x

Version of the module that was used

v0.9.0-preview0009
@johlju johlju mentioned this issue Jul 7, 2021
Closed
@johlju johlju added bug The issue is a bug. help wanted The issue is up for grabs for anyone in the community. labels Jul 7, 2021
@phbits phbits mentioned this issue Jul 10, 2021
Merged
8 tasks
@johlju johlju closed this as completed in #96 Aug 5, 2021
johlju pushed a commit that referenced this issue Aug 5, 2021
@phbits
Add Show-InvokeGitReturn: fixes Issue #90 (#96)
3f90e74 
- Added private functions:
  - `Out-GitResult` - Displays `Invoke-Git` returned hashtable
    via Write-Verbose and Write-Debug localized messages.
    Fixes [Issue 90](#90)
  - `Hide-GitToken` - Used to redact the token from the specified 
    git command so that the command can be safely outputted in logs.
- `Publish-WikiContent`
  - Restored to original structure.
- `Invoke-Git`
  - Added `-PassThru` switch to return result hashtable and not throw
    regardless of ExitCode value when used.
  - Throws when ExitCode -ne 0 and `-PassThru` switch not used.
  - Calls `Out-GitResult` when using `-Debug` or `-Verbose`.
@johlju johlju removed the help wanted The issue is up for grabs for anyone in the community. label Aug 5, 2021
@johlju
Copy link
Member Author

johlju commented Aug 5, 2021

With the fix in PR #96 this correctly fails now.

2021-08-05T09:17:03.4468068Z Publishing Wiki content.
2021-08-05T09:17:03.4523393Z VERBOSE: Creating a temporary working directory.
2021-08-05T09:17:03.4636211Z VERBOSE: Cloning the Wiki Git Repository 'https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git'.
2021-08-05T09:17:04.7094431Z VERBOSE: git standard output: ''
2021-08-05T09:17:04.7105226Z VERBOSE: git standard error: 'Cloning into 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'...
2021-08-05T09:17:04.7105850Z '
2021-08-05T09:17:04.7112247Z VERBOSE: git exit code: '0'
2021-08-05T09:17:04.7119990Z DEBUG: Command: git clone https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o
2021-08-05T09:17:04.7126034Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:04.7182624Z VERBOSE: Copying Wiki files from 'D:\a\1\s\output\WikiContent'.
2021-08-05T09:17:04.7215169Z VERBOSE: Copying file 'Home.md' to the Wiki.
2021-08-05T09:17:04.7309005Z VERBOSE: Generating Wiki Sidebar '_Sidebar.md'.
2021-08-05T09:17:04.7345998Z VERBOSE: 	Adding file 'Home.md' to the Wiki Sidebar.
2021-08-05T09:17:04.7414338Z VERBOSE: Configuring local Git settings.
2021-08-05T09:17:04.7782697Z VERBOSE: git standard output: ''
2021-08-05T09:17:04.7785722Z VERBOSE: git standard error: ''
2021-08-05T09:17:04.7788804Z VERBOSE: git exit code: '0'
2021-08-05T09:17:04.7793926Z DEBUG: Command: git config --local user.email [email protected]
2021-08-05T09:17:04.7797609Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:04.8153655Z VERBOSE: git standard output: ''
2021-08-05T09:17:04.8156973Z VERBOSE: git standard error: ''
2021-08-05T09:17:04.8160115Z VERBOSE: git exit code: '0'
2021-08-05T09:17:04.8165798Z DEBUG: Command: git config --local user.name dscbot
2021-08-05T09:17:04.8169430Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:04.8537503Z VERBOSE: git standard output: ''
2021-08-05T09:17:04.8540399Z VERBOSE: git standard error: ''
2021-08-05T09:17:04.8543958Z VERBOSE: git exit code: '0'
2021-08-05T09:17:04.8549327Z DEBUG: Command: git remote set-url origin https://dscbot:***@github.com/dsccommunity/DscResource.DocGenerator.wiki.git
2021-08-05T09:17:04.8550913Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:04.8566535Z VERBOSE: Adding the Wiki Content to the Git Repository.
2021-08-05T09:17:04.9202514Z VERBOSE: git standard output: ''
2021-08-05T09:17:04.9211187Z VERBOSE: git standard error: ''
2021-08-05T09:17:04.9216110Z VERBOSE: git exit code: '0'
2021-08-05T09:17:04.9224278Z DEBUG: Command: git add *
2021-08-05T09:17:04.9227802Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:04.9247868Z VERBOSE: Committing the changes to the Repository and adding build tag '0.10.0-debug'.
2021-08-05T09:17:05.0453028Z VERBOSE: git standard output: '[master a6269b6] Updating Wiki with the content for module version '0.10.0-debug'.
2021-08-05T09:17:05.0453939Z  1 file changed, 1 insertion(+), 1 deletion(-)
2021-08-05T09:17:05.0454415Z '
2021-08-05T09:17:05.0457574Z VERBOSE: git standard error: ''
2021-08-05T09:17:05.0460380Z VERBOSE: git exit code: '0'
2021-08-05T09:17:05.0464952Z DEBUG: Command: git commit --message "Updating Wiki with the content for module version '0.10.0-debug'."
2021-08-05T09:17:05.0467950Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:05.0482955Z VERBOSE: Pushing the updated Repository to the Git Wiki.
2021-08-05T09:17:05.1282940Z VERBOSE: git standard output: ''
2021-08-05T09:17:05.1286563Z VERBOSE: git standard error: ''
2021-08-05T09:17:05.1289890Z VERBOSE: git exit code: '0'
2021-08-05T09:17:05.1302304Z DEBUG: Command: git tag --annotate 0.10.0-debug --message 0.10.0-debug
2021-08-05T09:17:05.1307762Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:07.8871747Z VERBOSE: git standard output: ''
2021-08-05T09:17:07.8875850Z VERBOSE: git standard error: 'remote: Invalid username or password.
2021-08-05T09:17:07.8876473Z fatal: Authentication failed for 'https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git/'
2021-08-05T09:17:07.8876909Z '
2021-08-05T09:17:07.8879762Z VERBOSE: git exit code: '128'
2021-08-05T09:17:07.8884268Z DEBUG: Command: git push origin
2021-08-05T09:17:07.8887217Z DEBUG: git Working Directory: 'C:\Users\VssAdministrator\AppData\Local\Temp\400ntr4j.p5o'
2021-08-05T09:17:08.2210834Z ERROR: Command: git push origin
2021-08-05T09:17:08.2211347Z git exit code: '128'
2021-08-05T09:17:08.2211731Z git standard output: ''
2021-08-05T09:17:08.2212148Z git standard error: 'remote: Invalid username or password.
2021-08-05T09:17:08.2212686Z fatal: Authentication failed for 'https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git/'
2021-08-05T09:17:08.2213125Z '
2021-08-05T09:17:08.2213221Z 
2021-08-05T09:17:08.2213680Z At D:\a\1\s\output\DscResource.DocGenerator\0.10.0\DscResource.DocGenerator.psm1:2779 char:13
2021-08-05T09:17:08.2214157Z +             throw $throwMessage
2021-08-05T09:17:08.2214508Z +             ~~~~~~~~~~~~~~~~~~~
2021-08-05T09:17:08.2318816Z At D:\a\1\s\source\tasks\Publish_GitHub_Wiki_Content.build.ps1:102 char:1
2021-08-05T09:17:08.2319505Z + task Publish_GitHub_Wiki_Content {
2021-08-05T09:17:08.2320045Z + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2021-08-05T09:17:08.2454508Z Build FAILED. 1 tasks, 1 errors, 0 warnings 00:00:15.9882497
2021-08-05T09:17:08.2761457Z Command: git push origin
2021-08-05T09:17:08.2762020Z git exit code: '128'
2021-08-05T09:17:08.2763034Z git standard output: ''
2021-08-05T09:17:08.2763490Z git standard error: 'remote: Invalid username or password.
2021-08-05T09:17:08.2764509Z fatal: Authentication failed for 'https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git/'
2021-08-05T09:17:08.2764954Z '
2021-08-05T09:17:08.2765803Z At D:\a\1\s\output\DscResource.DocGenerator\0.10.0\DscResource.DocGenerator.psm1:2779 char:13
2021-08-05T09:17:08.2766328Z +             throw $throwMessage
2021-08-05T09:17:08.2767024Z +             ~~~~~~~~~~~~~~~~~~~
2021-08-05T09:17:08.2773244Z + CategoryInfo          : OperationStopped: (Command: git push o…rator.wiki.git/'
2021-08-05T09:17:08.2773896Z '
2021-08-05T09:17:08.2774209Z :String) [], RuntimeException
2021-08-05T09:17:08.2774584Z + FullyQualifiedErrorId : Command: git push origin
2021-08-05T09:17:08.2774970Z git exit code: '128'
2021-08-05T09:17:08.2775672Z git standard output: ''
2021-08-05T09:17:08.2776052Z git standard error: 'remote: Invalid username or password.
2021-08-05T09:17:08.2776600Z fatal: Authentication failed for 'https://github.com/dsccommunity/DscResource.DocGenerator.wiki.git/'
2021-08-05T09:17:08.2777007Z '
2021-08-05T09:17:08.3915801Z ##[error]PowerShell exited with code '1'.
2021-08-05T09:17:08.5227001Z ##[section]Finishing: Run Publish_GitHub_Wiki_Content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug The issue is a bug.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Show-InvokeGitReturn: fixes Issue #90 phbits/DscResource.DocGenerator
1 participant
@johlju