Jira (FACT-3000) Dot notation implemented in Facter 4 is incomplete

[Reid Vandewiele (Jira)]

Reid Vandewiele created an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete Issue Type: Bug Assignee: Unassigned Created: 2021/03/26 12:57 PM Priority: Normal Reporter: Reid Vandewiele Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters. The reference implementation for dot-notation is found in Puppet, here. Today's behavior Consider the following plain-text custom fact file: foo.bar.one=1 foo.bar.two=2 foo."I.Have.Dots"=3 "me.too"=4 Today, Facter returns the following for these facts. { "foo": { "bar": { "one": "1", "two": "2" }, "\"i": { "have": { "dots\"": "3" } } }, "\"foo": { "too\"": "4" } } This is incorrect. Correct behavior Full and correct support for dot-notation SHOULD give: { "foo": { "bar": { "one": "1", "two": "2" }, "i.have.dots": "3" }, "me.too": "4" } Add Comment

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)

[Reid Vandewiele (Jira)]

Reid Vandewiele updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Reid Vandewiele

Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters.

The reference implementation for dot-notation is found in Puppet, [here|https://github.com/puppetlabs/puppet/blob/85bd9ed07e3e6c956f1972624a50be914292e1ab/lib/puppet/pops/lookup/sub_lookup.rb#L6-L44]. *Today's behavior*

Consider the following plain-text custom fact file:

{code}foo.bar.one=1 foo.bar.two=2 foo." I i . Have have . Dots dots "=3 "me.too"=4 {code}

Today, Facter returns the following for these facts.

{code:json}{

"foo": {     "bar": {       "one": "1",       "two": "2"     },     "\"i": {       "have": {         "dots\"": "3"       }     }   },   "\"foo": {     "too\"": "4"   } }

{code} This is incorrect. *Correct behavior*

Full and correct support for dot-notation SHOULD give:

{code:json}{

"foo": {     "bar": {       "one": "1",       "two": "2"     },     "i.have.dots": "3"   },   "me.too": "4" }

{code}

Add Comment

[Reid Vandewiele (Jira)]

Reid Vandewiele updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete Change By: Reid Vandewiele

Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters. The reference implementation for dot-notation is found in Puppet, [here|https://github.com/puppetlabs/puppet/blob/85bd9ed07e3e6c956f1972624a50be914292e1ab/lib/puppet/pops/lookup/sub_lookup.rb#L6-L44]. *Today's behavior* Consider the following plain-text custom fact file: {code}foo.bar.one=1 foo.bar.two=2

foo."i.have.dots"=3

"me.too"=4 {code} Today, Facter returns the following for these facts. {code:json}{   "foo": {     "bar": {       "one": "1",       "two": "2"     },     "\"i": {       "have": {         "dots\"": "3"       }     }   },

"\" foo me ": {

"too\"": "4"   } } {code} This is incorrect. *Correct behavior* Full and correct support for dot-notation SHOULD give: {code:json}{   "foo": {     "bar": {       "one": "1",       "two": "2"     },     "i.have.dots": "3"   },   "me.too": "4" } {code}

Add Comment

[Reid Vandewiele (Jira)]

Reid Vandewiele updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete Change By: Reid Vandewiele

Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters. The reference implementation for dot-notation is found in Puppet, [here|https://github.com/puppetlabs/puppet/blob/85bd9ed07e3e6c956f1972624a50be914292e1ab/lib/puppet/pops/lookup/sub_lookup.rb#L6-L44].

Full dot-notation should be supported everywhere Facter 4 currently evaluates dot-notation to segment structured fact names. This includes external fact output (text, json, yaml), as well as {{Facter.add()}}.

*Today's behavior* Consider the following plain-text custom fact file: {code}foo.bar.one=1 foo.bar.two=2 foo."i.have.dots"=3 "me.too"=4 {code} Today, Facter returns the following for these facts. {code:json}{   "foo": {     "bar": {       "one": "1",       "two": "2"     },     "\"i": {       "have": {         "dots\"": "3"       }     }   },

"\"me": {

"too\"": "4"   } } {code} This is incorrect. *Correct behavior* Full and correct support for dot-notation SHOULD give: {code:json}{   "foo": {     "bar": {       "one": "1",       "two": "2"     },     "i.have.dots": "3"   },   "me.too": "4" } {code}

Add Comment

[Reid Vandewiele (Jira)]

Reid Vandewiele updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete Change By: Reid Vandewiele

Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters. The reference implementation for dot-notation is found in Puppet, [here|https://github.com/puppetlabs/puppet/blob/85bd9ed07e3e6c956f1972624a50be914292e1ab/lib/puppet/pops/lookup/sub_lookup.rb#L6-L44].

Full dot-notation should be supported everywhere Facter 4 currently evaluates dot-notation strings to segment structured fact names. This includes external fact output (text, json, yaml), as well as {{Facter.add()}}.

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper

Facter 4 introduced compositive fact structuring via dot-notation as a feature. However, the dot-notation implementation used is incomplete, and behaves differently from dot-notation elsewhere in the ecosystem. Specifically, Facter 4 dot-notation splits key segments incorrectly, because it does not recognize the use of double or single quotes to indicate keys which contain literal dot characters. The reference implementation for dot-notation is found in Puppet, [here|https://github.com/puppetlabs/puppet/blob/85bd9ed07e3e6c956f1972624a50be914292e1ab/lib/puppet/pops/lookup/sub_lookup.rb#L6-L44]. Full dot-notation should be supported everywhere Facter 4 currently evaluates dot-notation strings to segment structured fact names. This includes external fact output (text, json, yaml), as well as {{Facter.add()}}. *Today's behavior* Consider the following plain-text custom fact file: {code}foo.bar.one=1 foo.bar.two=2 foo."i.have.dots"=3 "me.too"=4 {code}

Today, Facter 4 returns the following for these facts.

[Josh Cooper (Jira)]

Josh Cooper commented on FACT-3000

Re: Dot notation implemented in Facter 4 is incomplete For comparison, facter3 returns the following with the same external fact (since none of the facts are auto-promoted to structured facts): # facter | grep foo "foo.too" => 4 foo."i.have.dots" => 3 foo.bar.one => 1 foo.bar.two => 2

Add Comment

[Josh Cooper (Jira)]

Josh Cooper commented on FACT-3000

Re: Dot notation implemented in Facter 4 is incomplete

I'm  on completing dot notation handling in Facter 4. Also we have many cases in the puppet ecosystem where dots are special and must be escaped if you want a literal dot. For example, https://puppet.com/docs/puppet/7.5/hiera_automatic.html#hiera_dotted_notation. So the behavior described here would provide more consistency.

Add Comment

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000

Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Team: Night's Watch

Add Comment

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Sprint: NW - 2021-04-14

Add Comment

[Nick Walker (Jira)]

Nick Walker updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Nick Walker Primary problem: - There is no way to override, block, or cache facts that contain a dot in the name or sub-key

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

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

Add Comment

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Story Points: 5

Add Comment

[Gheorghe Popescu (Jira)]

Gheorghe Popescu assigned an issue to Gheorghe Popescu

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Gheorghe Popescu Assignee: Gheorghe Popescu

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Flagged: Impediment

Add Comment

This message was sent by Atlassian Jira (v8.13.2#813002-sha1:c495a97)

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Fix Version/s: FACT 4.1.0

Add Comment

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Sprint: NW - 2021-04-14 , NW-2021-04-28

Add Comment

[Mihai Buzgau (Jira)]

Mihai Buzgau updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Mihai Buzgau Sprint: NW - 2021-04-14 Triaged tickets , NW-2021-04- 28 14

Add Comment

[Beth Glenfield (Jira)]

Beth Glenfield updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Beth Glenfield Epic Link: FACT-3051

Add Comment

[Ciprian Badescu (Jira)]

Ciprian Badescu updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Ciprian Badescu Sprint: Triaged tickets, NW - 2021-04-14

Add Comment

[productboard (Jira)]

productboard updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: productboard productboard URL: https://puppet.productboard.com/feature-board/planning/features/11160699

Add Comment

This message was sent by Atlassian Jira (v8.20.2#820002-sha1:829506d)

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Epic Link: FACT PUP - 3051 11659

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-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Team: Night's Watch Phoenix

Add Comment

[Josh Cooper (Jira)]

Josh Cooper assigned an issue to Unassigned

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Assignee: Gheorghe Popescu

Add Comment

[Josh Cooper (Jira)]

Josh Cooper commented on FACT-3000

Re: Dot notation implemented in Facter 4 is incomplete The facter 3 code for looking up a fact value is in https://github.com/puppetlabs/facter/blob/6d7ffc6efdfbc3b1fc79311cdeb4581ac2098d9c/lib/src/facts/collection.cc#L466-L510. Note how dots can be escaped by double quoting the segment. Facter 4 splits on dots https://github.com/puppetlabs/facter/blob/ba325b14ea302c6d90b692219be3468bd2b1426c/lib/facter/util/utils.rb#L16 which is incorrect.

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000

Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Priority: Normal Major

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3000 Dot notation implemented in Facter 4 is incomplete

Change By: Josh Cooper Flagged: Impediment

Add Comment