Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added test descriptions for documentation. #2176

Conversation

MiguelazoDS
Copy link
Member

Related issue
#2154

Description

This PR includes new documentation blocks for force_options tests and improves already documented tests

Tests

  • Python codebase satisfies PEP-8 style style guide. pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.
  • Python codebase is documented following the Google Style for Python docstrings.

@MiguelazoDS MiguelazoDS self-assigned this Nov 4, 2021
Copy link
Contributor

@DProvinciani DProvinciani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor fixes to do.

it responds appropriately to them. In this case, the enrollment requests
are sent to an IP v4 network socket.
description:
Checks if when the `wazuh-authd` daemon receives different kinds of enrollment requests,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that this was written in this way before you created this PR, but taking advantage of the PR to improve the documentation, I would say different types instead of different kinds

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good observation, I overlooked. Changed!

for the new agent and deletes the old one. In this case, the enrollment requests
are sent to an IP v4 network socket.
description:
Check if when the 'wazuh-authd' daemon receives an enrollment request from an agent
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say checks

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. I found the same typo in other files too.

Copy link
Contributor

@DProvinciani DProvinciani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@DProvinciani DProvinciani merged commit 80c59c4 into dev-9550-authd-replacement-configurations-improvement Nov 4, 2021
@DProvinciani DProvinciani deleted the dev-2154-tests_documentation branch November 4, 2021 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document all the methods and fixtures developed for force_options configuration tests
2 participants