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

feat: Adding version check to all API methods #440

Merged
merged 16 commits into from
Nov 8, 2024
Merged

Conversation

anskhanson
Copy link
Collaborator

Checklist:

  • Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • Bench test new/modified APIs by using and modifying the code in the example for the API method
  • [n/a] Add new classes to rst files, located at: \doc\source\api
  • Generate documentation
  • Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • Check that test code coverage is at least 80% when Sherlock is running

@github-actions github-actions bot added testing Anything related to tests dependencies Related with project dependencies maintenance Package and maintenance related documentation Improvements or additions to documentation labels Nov 5, 2024
@anskhanson anskhanson self-assigned this Nov 5, 2024
@github-actions github-actions bot removed dependencies Related with project dependencies maintenance Package and maintenance related labels Nov 5, 2024
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

Attention: Patch coverage is 85.52036% with 32 lines in your changes missing coverage. Please review.

Project coverage is 57.91%. Comparing base (f3901cd) to head (1dd386e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/ansys/sherlock/core/launcher.py 55.00% 9 Missing ⚠️
src/ansys/sherlock/core/sherlock.py 11.11% 8 Missing ⚠️
src/ansys/sherlock/core/common.py 58.82% 7 Missing ⚠️
src/ansys/sherlock/core/utils/version_check.py 76.19% 5 Missing ⚠️
src/ansys/sherlock/core/pysherlock_logging.py 94.73% 2 Missing ⚠️
src/ansys/sherlock/core/errors.py 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #440      +/-   ##
==========================================
+ Coverage   56.93%   57.91%   +0.97%     
==========================================
  Files          21       23       +2     
  Lines        4742     4878     +136     
==========================================
+ Hits         2700     2825     +125     
- Misses       2042     2053      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@anskhanson anskhanson linked an issue Nov 5, 2024 that may be closed by this pull request
@anskhanson anskhanson changed the title Adding version check to all API methods feat: Adding version check to all API methods Nov 6, 2024
src/ansys/sherlock/core/analysis.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/analysis.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/common.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/grpc_stub.py Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Show resolved Hide resolved
src/ansys/sherlock/core/layer.py Outdated Show resolved Hide resolved
src/ansys/sherlock/core/lifecycle.py Show resolved Hide resolved
src/ansys/sherlock/core/utils/version_check.py Outdated Show resolved Hide resolved
anskhanson and others added 15 commits November 7, 2024 13:00
…t set. Otherwise it was getting set to current version which might be before the min_version.
… the new changes, rather than always the latest version. Client used to raise 2 exceptions if Sherlock did not start. One was for sherlock not starting and another was that it was unable to connect to Sherlock. Now it will raise 1 exception. If Sherlock cannot start it will raise that exception. If Sherlock starts but PySherlock cannot connect it will raise that exception.
@anskhanson anskhanson merged commit 6559568 into main Nov 8, 2024
28 checks passed
@anskhanson anskhanson deleted the keith/versioning branch November 8, 2024 20:34
@anskhanson anskhanson linked an issue Nov 13, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing Anything related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add update copy and delete potting regions Pysherlock API to get Sherlock Default Project Directory
3 participants