Implement a proper testing framework (GSoC23) #1101
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
danigm
reviewed
Aug 16, 2023
There was a problem hiding this comment.
Looks pretty good. We can try to do some small improvements before merging it:
- Add a new file
test/README.mdwith some basic documentation aboutget_tested_mock_packageand how to use it. Basically a guide to how to write new tests. - Review default values in
FakePkgand remove from tests when it's not needed, for example{'content': ''}, could just be{}, to create just the file with default values. - Create common fake packages to reuse in different tests, for example
test/mocks/packages.pyand there we can have the fake packages defined likeconfig_files,bad_crc_uncompressed,python3_icecream_leftovers, etc. So in tests we just need to import. We can do this just for packages that are useful in more than one test and for "large" fake package definitions.
In the future we can add even more improvements like start to use the faker module to randomize some of the fake data, like file content and other data.
This is my first pull request on how I have tried to mock a test, I used FakePkg class and tried to modify an existing test. I have created a new helper function get_tested_mock_package which helps to create a FakePkg obj, this object is further passed to tests.
…e API, instead of just kwargs
modified to use dict methods in get_tested_mock_package
Test that required FakePkg has been abstracted and hence do not necessarily need to be imported
This commit removes two binary rpm files that were used for testing docs and docs modules in python packages, for which tests are mocking has been implemented
In add_file_with_content function, changes were made to check for any type prior it was only checked for True
created an another test (test_python_dependencies_metadata2) which helps to get rid of a binary file python310-jupyter-server-fileid-0.9.0-7.2.noarch.rpm
In this commit, I have mocked another metadata test, that checks for metadata content in python packages. With this test we can get rid of binary file: python310-scikit-build-0.17.2-41.1.noarch.rpm. The new test function is test_python_dependencies_metadata3
…tatements In this commit, I have completely removed previous paramatrized tests for 5 binaries, and also added another test test_python_dependencies_metadata4
…rom metadata and requires.txt
As this is managed by PR-CI, No need of checking them again on branch
Pkg and FakePkg both use _gather_dep_info and _gather_aux so moved them to their parent class AbstractPkg
…ested_mock_package Added a new helper method in FakePkg called create_files this will avoid if else chain in get_tested_mock_package utility
added a new helper method in FakePkg class which is initiate_files_base_data, this is used to initiate fakepkg class with basic files data after setting up custom metadata; removed a binary other binary is required for file
removed binary test/binary/python39-blinker-1.6.2
There are total 2 tests and 2 binaries one binary test/binary/config-files-1.0-0.x86_64.rpm is removed and another binary test/binary/logrotate-0-0.x86_64.rpm is used by test/test_logrotate.py and hence it isn't removed
each file by default created empty content; no need to mention create_dir as False; by default it is false
I will work on this in future. So for now, I think its time to open this pr for review. |
|
Good work! Let's merge this and continue working on test improvements in following pull requests |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR is intended work of Google Summer of Code 2023 Project assigned to me.
This project aims to get rid of binary rpm packages that are being used solely for testing rpmlint codebase. Since RPM packages consume relatively more space and more time to run tests, mocking them is a way to get rid of those heavy binary rpm files and make test little more efficient.
Description
In this PR, I have mainly worked on
PythonChecktests,DuplicatesChecktests andConfigFilesChecktests which I eventually able to remove 18 binary files after mocking those tests. This approach can be carry forwarded to other checks as well.Note: This is a copy of previous pull request: