dbatools for Koans

[shaneis]

Describe the koan you'd like to see
For years, seekers of enlightenment had to sully their karma and physical bodies with SQLPS.

SLOW was their loading times!
CHANGED was their path!
WARNED where they of unapproved verbs (which elicited a few unapproved 4 letter words from the seekers themselves...)

Then LO! As how a journey starts with but a single step, a new module arrived from the need to improve a single action.
From a migration tool to a fully fledged module, dbatools has become the de facto module for interacting with SQL Server.

Outline the scope you think would be most helpful and conducive to the koan format
dbatools has most of their commands broken down into categories themselves so we can work off that if needed.

Start off small, say server/database information. Then move up to say SQL Server Agent Jobs, etc.

Additional context
Blog posts and websites and people, oh my!
dbatools website
Chrissy LeMaire
Rob Sewell

and more and more and more

[vexx32]

For related PRs, please target the dbatools branch so we can get initial koans and a framework in place before we merge these to master.

I'll work on a method of handling optional Koan modules like this and keep you guys posted. 😄

Additional notes for the record for anyone looking to help out here:

• For the time being, all Koans files under this project should be numbered 1001 and up.
• We will eventually add a module specifier to the [Koan()] attribute to help deal with these
• We will probably implement some specific "opt-in" command for module-based koans and have this implement the following functionality:
  • We would like to implement some automatic module installation functionality; where koans depend on a published module, there is no reason it cannot prompt the user whether they want to install the module automatically.
  • There will be a separate folder for these koans at some point, keeping them discrete from the usual koans. These will not be copied to the user's profile folder by default until they request that these koans be used.
  • Measure-Karma will need a -Module param to target these modules, and/or we need some kind of Set-CurrentKoanModule command sort of idea to avoid having to traverse the base koans to do optional module koans.

Just spitballing at this point, we'll work as we go.

[vexx32]

Update: I have added a Module property to [Koan()] that you can set, but it doesn't do anything yet. I'll add some logic for it soon, and then some parameters to Measure-Karma or perhaps implement a command to swap modules out or something.

[shaneis]

That's cool, I'll add it into the scripts anyway for when it does. Now, back to my mocks! 🤕

[vexx32]

The initial stuff here is done, so I'll close this off.

I think you mentioned there are some outstanding things needing sorted for the dbatools koans we have at the moment, but feel free to submit another PR if/when you have time to get those sorted. 🙂