Jira (FACT-3179) Facter.resolve returns a subclass of Hash, not Hash

[Josh Cooper (Jira)]

Josh Cooper created an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash Issue Type: Bug Assignee: Unassigned Components: Facter 4 Created: 2023/01/16 9:33 PM Labels: regression Priority: Normal Reporter: Josh Cooper In Facter3, the Facter.resolve API returned a Hash. In Facter4, it returns a Facter::FactCollection that extends Hash. The FactCollection class is not part of the Facter API and can cause implementation details to leak. The resolve method should return a Hash. The Facter.to_hash method was fixed in https://github.com/puppetlabs/facter/commit/7e681d009e but Facter.resolve was missed. Add Comment

This message was sent by Atlassian Jira (v8.20.11#820011-sha1:0629dd8)

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Josh Cooper Team: Phoenix

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash Change By: Josh Cooper

In Facter3, the {{Facter.resolve}} API returned a {{Hash}}. In Facter4, it returns a {{Facter::FactCollection}} that extends {{Hash}}. The {{FactCollection}} class is not part of the Facter API and can cause leaks implementation details to leak . The {{resolve}} method should return a {{Hash}}.

The {{Facter.to_hash}} method was fixed in https://github.com/puppetlabs/facter/commit/7e681d009e but {{Facter.resolve}} was missed.

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Josh Cooper Fix Version/s: FACT 4.3.0

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash Change By: Josh Cooper

In Facter3, the {{Facter.resolve}} API returned a {{Hash}} : {noformat} # /opt/puppetlabs/puppet/bin/ruby -e "require 'facter'; puts Facter::FACTERVERSION; puts Facter . resolve('').class" 3.14.24 Hash {noformat} In Facter4, it returns a {{Facter::FactCollection}} that extends {{Hash}} : {noformat} $ bx ruby -e "require 'facter'; puts Facter::VERSION; puts Facter . resolve('').class" 4.3.0 Facter::FactCollection {noformat} The {{FactCollection}} class is not part of the Facter API and leaks implementation details. The {{resolve}} method should return a {{Hash}}.

The {{Facter.to_hash}} method was fixed in https://github.com/puppetlabs/facter/commit/7e681d009e but {{Facter.resolve}} was missed.

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Josh Cooper Story Points: 2

Add Comment

[Morgan Rhodes (Jira)]

Morgan Rhodes updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Morgan Rhodes Sprint: Phoenix 2023-02-01

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Josh Cooper Epic Link: PUP-11658

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash Change By: Josh Cooper

In Facter3, the {{Facter.resolve}} API returned a {{ {} Hash { }} } : {noformat}

# /opt/puppetlabs/puppet/bin/ruby -e "require 'facter'; puts Facter::FACTERVERSION; puts Facter.resolve('').class" 3.14.24 Hash {noformat}

In Facter4, it returns a {{Facter::FactCollection}} that extends {{ {} Hash { }} } : {noformat}

$ bx ruby -e "require 'facter'; puts Facter::VERSION; puts Facter.resolve('').class" 4.3.0 Facter::FactCollection {noformat}

The {{FactCollection}} class is not part of the Facter API and leaks implementation details. The {{resolve}} method should return a {{ {} Hash { }} } . The {{Facter.to_hash}} method was fixed in [ https://github.com/puppetlabs/facter/commit/7e681d009e ] but {{Facter.resolve}} was missed.

For this ticket: 1. Add/update the unit test that verifies {{Facter.resolve}} behavior. There should be a test to assert the method returns {{{}an_instance_of?(Hash){}}}. Also check the {{Facter.to_hash}} method. 2. Update documentation tags so it's clear both of the methods {{"@return [Hash<String, Object>]"}}

Add Comment

[Christopher Thorn (Jira)]

Christopher Thorn assigned an issue to Christopher Thorn

Facter / FACT-3179 Facter.resolve returns a subclass of Hash, not Hash

Change By: Christopher Thorn Assignee: Christopher Thorn

Add Comment