Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Dec 18, 2024
1 parent ded1ec2 commit f5bd0e3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,16 +341,19 @@ See the following tests for examples of how to access and use fixtures:
* [test_common_protocols.py](src/maltest/tests/test_common_protocols.py)
- querying the [Malcolm Field Aggregation API](https://idaholab.github.io/Malcolm/docs/api-aggregations.html), specifying a `from` query start time filter to search all historical data, a filter on `event.provider` to limit the result set to records from Zeek, and a `tags` filter to limit the matching records to the tags represented by the uploaded PCAPs (see above)

When creating tests for `malcolm-test`, it's recommended to use [custom markers](https://docs.pytest.org/en/stable/example/markers.html#working-with-custom-markers) to group like tests into categories. More than one marker can be used to decorate a test. Some example markers include (but are not limited to; be judicious wise in choosing custom markers):
When creating tests for `malcolm-test`, it's recommended to use [custom markers](https://docs.pytest.org/en/stable/example/markers.html#working-with-custom-markers) to group like tests into categories. More than one marker can be used to decorate a test. Some example markers include (but are not limited to; be judicious in choosing custom markers):

* `@pytest.mark.arkime` - to indicate the test involves Arkime
* `@pytest.mark.beats` - to indicate the test involves data other than network log data (e.g., host logs, etc.)
* `@pytest.mark.carving` - to indicate the test involves Zeek file extraction ("carving")
* `@pytest.mark.hostlogs` - to indicate the test involves [third-party/host logs](https://idaholab.github.io/Malcolm/docs/third-party-logs.html#ThirdPartyLogs)
* `@pytest.mark.dashboards` - to indicate the test involves OpenSearch Dashboards
* `@pytest.mark.hostlogs` - to indicate the test involves [third-party/host logs](https://idaholab.github.io/Malcolm/docs/third-party-logs.html#ThirdPartyLogs)
* `@pytest.mark.ics` - to indicate the test involves data or features related to OT/ICS network log data
* `@pytest.mark.mapi` - to indicate the test uses the [Malcolm API](https://idaholab.github.io/Malcolm/docs/api.html#API)
* `@pytest.mark.netbox` - to indicate the test relies on NetBox (see also `NETBOX_ENRICH` above)
* `@pytest.mark.opensearch` - to indicate the test uses the OpenSearch/Elasticsearch API directly
* `@pytest.mark.pcap` - to indicate the test relies on uploaded PCAP artifacts (see also `UPLOAD_ARTIFACTS` above)
* `@pytest.mark.vm` - to indicate the test deals with the Malcolm virtual machine itself
* `@pytest.mark.webui` - to indicate the test checks some web user interface component of Malcolm
* etc.

Expand Down
1 change: 0 additions & 1 deletion src/maltest/tests/test_nginx_access.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

@pytest.mark.mapi
@pytest.mark.beats
@pytest.mark.nginx
def test_nginx_logs(
malcolm_http_auth,
malcolm_url,
Expand Down

0 comments on commit f5bd0e3

Please sign in to comment.