Skip to content

Commit 9d5d5ff

Browse files
artemrysArtem Rys
artemrys
authored and
Artem Rys
committed
docs: update copyright year and release history page
Release history page now points to Github releases page as we release everything in Github releases.
1 parent 2a700dd commit 9d5d5ff

File tree

4 files changed

+14
-309
lines changed

4 files changed

+14
-309
lines changed

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# -- Project information -----------------------------------------------------
2323

2424
project = u"pytest-splunk-addon"
25-
copyright = u"2020, Splunk, Inc."
25+
copyright = u"2021, Splunk, Inc."
2626
author = u"Splunk, Inc."
2727

2828
# The short X.Y version

‎docs/release_history.rst‎

Lines changed: 1 addition & 249 deletions
Original file line numberDiff line numberDiff line change
@@ -4,252 +4,4 @@
44
Release History
55
=================
66

7-
**GitHub**
8-
9-
The best way to track the development of pytest-splunk-addon is through `the GitHub Repo <https://github.com/splunk/pytest-splunk-addon/>`_.
10-
11-
1.5.0
12-
"""""""""""""""""""""""""
13-
**Changes:**
14-
15-
* Added support for file monitoring which uses universal forwarder to monitor files and ingest data.
16-
17-
**Known Issues:**
18-
19-
* Event ingestion through SC4S via UDP port
20-
* Fields for modular regular expressions are not extracted in the plugin.
21-
22-
1.4.0 (2021-01-05)
23-
""""""""""""""""""""""""""
24-
**Changes:**
25-
26-
* Plugin now generates and executes tests to validate savedsearches defined in savedsearches.conf.
27-
28-
**Known Issues:**
29-
30-
* Event ingestion through SC4S via UDP port
31-
* Fields for modular regular expressions are not extracted in the plugin.
32-
33-
34-
1.3.15 (2020-12-16)
35-
""""""""""""""""""""""""""
36-
**Changes:**
37-
38-
* Fixed issue that skipped generation of test cases for some field of REPORT.
39-
* Updated the default log level to INFO for the logs in **pytest_splunk_addon.log**
40-
* Enhanced requirements for the following CIM data models:
41-
42-
+-----------------------+-----------------------------------------------------------+
43-
| CIM Data Model | Field Name |
44-
+=======================+===========================================================+
45-
| Change | Updated the search_constraints |
46-
+-----------------------+-----------------------------------------------------------+
47-
| Network Traffic | dest_ip, dest_mac, src_ip, src_mac |
48-
| | |
49-
| | icmp_code, icmp_type, dest_zone, src_zone |
50-
| | |
51-
| | dest_translated_ip, src_translated_ip |
52-
+-----------------------+-----------------------------------------------------------+
53-
| Web | cookie, http_referrer, site |
54-
+-----------------------+-----------------------------------------------------------+
55-
56-
**Known Issues:**
57-
58-
* Event ingestion through SC4S via UDP port
59-
* Fields for modular regular expressions are not extracted in the plugin.
60-
61-
62-
1.3.12 (2020-11-09)
63-
""""""""""""""""""""""""""
64-
**Changes:**
65-
66-
* Added ``--ignore-addon-errors`` pytest param to suppress Splunk Addon internal errors.
67-
* Updated ``--no-splunk-cleanup`` pytest param to ``--splunk-cleanup`` which is used to clean the data on the Splunk instance before testing.
68-
69-
**Known Issues:**
70-
71-
* Event ingestion through SC4S via UDP port
72-
* Fields for modular regular expressions are not extracted in the plugin.
73-
74-
1.3.11 (2020-10-27)
75-
""""""""""""""""""""""""""
76-
**Changes:**
77-
78-
* Fixed string literal causing SyntaxError within helmut lib.
79-
* Added ``--no-splunk-cleanup`` CLI param, which disables the cleanup of Splunk environment before the tests execute.
80-
* Added ``--splunk-web-scheme`` pytest argument which can be used to set the web scheme (http/https) of the Splunk instance.
81-
* Updated pytest-splunk-addon package to remove static fixtures that are now installed as part of the environment.
82-
83-
**Known Issues:**
84-
85-
* Event ingestion through SC4S via UDP port
86-
* Fields for modular regular expressions are not extracted in the plugin.
87-
88-
1.3.9 (2020-10-15)
89-
""""""""""""""""""""""""""
90-
**Changes:**
91-
92-
* Updated build process which uses python's poetry to install dependencies.
93-
* Added support in pytest-splunk-addon to test with on-prem forwarder configured to a standalone or SH of cloud stack by providing SH in --splunk-host and forwarder in --splunk-forwarder-host and other appropriate params.
94-
95-
**Known Issues:**
96-
97-
* Event ingestion through SC4S via UDP port
98-
* Fields for modular regular expressions are not extracted in the plugin.
99-
100-
1.3.6 (2020-9-25)
101-
""""""""""""""""""""""""""
102-
**Changes:**
103-
104-
* Added support for ingestion of data via pytest-splunk-addon with a user-defined index ``index = <index_name>``.
105-
106-
**Known Issues:**
107-
108-
* Event ingestion through SC4S via UDP port
109-
* Fields for modular regular expressions are not extracted in the plugin.
110-
111-
1.3.5 (2020-9-14)
112-
""""""""""""""""""""""""""
113-
**Changes:**
114-
115-
* Updated the host pattern from using ``_`` to using ``-``.
116-
* Updated host generation logic to fix an issue for unique IP based hosts from being duplicated due to a limit. Now hosts are getting generated uniquely.
117-
118-
**Known Issues:**
119-
120-
* Event ingestion through SC4S via UDP port
121-
* Fields for modular regular expressions are not extracted in the plugin.
122-
123-
124-
1.3.4 (2020-9-11)
125-
""""""""""""""""""""""""""
126-
**Changes:**
127-
128-
* Removed threading mechanism while sending data using SC4S as SC4S expects sequential ingestion of data rather than parallel ingestion.
129-
130-
**Known Issues:**
131-
132-
* Event ingestion through SC4S via UDP port
133-
* Fields for modular regular expressions are not extracted in the plugin.
134-
135-
1.3.3 (2020-9-09)
136-
""""""""""""""""""""""""""
137-
**Changes:**
138-
139-
* Added log messages to our tests to help debug issues.
140-
141-
**Known Issues:**
142-
143-
* Event ingestion through SC4S via UDP port
144-
* Fields for modular regular expressions are not extracted in the plugin.
145-
146-
1.3.2 (2020-8-26)
147-
""""""""""""""""""""""""""
148-
**Changes:**
149-
150-
* Enhanced requirements for the following CIM data models:
151-
152-
+-----------------------+-----------------------------------------------------------+
153-
| CIM Data Model | Field Name |
154-
+=======================+===========================================================+
155-
| Change | action, object_category, object_id, object_path, |
156-
| | object_attrs |
157-
+-----------------------+-----------------------------------------------------------+
158-
159-
* Now, the tokenised events can be stored in json files in the *.tokenized_events* folder. If these files are not required, use the ``--discard-eventlogs`` option when executing the tests.
160-
161-
**Known Issues:**
162-
163-
* Event ingestion through SC4S via UDP port
164-
* Fields for modular regular expressions are not extracted in the plugin.
165-
166-
1.3.1 (2020-8-24)
167-
""""""""""""""""""""""""""
168-
**Changes:**
169-
170-
* Now handles situations where TRANSFORMS REGEX uses _VAL in transforms.conf.
171-
* pytest-splunk-addon now handles eval functions using NULL more efficiently.
172-
173-
**Known Issues:**
174-
175-
* Event ingestion through SC4S via UDP port
176-
* Fields for modular regular expressions are not extracted in the plugin.
177-
178-
1.3.0 (2020-8-21)
179-
""""""""""""""""""""""""""
180-
**Features:**
181-
182-
* pytest-splunk-addon now generates data with it's own data generator feature which replaces SA-Eventgen for accuracy. This feature can ingest data using HEC event, HEC Raw and SC4S (TCP).
183-
* pytest-splunk-addon now generates Index Time test cases for your Splunk Technology Add-ons.
184-
* Added a utility to create a new pytest-splunk-addon-data.conf file from existing eventgen.conf file.
185-
* Backward compatibility for search time tests using existing eventgen.conf.
186-
187-
**Bugfixes:**
188-
189-
* Enhanced requirements for the following CIM data models:
190-
191-
+-----------------------+-----------------------------------------------------------+
192-
| CIM Data Model | Field Name |
193-
+=======================+===========================================================+
194-
| IDS | src, dest, src_port, dest_port, user |
195-
+-----------------------+-----------------------------------------------------------+
196-
| Network Resolution | src, dest |
197-
+-----------------------+-----------------------------------------------------------+
198-
| Network Traffic | bytes, bytes_in, bytes_out, icmp_code |
199-
| | |
200-
| | packets, packets_in, packets_out |
201-
| | |
202-
| | src, src_translated_port, src_port |
203-
| | |
204-
| | dest, dest_translated_port, dest_port |
205-
+-----------------------+-----------------------------------------------------------+
206-
| Web | app, uri_path, url_length |
207-
+-----------------------+-----------------------------------------------------------+
208-
209-
**Known Issues:**
210-
211-
* Event ingestion through SC4S via UDP port
212-
* Fields for modular regular expressions are not extracted in the plugin.
213-
214-
1.2.0 (2020-06-04)
215-
""""""""""""""""""""""""""
216-
**Features:**
217-
218-
* Plugin now generates CIM compliance report for the add-ons, which provides insights to the user about the compatibility of the add-ons with the supported CIM data models.
219-
* Provided support of setup fixtures which can be used for making necessary configurations in the testing environment required for test execution.
220-
* Optimisation of the SPL search query for faster execution of the test cases.
221-
* Added ``--search-index``, ``--search-retry``, ``--search-interval`` pytest arguments to provide custom values of Splunk index, retries and time interval respectively.
222-
223-
**Bugfixes:**
224-
225-
* Invalid search query generation for Malware Data Model is now fixed.
226-
* Invalid search query for clustered fields in CIM testing.
227-
228-
**Known Issues:**
229-
230-
* Fields for modular regular expressions are not extracted in the plugin.
231-
232-
1.1.0 (2020-05-02)
233-
""""""""""""""""""""""""""
234-
235-
**Features:**
236-
237-
* The codebase was reformatted to an object-oriented approach to increase the readability, scalability, and the reusability of the plugin.
238-
* pytest-splunk-addon now generates tests for checking CIM compatibility in your Splunk Technology Add-ons.
239-
240-
**Bugfixes:**
241-
242-
* Test cases for fields starting with $ and _KEY are now not generated.
243-
* The plugin used to fail when test cases where executed parallelly with multiple processes using pytest-xdist. The issue has been fixed.
244-
245-
**Known Issues:**
246-
247-
* Invalid search query generation for Malware Data Model, which results in an HTTP 400 Bad Request error.
248-
249-
1.0.3 (2020-04-17)
250-
""""""""""""""""""""""""""
251-
252-
**Features:**
253-
254-
* First Light.
255-
* pytest-splunk-addon generates tests for testing knowledge objects in Splunk Technology Add-ons.
7+
All releases can be found `here <https://github.com/splunk/pytest-splunk-addon/releases>`_.

0 commit comments

Comments
 (0)