Modernizing PowerShell Scripts
2 likes367 views
This document discusses modernizing PowerShell scripts by following best practices, moving scripts from Windows PowerShell to cross-platform PowerShell Core, switching from the PowerShell ISE to Visual Studio Code integrated development environment, using Git for version control, and testing scripts with Pester. Some highlighted best practices include using PascalCase for identifiers, following a verb-noun naming convention, avoiding aliases, and writing reusable, modular code. The benefits of PowerShell Core, Visual Studio Code, Git, and Pester for testing scripts are also summarized.
Modernizing PowerShell Scripts
- 1. M o d e r n i z i n g Po w e r S h e l l S c r i p t s
- 2. whoami • Matthias van den Elsacker • Axxes since 2014 • System Engineer @ Umicore since 2014 • First Line for 1 year • Second/Third Line SCCM for 4 years • Network Engineer @ Umicore since 2019 • Contact: [email protected]
- 4. My Collection of Scripts
- 5. Where did I leave these again?
- 7. Talking points • Best practices • PowerShell to PowerShell Core • Cross Platform • ISE to Visual Studio Code • Git • Pester
- 8. Best Practices And style rules
- 9. lowercase, PascalCase, UPPERCASE • lowercase: Powershell Keywords • foreach, switch, return, -eq, -like,… • PascalCase: All public identifiers • Functions, Modules, Cmdlets, Attributes, Classes,… • Do-Something, $SomeVariable, MyModule.psm1,… • UPPERCASE: Comment-based help keywords • .SYNOPSIS, .EXAMPLE, .DESCRIPTION,…
- 10. “One True Brace Style” • Brackets open at the end of a line. • Brackets close at the beginning of a line. • Exception: short CommandBlocks.
- 11. Verb-Noun • All PowerShell Modules, Functions and Cmdlets follow this rule. • Get-Process, New-LocalUser, Clear-Content,… • Follow this rule when creating functions. • Repair-Wmi, Add-DomainUserToLocalAdmins, Get- RootCertificatesFromComputer • List of approved Verbs: • Get-Verb
- 13. Aliases • Aliases are cool and all, but… • … make code hard to understand. • So try to avoid them. • (Unless you are playing Code Golf)
- 14. Comments • Comments should be useful. • Not useful: • Useful:
- 20. Other Best Practices • Re-usability
- 23. Other Best Practices • Re-usability • Modularity
- 26. Other Best Practices • Re-usability • Modularity • Don’t re-invent the wheel
- 28. Other Best Practices • Re-usability • Modularity • Don’t re-invent the wheel • Write-*
- 29. PowerShell to PS Core Moving to an open-source, cross-platform version
- 31. What’s broken?
- 32. Solution!
- 33. What’s broken?
- 34. Solution!
- 35. What’s broken?
- 36. Solution!
- 37. Solution!
- 38. What’s broken?
- 39. Solution?
- 40. PowerShell Core keeps evolving…
- 41. What about Linux? Cross-Platform PowerShell
- 42. PowerShell comes in a lot of flavors
- 43. Remote Connection to Linux
- 44. Remote Connection to Linux
- 45. Windows vs Linux
- 46. ISE vs Code Out with the old, in with the new
- 47. In Memoriam
- 48. Welcome Visual Studio Code
- 49. Main advantages • Workspaces, folders, and files • Add-ons • Themes • Cross Platform • Debugging • Multiple terminals • Integrated GIT • Not just for PowerShell • It’s just cooler
- 50. Git And GitHub for System Engineers
- 51. “A solution for growing pains”
- 52. G-I-T • Random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant. • Stupid. Contemptible and Despicable. Simple. Take your pick from the dictionary of slang. • “Global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room. • “Goddamn idiotic truckload of sh*t": when it breaks
- 55. Pester Testing PowerShell, using PowerShell
- 56. Pester • Test Framework • For PowerShell • Written in PowerShell • DSL Syntax: • “Describe” • “It” • “Should”
- 57. Type of Tests • Unit Testing • In isolation (using $TestDrive) • No external code (using Mocks) • Integration Testing • “White/Clear Box Testing” • Integration with external code • Acceptance Testing • “Black Box Testing” • Third party
- 58. T h a n k y o u !
- 59. Resources • https://github.com/PoshCode/PowerShellPracticeAndStyle • https://poshcode.gitbooks.io/powershell-practice-and-style/ • https://docs.microsoft.com/en-us/powershell/scripting/whats-new/breaking-changes-ps6?view=powershell-6 • https://4sysops.com/archives/make-visual-studio-code-look-and-behave-like-powershell-ise/ • https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/ssh-remoting-in-powershell- core?view=powershell-6 • https://github.com/PowerShell/psl-omi-provider • https://lkml.org/lkml/1998/9/30/122 • https://guides.github.com/activities/hello-world/ • https://github.com/pester/Pester • https://www.red-gate.com/simple-talk/sysadmin/powershell/introduction-to-testing-your-powershell-code-with- pester/