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

Change --Xpath Versions While Using Chasten Analyze #90

Merged
merged 25 commits into from
Nov 3, 2023
Merged

Conversation

VitalJoseph
Copy link
Collaborator

When creating a pull request to add a new feature or alter an existing one,
there are some important elements to include to help our team review and process it more efficiently.

  1. Make sure the title is descriptive of what the PR includes. Don't mention issue names/numbers; save that for the description.

  2. List the names of those who contributed to the project.

Vital Joseph, Finley Banas, Keven Duverglas, Jason

  1. Link the issue the pull request is meant to fix/resolve.

https://github.com/AstuteSource/chasten/tree/issue-%2315

  1. Describe the contents and goal of the pull request.

The contents of this pull request consists of changes to the command line interface for the analyze function in chasten as well as code that allows the user to specify which xpath parser is ran while parsing the the xpath patterns in the checks.yml file.

  1. Will coverge be maintained/increased?

The coverage that is maintained/increased has to do with the speed of chasten analyze. Using different versions of xpath we can run the analyze command faster based on what program the user is analyzing.

  1. What operating systems has this been tested on? How were these tests conducted?

Mac and Windows

  1. Include a code block and/or screenshots displaying the functionality of your feature, if applicable/possible.

poetry run chasten analyze multicounter --config /Users/finle/chasten/astute_subjects/chasten-configuration -xp 1.0 --search-path /Users/finle/chasten/astute_subjects/subject_forks/multicounter/ --save-directory /Users/finle/chasten/astute_subjects/subject_forks/multicounter --debug-level ERROR --debug-dest SYSLOG --save

image

poetry run chasten analyze multicounter --config /Users/finle/chasten/astute_subjects/chasten-configuration -xp 2.0 --search-path /Users/finle/chasten/astute_subjects/subject_forks/multicounter/ --save-directory /Users/finle/chasten/astute_subjects/subject_forks/multicounter --debug-level ERROR --debug-dest SYSLOG --save

image

Mark as a draft until it is ready to begin the reviewing process, then tag our Lead Software Architect, Lauren Nevill,
our Principal Software Engineer, Bergas Batara, and our Founding Engineer, Gregory Kapfhammer
when you mark it as ready for review.

@Finley8
Copy link
Collaborator

Finley8 commented Oct 16, 2023

@VitalJoseph VitalJoseph added bug Something isn't working ready-for-review This pull request is ready for review labels Oct 16, 2023
@laurennevill
Copy link
Collaborator

@gkapfham, if your work fixes the build issues in this PR, then this would be priority 3

@KevenDuverglas
Copy link
Collaborator

This is a great enhancement that will allow for the improved speed of Chasten. And will allow Chasten to have more variety in its
usage.

@hayleepierce hayleepierce removed the ready-for-review This pull request is ready for review label Oct 30, 2023
@bergasanargya
Copy link

Can you explain further your feature here @VitalJoseph @Finley8? How can this feature be helpful on the speed running the chasten software? What implementation do you have that could help chasten?

@KevenDuverglas KevenDuverglas added ready-for-review This pull request is ready for review and removed bug Something isn't working labels Nov 1, 2023
@KevenDuverglas KevenDuverglas added the enhancement New feature or request label Nov 1, 2023
Copy link
Collaborator

@KevenDuverglas KevenDuverglas left a comment

Choose a reason for hiding this comment

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

I think this would be a great addition to chasten.

@KevenDuverglas KevenDuverglas requested review from laurennevill and removed request for gkapfham November 1, 2023 13:30
@KevenDuverglas KevenDuverglas marked this pull request as ready for review November 1, 2023 13:42
@gkapfham
Copy link
Collaborator

gkapfham commented Nov 1, 2023

Hello @VitalJoseph can you please @-mention the specific people who were the main collaborators for this feature in your description of the PR?

@gkapfham
Copy link
Collaborator

gkapfham commented Nov 1, 2023

Hello @Finley8 and @VitalJoseph can you please answer the questions that @bergasanargya raised?

@Finley8
Copy link
Collaborator

Finley8 commented Nov 3, 2023

Hello @bergasanargya, thanks for the question. The new implementation will help speed up the chasten analyze command while analyzing multiple programs. The user can also determine whether XPath 1 or XPath 2 analyzes their program quicker by looking at the timer module that is returned after a check.

@laurennevill laurennevill merged commit 1e73b89 into master Nov 3, 2023
3 checks passed
@laurennevill laurennevill deleted the issue-#15 branch November 3, 2023 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ready-for-review This pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow for the Specification of Either XPath Version 1 or XPath Version 2 When Running Checks
8 participants