(PA-5826) Only read Windows VERSION file during puppet apply #677
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshcooper
force-pushed
the
windows_auto_5826
branch
from
ba7758d to
4a1467e
Compare
bastelfreak
reviewed
Oct 25, 2023
joshcooper
force-pushed
the
windows_auto_5826
branch
from
4a1467e to
fb1cd29
Compare
bastelfreak
approved these changes
Oct 25, 2023
|
Should fix #665. |
kenyon
reviewed
Oct 25, 2023
manifests/init.pp
Outdated
| @@ -167,6 +167,9 @@ | |||
| # The AIO package version and Puppet version can, on rare occasion, diverge. | |||
| # This logic checks for the AIO version of the server, since that's what the package manager cares about. | |||
| if $package_version == 'auto' { | |||
| if $facts['os']['family'] == 'windows' and $facts['puppet_runmode'] == 'user' { | |||
| $version_file_path = "${facts['env_windows_installdir']}\\VERSION" | |||
There was a problem hiding this comment.
Isn't this a reassignment of the $version_file_path variable, since it's already been assigned a value from the class parameter list?
There was a problem hiding this comment.
Good catch, I’ll fix that. Weird that all the tests passed. Or would it only show up when running a specific puppet-lint check?
There was a problem hiding this comment.
puppet-lint does not catch that. you need an rspec-puppet test that hits this if condition and checks for it should compile.
There was a problem hiding this comment.
ah yeah, my test coverage was lacking. I added a test for apply mode on Windows and it triggered the issue:
1) puppet_agent supported Windows x64 environment with auto when applying is expected to contain File[C:\ProgramData\Puppetlabs]
Failure/Error: it { is_expected.to contain_file("#{appdata}\\Puppetlabs") }
Puppet::PreformattedError:
Evaluation Error: Cannot reassign variable '$version_file_path' (file: /home/josh/work/modules/puppetlabs-puppet_agent/spec/fixtures/modules/puppet_agent/manifests/init.pp, line: 171, column: 28) on node xxx
# /home/josh/.rbenv/versions/3.2.2/lib/ruby/3.2.0/benchmark.rb:311:in `realtime'
# ./spec/classes/puppet_agent_osfamily_windows_spec.rb:106:in `block (5 levels) in <top (required)>'
Previously, puppetserver attempted to load the wrong VERSION file when managing
`package_version => auto` and compiling catalogs for Windows nodes as can be
seen by the new test:
Evaluation Error: Error while evaluating a Function Call, Could not find any files from C:\Program Files\Puppet Labs\Puppet\VERSION (file: path/to/init.pp, line: 170, column: 42)
This adds a `puppet_runmode` fact. When running as puppet agent, the run mode will
be `agent`. When running as puppet apply, it will be `user`. If it's the latter
and we're a Windows host, then look for the VERSION file locally.
Since the default class parameter is no longer dependent on the agent
fact, I regenerated the reference using rake strings:generate:reference
joshcooper
force-pushed
the
windows_auto_5826
branch
from
fb1cd29 to
b2cc0eb
Compare
kenyon
approved these changes
Oct 25, 2023
cthorn42
approved these changes
Oct 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, puppetserver attempted to load the wrong VERSION file when managing
package_version => autoand compiling catalogs for Windows nodes as can be seen by the new test:This adds a
puppet_runmodefact. When running as puppet agent, the run mode will beagent. When running as puppet apply, it will beuser. If it's the latter and we're a Windows host, then look for the VERSION file locally.