fit_field usage in bom vs. kibom outputs

[cdwilson]

The documentation says:

fit_field: [string='Config'] Field name used for internal filters.

If I define a bom output with the fit_field defined, the resulting BOM does not ignore DNF components (even though ignore_dnf: true is set):

outputs:
  - type: bom
    options:
      format: HTML
      fit_field: BOM
      ignore_dnf: true

However, if I add dnf_filter: _kibom_dnf_BOM, then DNF components are correctly ignored in the resulting BOM:

outputs:
  - type: bom
    options:
      format: HTML
      fit_field: BOM
      ignore_dnf: true
      dnf_filter: _kibom_dnf_BOM

I would assume that by defining fit_field: BOM, the internal _kibom_dnf filter should effectively function the same as a filter named _kibom_dnf_BOM, so dnf_filter: _kibom_dnf_BOM should be unnecessary.

Furthermore, if I define a kibom output with fit_field: BOM, the DNF components are correctly ignored in the resulting BOM:

outputs:
  - type: kibom
    options:
      format: HTML
      conf:
        fit_field: BOM
        ignore_dnf: true

It seems like there is a difference between the behavior of bom vs. kibom outputs, i.e. bom seems to require an explicit dnf_filter: _kibom_dnf_BOM whereas kibom seems to implicitly create this filter based on the fit_field: BOM option.

Is this intentional? If not, could the bom output be fixed so that when fit_field: BOM is specified, the internal _kibom_dnf filter behaves like _kibom_dnf_BOM (i.e. dnf_filter: _kibom_dnf_BOM doesn't need to be specified also)?

[set-soft]

Do you have a small example to check this?
Using a small config:

outputs:
  - name: 'bom_internal'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      fit_field: BOM

I see:

DEBUG:Creating internal filter: {'name': '_kibom_dnf_BOM', 'type': 'generic', 'comment': 'Internal KiBoM DNF filter (BOM)', 'config_field': 'BOM', 'exclude_value': True, 'exclude_config': True, 'keys': 'dnf_list'} (kibot - fil_base.py:270)
...
DEBUG:Applying filter `_kibom_dnf_BOM` to fitted (kibot - fil_base.py:171)

[cdwilson]

Hi @set-soft I just tried to reproduce this in a small example project and I wasn't able to reproduce the issue (it looks like it's working in the small example project). Sorry for the false alarm, please ignore this issue for now, I'll send an update if I can reproduce it in a small example.

[cdwilson]

Hi @set-soft I was able to reproduce this issue in a small example project.

I think the problem only occurs when variants are used. When a variant is used, dnf_filter: _kibom_dnf_BOM must be specified in addition to fit_field: BOM and ignore_dnf: true in order for DNP to be correctly processed. When a variant is not used, this is not needed.

Here's how to reproduce it:

git clone git@github.com:cdwilson/test-kibot.git
cd test-kibot/

git checkout dnf-filter-without-variant
make
open _build/BOM/bom_no_dnf_filter.html  # note that C4 is listed under "Optional components (DNF=Do Not Fit)"
open _build/BOM/bom_with_dnf_filter.html  # note that C4 is listed under "Optional components (DNF=Do Not Fit)"
open _build/BOM/kibom_no_dnf_filter.html  # note that C4 is listed under "Optional components (DNF=Do Not Fit)"
make clean

git checkout dnf-filter-with-variant
make
open _build/BOM/bom_no_dnf_filter.html  # BROKEN: C4 is NOT listed under "Optional components (DNF=Do Not Fit)"
open _build/BOM/bom_with_dnf_filter.html  # note that C4 is listed under "Optional components (DNF=Do Not Fit)"
open _build/BOM/kibom_no_dnf_filter.html  # note that C4 is listed under "Optional components (DNF=Do Not Fit)"
make clean

[cdwilson]

FYI, I created an issue for this: #257

[set-soft]

Hi @cdwilson !
As I commented in #257: The filter options are there just to make it simple to apply a filter, no need to create a variant. But once you use a variant you must explicitly specify all the needed filters. The variant can then be applied to other outputs.