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

Archer V2 search records and fetch incidents raw XML filtering #37615

Open
wants to merge 37 commits into
base: master
Choose a base branch
from

Conversation

kamalq97
Copy link
Contributor

@kamalq97 kamalq97 commented Dec 8, 2024

Related Issues

fixes: link to the issue

Description

  • Added a new xmlForFiltering argument to the archer-search-records command to allow for the filtering of records using a raw XML condition element such as: "DateComparisonFilterCondition" or "TextFilterCondition".
  • Added a new "XML for fetch filtering" configuration parameter that affects which incidents are fetched.

Note

  • By design, the "XML for fetch filtering" configuration parameter cannot be a DateComparisonFilterCondition XML element since it would interfere with the existing fetch date filter.

@kamalq97 kamalq97 added enhancement python Pull requests that update Python code labels Dec 8, 2024
@kamalq97 kamalq97 self-assigned this Dec 8, 2024
@kamalq97 kamalq97 added the ignore-auto-bump-version Not to run autobump release notes job on this pr. label Dec 8, 2024
Copy link

github-actions bot commented Dec 8, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
Packs/ArcherRSA/Integrations/ArcherV2
   ArcherV2.py83336256%91, 100, 102, 108–111, 139, 148, 150, 154–155, 160, 169, 171, 177–179, 181, 186, 195, 197, 201–202, 204, 209, 218, 220, 224–226, 228, 264, 334, 338, 350, 465, 470, 473–474, 604, 789, 799, 810, 818, 825–827, 830, 836, 867–868, 876, 905, 925–926, 945, 970, 972–973, 977, 1006, 1014, 1018, 1038, 1041, 1043–1045, 1048–1050, 1052–1057, 1072–1079, 1090, 1094–1099, 1108–1111, 1122, 1133–1134, 1178, 1245–1249, 1251–1252, 1256–1257, 1262–1263, 1265, 1273–1275, 1277–1282, 1284–1285, 1287–1289, 1291–1292, 1294–1298, 1309–1311, 1315–1316, 1318–1319, 1322, 1326, 1328, 1332–1334, 1336–1341, 1348–1349, 1352, 1356, 1358, 1362–1367, 1370, 1379–1381, 1383–1385, 1389–1390, 1392–1395, 1397–1399, 1403–1408, 1412, 1416, 1418–1420, 1422–1424, 1432–1433, 1435–1438, 1442–1448, 1452, 1459, 1461–1463, 1465–1466, 1468, 1472–1474, 1479–1481, 1485–1487, 1489, 1492, 1496–1497, 1500–1502, 1506–1507, 1511–1513, 1515, 1519, 1522, 1535–1537, 1539, 1543–1545, 1547–1548, 1550, 1552, 1555, 1592–1593, 1597–1599, 1601–1604, 1606–1607, 1611–1613, 1617, 1619–1621, 1623–1629, 1642–1644, 1671–1681, 1684, 1686–1687, 1689–1690, 1692–1693, 1697–1700, 1702, 1715, 1717–1724, 1726, 1728–1729, 1731–1732, 1734–1736, 1745, 1750, 1757, 1792–1793, 1870, 1887–1892, 1906–1909, 1915–1917, 1919–1922, 1924, 1934, 1956–1961, 1967–1975, 1977–1979
TOTAL83336256% 

Tests Skipped Failures Errors Time
55 0 💤 0 ❌ 0 🔥 1m 22s ⏱️

@kamalq97 kamalq97 changed the title Archer V2 XML filtering [DRAFT!] Archer V2 search records and fetch incidents raw XML filtering Dec 15, 2024
@kamalq97 kamalq97 marked this pull request as ready for review December 15, 2024 14:14
@ShirleyDenkberg ShirleyDenkberg self-assigned this Dec 15, 2024
@ShirleyDenkberg
Copy link
Contributor

@dorschw Doc review completed.

Copy link
Contributor

@dorschw dorschw left a comment

Choose a reason for hiding this comment

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

Good job

Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.yml Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2_test.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2_test.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2_test.py Outdated Show resolved Hide resolved
@kamalq97 kamalq97 marked this pull request as draft January 12, 2025 11:40
@kamalq97 kamalq97 requested a review from JasBeilin January 12, 2025 12:51
@kamalq97 kamalq97 marked this pull request as ready for review January 12, 2025 12:52
Copy link
Contributor

@JasBeilin JasBeilin left a comment

Choose a reason for hiding this comment

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

Looks great overall, check my comments.

Packs/ArcherRSA/ReleaseNotes/1_3_0.md Outdated Show resolved Hide resolved
@@ -997,6 +1006,7 @@ Search for records inside the given application
| fullData | Whether to get extended responses with all of the data regarding this search. For example, "fullData=true" | Required |
| isDescending | Whether to order by descending order. Possible values are: "true", "false". | Optional |
| levelId | The Level ID to use for searching. This argument is relevant when fullData is True. If empty, the command by default takes the first level ID. | Optional |
| xmlForFiltering | The raw XML filter condition. For example: "DateComparisonFilterCondition" or "TextFilterCondition" XML element. | Optional |
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a good place to insert something like:
"Note, using DateComparisonFilterCondition or similar time-querying conditions might conflict with fetching incidents and is not supported."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As this is a general command and not "fetch-incidents", I did not implement this limitation here (consistent with the requirements on Jira)

Packs/ArcherRSA/Integrations/ArcherV2/README.md Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/README.md Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.py Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.yml Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.yml Outdated Show resolved Hide resolved
Packs/ArcherRSA/Integrations/ArcherV2/ArcherV2.yml Outdated Show resolved Hide resolved
@kamalq97 kamalq97 marked this pull request as draft January 27, 2025 07:02
@kamalq97 kamalq97 marked this pull request as ready for review February 2, 2025 15:04
@kamalq97 kamalq97 requested a review from JasBeilin February 2, 2025 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-approved enhancement ignore-auto-bump-version Not to run autobump release notes job on this pr. python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants