Skip to content

REFACTOR: Improve API and security in Desktop #5892

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

Merged
merged 27 commits into from
Apr 1, 2025

Conversation

SMoraisAnsys
Copy link
Collaborator

@SMoraisAnsys SMoraisAnsys commented Mar 10, 2025

Description

The PR consist in a refactoring of the desktop module to clean it and strengthen the calls related to subprocess. On top of that, a new section has been added to the documentation to notify about the risk of using insecure commands.
Changes are:

  • use __ method instead of _ method when it makes sense;
  • move inner methods to other modules when possible;
  • use @min_aedt_version("2023.2") on simulation related property / methods;
  • reorder private / public / property into subsets;
  • add documentation on security considerations;
  • strengthen methods related to subprocess to avoid launching abitrary executable on the system.

Issue linked

#5504

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have agreed with the Contributor License Agreement (CLA).

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added the testing Anything related to testing label Mar 10, 2025
Copy link

codecov bot commented Mar 11, 2025

Codecov Report

Attention: Patch coverage is 78.57143% with 57 lines in your changes missing coverage. Please review.

Project coverage is 85.11%. Comparing base (761344a) to head (2f98223).
Report is 2 commits behind head on main.

❌ Your patch status has failed because the patch coverage (78.57%) is below the target coverage (85.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5892      +/-   ##
==========================================
+ Coverage   85.10%   85.11%   +0.01%     
==========================================
  Files         165      165              
  Lines       62807    62812       +5     
==========================================
+ Hits        53449    53461      +12     
+ Misses       9358     9351       -7     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

MaxJPRey
MaxJPRey previously approved these changes Mar 11, 2025
Copy link
Collaborator

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

Nice work!

MaxJPRey
MaxJPRey previously approved these changes Mar 17, 2025
@wiz-inc-572fc38784
Copy link

wiz-inc-572fc38784 bot commented Mar 27, 2025

Wiz Scan Summary

Scanner Findings
Vulnerability Finding Vulnerabilities
Data Finding Sensitive Data 1 Info
Secret Finding Secrets
IaC Misconfiguration IaC Misconfigurations
Total 1 Info

View scan details in Wiz

To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension.

@SMoraisAnsys SMoraisAnsys self-assigned this Mar 27, 2025
@SMoraisAnsys
Copy link
Collaborator Author

@Samuelopez-ansys @maxcapodi78 This is ready :)

@Samuelopez-ansys Samuelopez-ansys merged commit 52fb9c6 into main Apr 1, 2025
46 of 47 checks passed
@Samuelopez-ansys Samuelopez-ansys deleted the refact/desktop-to-deprecate-and-improve-sec branch April 1, 2025 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing Anything related to testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants