Create CLI to extract API data from specification file

[Desvelao]

Description

This pull request is adds a new CLI to extract API data from the specification file.

Changes

• Create a new CLI
• Add a new script package

Issues Resolved

#5036

Evidence

• CLI help

node@osd:~/kbn/plugins/wazuh$ node scripts/generate-api-data.js 
Wazuh API data extractor - Help
Extract the Wazuh API data

Some warning messages are sent to stderr.

Usage: node /home/node/kbn/plugins/wazuh/scripts/generate-api-data.js --spec <URL OpenAPI file/local file in POJO> [options]

Options:
  --display-configuration                             Display the configuration. Log to sterr.
  --examples                                          Display examples of usage.
  --help                                              Display the help.
  --format <format>                                   Set the format. Default: plugin.
    <format> is one of:
      plugin: Plugin
  --output <output>                                   Set the output. Default: stdout.
    <output> is one of:
      file: file.
      stdout: stdout.
  --output-directory <directory>                      Set the directory.
  --spec <URL OpenAPI file/local file in POJO>        Define the specification file.

• package script

node@osd:~/kbn/plugins/wazuh$ yarn generate:api-data
yarn run v1.22.19
warning Skipping preferred cache folder "/home/node/.cache/yarn" because it is not writable.
warning Selected the next writable cache folder in the list, will be "/tmp/.yarn-cache-1000".
$ node scripts/generate-api-data.js --spec https://raw.githubusercontent.com/wazuh/wazuh/$(node -e "console.log(require('./package.json').version.split('.').splice(0,2).join('.'))")/api/api/spec/spec.yaml --output file --output-directory common/api-info --display-configuration
{
  displayConfiguration: true,
  displayExamples: false,
  displayHelp: false,
  format: 'plugin',
  output: 'file',
  spec: 'https://raw.githubusercontent.com/wazuh/wazuh/4.5/api/api/spec/spec.yaml',
  outputDirectory: '/home/node/kbn/plugins/wazuh/common/api-info'
}
File was created! Path: /home/node/kbn/plugins/wazuh/common/api-info/security-actions.json
File was created! Path: /home/node/kbn/plugins/wazuh/common/api-info/endpoints.json
Done in 2.35s.

Test

wka-pr-5519-tests.md

Check List

• All tests pass
  • yarn test:jest
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[yenienserrano]

Wazuh dashboard

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

Other

Test	Result
Ensure the CLI help is working. Use node scripts/generate-api-data.js	🟢
Ensure the API data is generated and saved to files using the package script. Removes the files stored in common/api-info and runs the package script yarn:generate-api. New files with the API data should be created in the common/api-info path	🟢
Use the stdout output. Use node scripts/genrate-api-data.js --spec and the information should be displayed in the console	🟢

Details

🟢 Ensure the CLI help is working. Use node scripts/generate-api-data.js

🟢 Ensure the API data is generated and saved to files using the package script. Removes the files stored in common/api-info and runs the package script yarn:generate-api. New files with the API data should be created in the common/api-info path

🟢 Use the stdout output. Use node scripts/genrate-api-data.js --spec and the information should be displayed in the console

[yenienserrano]

LGTM

[github-actions]

Code coverage (Jest)	%	values
Statements	9.52%	( 3503 / 36786 )
Branches	5.02%	( 1433 / 28503 )
Functions	8.19%	( 747 / 9114 )
Lines	9.6%	( 3383 / 35235 )

[github-actions]

The backport to 4.5-7.10 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.5-7.10 4.5-7.10
# Navigate to the new working tree
cd .worktrees/backport-4.5-7.10
# Create a new branch
git switch --create backport-5519-to-4.5-7.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 92f9b91ad1d72abce1d672fa06a7fb81c553cefa
# Push it to GitHub
git push --set-upstream origin backport-5519-to-4.5-7.10
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.5-7.10

Then, create a pull request where the base branch is 4.5-7.10 and the compare/head branch is backport-5519-to-4.5-7.10.

[github-actions]

The backport to 4.5-7.16 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.5-7.16 4.5-7.16
# Navigate to the new working tree
cd .worktrees/backport-4.5-7.16
# Create a new branch
git switch --create backport-5519-to-4.5-7.16
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 92f9b91ad1d72abce1d672fa06a7fb81c553cefa
# Push it to GitHub
git push --set-upstream origin backport-5519-to-4.5-7.16
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.5-7.16

Then, create a pull request where the base branch is 4.5-7.16 and the compare/head branch is backport-5519-to-4.5-7.16.