tree f28fc2b5e69d0b66718db97b4ba1cf7b27f2d923
parent 6fa0602db8250905808991e5f7206151dd28b346
author Potin Lai <potin.lai@quantatw.com> 1701706435 +0800
committer PL <potin.lai@quantatw.com> 1703057638 +0000

Support C-style comments for configuration JSON parsing

1. Add and set ignore_comment to true to all nlohmann::json::parse().
2. Add remove_c_comments() in `validate_configs.py` to remove C-style
   comments before loading.
3. Attempt to reformat comments in the `autojson.py` taking liberal
   short-cuts which are documented in the script.

Supported comment examples:

- Single-line style comments
```
{
  // Single-line style comment (new line)
  "Key": "Value" // Single-line comment (end of content)
}
```

- Multi-line style comments
```
{
  /* Multi-line style comment */
  /*
   * Multi-line style comments
   */
}
```

Tested on harma system with manual applied patch below, which contains
a c-style comment in harma-pttv.json file.
Link: https://gerrit.openbmc.org/c/openbmc/entity-manager/+/67469/25

- scripts/autojson.py
Run autojson.py on harma-pttv.json, the output as same as original file.

- scripts/validate_configs.py
Run validate_configs.py passed.

- EntityManager service
EntityManager service loads and probes harma-pttv.json successfully.
```
root@harma:~# busctl introspect xyz.openbmc_project.EntityManager \
> /xyz/openbmc_project/inventory/system/board/Harma_PTTV \
> xyz.openbmc_project.Inventory.Item.Board
NAME                                     TYPE      SIGNATURE RESULT/VALUE                             FLAGS
.Name                                    property  s         "Harma PTTV"                             emits-change
.Probe                                   property  s         "xyz.openbmc_project.FruDevice({\'BOA... emits-change
.Type                                    property  s         "Board"                                  emits-change
```

Signed-off-by: Potin Lai <potin.lai@quantatw.com>
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ib235f2aa6a724615dc4c8184577f57abda8e17a6