puppetlabs_spec_helper icon indicating copy to clipboard operation
puppetlabs_spec_helper copied to clipboard

ENV MODULE_WORKING_DIR incompletely implemented

Open LTangaF opened this issue 2 years ago • 3 comments

Describe the Bug

It seems from README.md that MODULE_WORKING_DIR is intended to be an alternate location for the modules in .fixtures.yml to be downloaded or linked into, but only cleanup routines use it.

Additionally, the default for MODULE_WORKING_DIR of spec/fixtures/work-dir is inconsistent with the description, which suggests that the default should probably be spec/fixtures/modules like is hard-coded in other places

Expected Behavior

Modules should be linked or checked out into MODULE_WORKING_DIR and are not

Steps to Reproduce

Steps to reproduce the behavior:

  1. Set MODULE_WORKING_DIR to an existent directory that you have write access to
  2. Run bundle exec rake spec_prep (after normal bundle update or bundle install
  3. Check contents of MODULE_WORKING_DIR and see that it is empty

Environment

  • Version 4.0.1
  • Debian 10.13

Additional Context

A proper working of MODULE_WORKING_DIR would allow for a fixtures directory for a company to be maintained separate from the individual modules' CI/CD pipelines, thereby giving opportunities for speeding up those pipelines by sharing in the cloning time costs of those fixtures rather than having all the modules in your ecosystem repeating that activity ad naseum.

LTangaF avatar Jan 21 '23 21:01 LTangaF

I intend to submit a PR to this myself within a few days.

LTangaF avatar Jan 21 '23 21:01 LTangaF

As I understand it, the 5.x branch isn't quite ready for prime time.

I've got a fix for this issue in 365-fix_MODULE_WORKING_DIR_v401 that I've already started using, but I think I may need a branch of 4.0.1 in this repo to create a PR to. I've marked my release as v4.0.2.

Could use some feedback.

LTangaF avatar Jan 28 '23 03:01 LTangaF

As I understand it, the 5.x branch isn't quite ready for prime time.

It should be. There were a few issues, but 5.0.3 should have addressed those. If you still see them, please report them.

I've got a fix for this issue in 365-fix_MODULE_WORKING_DIR_v401 that I've already started using, but I think I may need a branch of 4.0.1 in this repo to create a PR to. I've marked my release as v4.0.2.

I'm not sure there will be a 4.0.2. I haven't seen Puppetlabs do patch releases on older versions for many gems. Though I think you should start with a PR to the main branch and possibly cherry pick from there.

ekohl avatar Jan 30 '23 16:01 ekohl