Add new "pdk console" command #758

logicminds · 2019-09-20T20:49:10Z

Adds a new command called console that invokes the puppet debugger console from within a module. This command respects the puppet-version, puppet-dev, and pe-version options but has to parse them manually due to how CRI works and becoming a broker to the puppet debugger command. Otherwise the pdk console command works just like the puppet debugger command and can be passed the same exact options. In fact using pdk console -h will actually return the help info from the puppet debugger command. This is the reason why I had to skip option parsing.

At the moment this only works inside a module due to some limitations of the PDK and external gems. However, working inside a module allows for a scoped invocation of the puppet debugger scoped for the module. This allows for users to easily test out their module code, facts, datatypes and more without having to supply the modulepath.

pdk console
pdk (INFO): Console can only be run from inside a valid module directory

This also relies on the user having the puppet-debugger gem in their Gemfile. The following PR should ensure the user has this already. Otherwise the user would need to add puppet-debugger to the .sync.yml file. If the user does not have the puppet-debugger gem they will get the following error. Once solution to work around this is to figure out if they have the gem present already, but this procedure slows down the console command and was removed from the PR.

pdk console
Error: Unknown Puppet subcommand 'debugger'
See 'puppet help' for help on available puppet subcommands

This PR also relies on #753 and #755 and I have included them as separate PRs and also in this branch.

The demo below shows several invocations with different puppet versions which is quite handy. The delay you may notice is PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset]) being run to ensure the correct puppet version is installed.

coveralls · 2019-09-20T21:12:40Z

Coverage increased (+0.003%) to 91.719% when pulling 131aa75 on nwops:console into e25f01b on puppetlabs:master.

glennsarti · 2019-09-23T03:19:46Z

@logicminds I assume this relates to puppetlabs-toy-chest/pdk-planning#44

May need to update the RFC with the new name of console

glennsarti · 2019-09-23T03:21:51Z

README.md

@@ -105,6 +105,20 @@ This command runs all available unit tests.

 ## Experimental features

+### `pdk console` command


@jbondpdx Can you give these docs a quick look.

To use just execute avoid just and easy

~/modules/ntp $ ... Avoid shell specific things e.g. a PowerShell user would see this prefixed differently.

I updated the README with the fixes and also added some extra bits I thought were important.

Sorry I didn't see this sooner, @glennsarti , @logicminds ... I think it got lost in a mass of GitHub emails. Thank you for both for these docs!

logicminds · 2019-09-24T05:38:37Z

Added another commit that helps the user if the puppet-debugger gem is missing.

pdk console
pdk (FATAL): Your Gemfile is missing the puppet-debugger gem.  You can add the missing gem
by updating your /modules/ntp/.sync.yml file with the following
and running pdk update.

Gemfile:
  required:
    ":development":
      - gem: puppet-debugger
        version: "~> 0.14"

logicminds · 2019-09-27T14:57:16Z

@rodjek @glennsarti I spent some time refactoring my tests and they no longer run the debugger and instead just validate the args being passed through to the debugger. We know the debugger works so there is no need to test it's functionality. Not running the debugger speeds up the tests greatly and removes the need for the dependency as well. This strategy might be something we can do with other pdk commands as well.

Anyways, this is ready to go.

Gemfile

README.md

lib/pdk/cli/console.rb

spec/unit/pdk/cli/console_spec.rb

glennsarti · 2019-10-04T03:55:49Z

Hrmm the environmentpath is breaking on my laptop

pdk (DEBUG): Executing 'bundle.bat exec puppet debugger --basemodulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules --environmentpath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules --modulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules' interactively
Traceback (most recent call last):
        7: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/bin/puppet:23:in `<main>'
        6: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/bin/puppet:23:in `load'
        5: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/bin/puppet:5:in `<top (required)>'
        4: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/lib/puppet/util/command_line.rb:77:in `execute'
        3: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/lib/puppet/util/command_line.rb:143:in `run'
        2: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/lib/puppet/application.rb:370:in `run'
        1: from C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/lib/puppet/application_support.rb:34:in `push_application_context'
C:/Users/glenn.sarti/AppData/Local/PDK/cache/ruby/2.5.0/gems/puppet-6.10.0-x64-mingw32/lib/puppet/environments.rb:38:in `get!': Could not find a directory environment named 'workstation_production' anywhere in the path: C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules. Does the directory exist? (Puppet::Environments::EnvironmentNotFound)
pdk (DEBUG): Execution of 'bundle.bat exec puppet debugger --basemodulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules --environmentpath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules --modulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules' complete (duration:                               16.243607s; exit code: 1)
C:\Source\tmp\pdkmodule>

Removing that setting I get a pdk console prompt

pdk (DEBUG): Executing 'bundle.bat exec puppet debugger --basemodulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules --modulepath=C:/Source/tmp/pdkmodule/spec/fixtures/modules:C:/Source/tmp/pdkmodule/modules' interactively
Ruby Version: 2.5.1
Puppet Version: 6.10.0
Puppet Debugger Version: 0.15.1
Created by: NWOps <[email protected]>
Type "commands" for a list of debugger commands
or "help" to show the help screen.


1:>>

Makes sense as the environment layout is different to a modulepath

This commit updates the console command to lazy load the required libraries.

Previously when using the PDK as a gem, the lockfile used to detect the debugger would use the PDK's lock file, not the module context. This commit changes the lock file location to be that of the module.

Previously the debugger reset the environment path to that of the modulepath however, on a configured Puppet Agent this is incorrect. The puppet-debugger should really use the default environment path.

glennsarti · 2019-10-04T04:18:47Z

I don't have rights on your branch but here are my changes -

nwops/pdk@console...glennsarti:corey-console

logicminds · 2019-10-04T18:41:40Z

@glennsarti added your changes and updated my tests.

I also added a new check to ensure the user has fixtures downloaded. Currently this is just a warning message as it only impacts the modules the debugger has access too.

pdk console
pdk (WARN): Module fixtures not found, please run pdk bundle exec rake spec_prep.

* Add a new command called console that is a pass through to the puppet debugger console. * Only allows for use within a module at this time.

glennsarti · 2019-10-07T09:17:30Z

Confirmed changes at commit 2be8a94 work as expected on Windows and Linux. As it's experimental edge cases can be dealt with later.

@rodjek Unless you have any other thoughts I'll merge soon.

* previously if the user was not inside the module and had a lib folder present the console command would dump a stack trace. This fixes that by also performing a deep inspection of the module first.

glennsarti · 2019-10-08T03:53:49Z

🎉🎉🎉🎉

logicminds requested a review from a team as a code owner September 20, 2019 20:49

glennsarti reviewed Sep 23, 2019

View reviewed changes

logicminds force-pushed the console branch from 6db6525 to 6a02d11 Compare September 24, 2019 02:03

logicminds force-pushed the console branch 14 times, most recently from 82932e4 to 68d9167 Compare September 27, 2019 14:19

logicminds force-pushed the console branch from 68d9167 to 8867004 Compare September 30, 2019 05:07

glennsarti added this to the September 2019 milestone Sep 30, 2019

glennsarti reviewed Oct 1, 2019

View reviewed changes

Gemfile Outdated Show resolved Hide resolved

glennsarti reviewed Oct 1, 2019

View reviewed changes

README.md Show resolved Hide resolved

glennsarti reviewed Oct 1, 2019

View reviewed changes

lib/pdk/cli/console.rb Show resolved Hide resolved

glennsarti reviewed Oct 1, 2019

View reviewed changes

spec/unit/pdk/cli/console_spec.rb Show resolved Hide resolved

logicminds force-pushed the console branch 3 times, most recently from 75a8f7b to 5d34bfc Compare October 2, 2019 13:19

logicminds force-pushed the console branch from 5d34bfc to cf9e30b Compare October 2, 2019 21:23

glennsarti added a commit to glennsarti/pdk that referenced this pull request Oct 4, 2019

(puppetlabsGH-758) Update pdk console command for lazy loading

023e1ee

This commit updates the console command to lazy load the required libraries.

logicminds force-pushed the console branch from cf9e30b to 08d106f Compare October 4, 2019 18:39

(feat) - Add console command

2be8a94

* Add a new command called console that is a pass through to the puppet debugger console. * Only allows for use within a module at this time.

logicminds force-pushed the console branch from 08d106f to 2be8a94 Compare October 6, 2019 21:18

rodjek approved these changes Oct 8, 2019

View reviewed changes

(maint) Adds additional check for module in console command

131aa75

* previously if the user was not inside the module and had a lib folder present the console command would dump a stack trace. This fixes that by also performing a deep inspection of the module first.

rodjek merged commit 46cd813 into puppetlabs:master Oct 8, 2019

logicminds deleted the console branch October 8, 2019 05:47

rodjek added the feature label Oct 9, 2019

rodjek changed the title ~~Console command~~ Add new "pdk console" command Oct 9, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new "pdk console" command #758

Add new "pdk console" command #758

logicminds commented Sep 20, 2019 •

edited

Loading

coveralls commented Sep 20, 2019 •

edited

Loading

glennsarti commented Sep 23, 2019

glennsarti Sep 23, 2019 •

edited

Loading

logicminds Sep 24, 2019 •

edited

Loading

jbondpdx Oct 8, 2019

logicminds commented Sep 24, 2019 •

edited

Loading

logicminds commented Sep 27, 2019

glennsarti commented Oct 4, 2019 •

edited

Loading

glennsarti commented Oct 4, 2019

logicminds commented Oct 4, 2019

glennsarti commented Oct 7, 2019

glennsarti commented Oct 8, 2019

		@@ -105,6 +105,20 @@ This command runs all available unit tests.

		## Experimental features

		### `pdk console` command

Add new "pdk console" command #758

Add new "pdk console" command #758

Conversation

logicminds commented Sep 20, 2019 • edited Loading

coveralls commented Sep 20, 2019 • edited Loading

glennsarti commented Sep 23, 2019

glennsarti Sep 23, 2019 • edited Loading

Choose a reason for hiding this comment

logicminds Sep 24, 2019 • edited Loading

Choose a reason for hiding this comment

jbondpdx Oct 8, 2019

Choose a reason for hiding this comment

logicminds commented Sep 24, 2019 • edited Loading

logicminds commented Sep 27, 2019

glennsarti commented Oct 4, 2019 • edited Loading

glennsarti commented Oct 4, 2019

logicminds commented Oct 4, 2019

glennsarti commented Oct 7, 2019

glennsarti commented Oct 8, 2019

logicminds commented Sep 20, 2019 •

edited

Loading

coveralls commented Sep 20, 2019 •

edited

Loading

glennsarti Sep 23, 2019 •

edited

Loading

logicminds Sep 24, 2019 •

edited

Loading

logicminds commented Sep 24, 2019 •

edited

Loading

glennsarti commented Oct 4, 2019 •

edited

Loading