Correctly loading the methods from relatively imported classes #364

kunalvishwasrao · 2024-07-02T19:37:11Z

After merging #360 all the previous issues were fixed but when I created step implementations inside a class and tried use those steps inside specs, I was getting an error with positional arguments missing.

This issue arises because the update_step_resgistry_with_class() method inside the impl_loader.py file is unable to fetch all the methods inside that step implementation file inside get_all_methods_in() method due to the file_path being a relative file path.

Resolving the relative file path into an absolute file path inside update_step_resgistry_with_class() method #365

Hey @BugDiver, @zabil, can you please help me merge this PR to resolve this issue.
Apologies for this follow-up PR, missed this update in the previous PR.

Thanks!😄

getgauge/impl_loader.py

zabil · 2024-07-03T09:14:33Z

I'll take a look at this. Thanks for raising #360 will use the info to test it locally.

kunalvishwasrao · 2024-07-03T11:18:04Z

I'll take a look at this. Thanks for raising #360 will use the info to test it locally.

Sure, thanks a lot @zabil😄

chadlwilson · 2024-07-03T11:54:06Z

It seems pretty clear to me that this code needs automated tests or this is going to be broken again at some point. Is there any reason it can't be tested?

Bumps the pip-dependencies group with 2 updates: [importlib-metadata](https://github.com/python/importlib_metadata) and [setuptools](https://github.com/pypa/setuptools). Updates `importlib-metadata` from 7.1.0 to 7.2.1 - [Release notes](https://github.com/python/importlib_metadata/releases) - [Changelog](https://github.com/python/importlib_metadata/blob/main/NEWS.rst) - [Commits](python/importlib_metadata@v7.1.0...v7.2.1) Updates `setuptools` from 70.0.0 to 70.1.0 - [Release notes](https://github.com/pypa/setuptools/releases) - [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst) - [Commits](pypa/setuptools@v70.0.0...v70.1.0) --- updated-dependencies: - dependency-name: importlib-metadata dependency-type: direct:production update-type: version-update:semver-minor dependency-group: pip-dependencies - dependency-name: setuptools dependency-type: direct:production update-type: version-update:semver-minor dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Kunal Vishwasrao <[email protected]>

…tgauge#362) Bumps the pip-dependencies group with 3 updates in the / directory: [debugpy](https://github.com/microsoft/debugpy), [importlib-metadata](https://github.com/python/importlib_metadata) and [setuptools](https://github.com/pypa/setuptools). Updates `debugpy` from 1.8.1 to 1.8.2 - [Release notes](https://github.com/microsoft/debugpy/releases) - [Commits](microsoft/debugpy@v1.8.1...v1.8.2) Updates `importlib-metadata` from 7.2.1 to 8.0.0 - [Release notes](https://github.com/python/importlib_metadata/releases) - [Changelog](https://github.com/python/importlib_metadata/blob/main/NEWS.rst) - [Commits](python/importlib_metadata@v7.2.1...v8.0.0) Updates `setuptools` from 70.1.0 to 70.1.1 - [Release notes](https://github.com/pypa/setuptools/releases) - [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst) - [Commits](pypa/setuptools@v70.1.0...v70.1.1) --- updated-dependencies: - dependency-name: debugpy dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies - dependency-name: importlib-metadata dependency-type: direct:production update-type: version-update:semver-major dependency-group: pip-dependencies - dependency-name: setuptools dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Kunal Vishwasrao <[email protected]>

Signed-off-by: Kunal Vishwasrao <[email protected]>

Signed-off-by: BugDiver <[email protected]> Signed-off-by: Kunal Vishwasrao <[email protected]>

…on to getgauge#360) Signed-off-by: Kunal Vishwasrao <[email protected]>

Correctly loading the methods from relatively imported classes (getgauge#365) Signed-off-by: Kunal Vishwasrao <[email protected]> Co-authored-by: Zabil Cheriya Maliackal <[email protected]> Signed-off-by: Kunal Vishwasrao <[email protected]>

…ds-from-classes

into feature/correctly-load-impl-methods-from-classes

…tps://github.com/kunalvishwasrao/gauge-python into feature/correctly-load-impl-methods-from-classes

zabil · 2024-07-03T16:01:27Z

Yeah I agree. I am having a tough time testing it locally at the moment because the install scripts are not working as expected and there are some python version issues.

@kunalvishwasrao is there a way you can look into some unit tests for this logic?

kunalvishwasrao · 2024-07-03T18:23:18Z

Yeah sure @zabil I'll look into unit tests for testing this logic.
Thanks 😄

…gauge#365) Signed-off-by: Kunal Vishwasrao <[email protected]>

Signed-off-by: Kunal Vishwasrao <[email protected]>

kunalvishwasrao · 2024-07-04T16:26:11Z

Hey @zabil,

I've added a unittest file to test the update_step_resgistry_with_class() method for relative imports of methods inside a class as well as outside as suggested. Can you please review it and let me know if its fine.

Thanks!😄

getgauge/impl_loader.py

zabil · 2024-07-04T18:02:00Z

tests/test_impl_loader.py

+        os.chdir('tests')
+        method_list = update_step_resgistry_with_class(Sample(), self.relative_file_path)
+        os.chdir(curr_dir)
+        self.assertEqual(2, len(method_list))


Suggested change

self.assertEqual(2, len(method_list))

self.assertEqual(["Greet <name> from inside the class",

"Greet <name> from outside the class"],

[method.step_text for method in method_list])```

Will be good to make this assertion specific

zabil · 2024-07-04T18:02:49Z

tests/test_impl_loader.py

+    def test_update_step_resgistry_with_class(self):
+        curr_dir = os.getcwd()
+        os.chdir('tests')
+        method_list = update_step_resgistry_with_class(Sample(), self.relative_file_path)


Suggested change

method_list = update_step_resgistry_with_class(Sample(), self.relative_file_path)

method_list = update_step_registry_with_class(Sample(), self.relative_file_path)

I understand this is not related to you change but will be a good time to fix the typo in the test and the implementation, if that's ok.

Sure sure, will do it 😄

Signed-off-by: Kunal Vishwasrao <[email protected]>

kunalvishwasrao · 2024-07-04T18:55:45Z

Hey @zabil,

Updated the method name and unttests as suggested. Can you please let me know if it looks fine.

Thank!😄

gaugebot · 2024-07-05T09:05:53Z

@kunalvishwasrao Thank you for contributing to gauge-python. Your pull request has been labeled as a release candidate 🎉🎉.

Merging this PR will trigger a release.

Please bump up the version as part of this PR.

Instructions to bump the version can found at CONTRIBUTING.md

If the CONTRIBUTING.md file does not exist or does not include instructions about bumping up the version, please looks previous commits in git history to see what changes need to be done.

Signed-off-by: Kunal Vishwasrao <[email protected]>

kunalvishwasrao · 2024-07-05T14:29:43Z

Hey @zabil,

Thanks for the review and approval!😄

…lasses

zabil reviewed Jul 3, 2024

View reviewed changes

getgauge/impl_loader.py Outdated Show resolved Hide resolved

kunalvishwasrao force-pushed the feature/correctly-load-impl-methods-from-classes branch from eeef098 to 4161583 Compare July 3, 2024 13:46

dependabot bot and others added 6 commits July 3, 2024 19:26

Support for relative imports to reuse step impls

821ea86

Signed-off-by: Kunal Vishwasrao <[email protected]>

Update release dependencies

0aa4247

Signed-off-by: BugDiver <[email protected]> Signed-off-by: Kunal Vishwasrao <[email protected]>

Correctly loading the methods from relatively imported classs (additi…

ae4b50e

…on to getgauge#360) Signed-off-by: Kunal Vishwasrao <[email protected]>

Update getgauge/impl_loader.py

bf770bf

Correctly loading the methods from relatively imported classes (getgauge#365) Signed-off-by: Kunal Vishwasrao <[email protected]> Co-authored-by: Zabil Cheriya Maliackal <[email protected]> Signed-off-by: Kunal Vishwasrao <[email protected]>

kunalvishwasrao force-pushed the feature/correctly-load-impl-methods-from-classes branch from f6ef53b to bf770bf Compare July 3, 2024 13:56

kunalvishwasrao and others added 3 commits July 3, 2024 19:42

Merge branch 'getgauge:master' into feature/correctly-load-impl-metho…

45e85a6

…ds-from-classes

Merge branch 'master' of https://github.com/kunalvishwasrao/gauge-python

7490270

into feature/correctly-load-impl-methods-from-classes

Merge branch 'feature/correctly-load-impl-methods-from-classes' of ht…

a1aac55

…tps://github.com/kunalvishwasrao/gauge-python into feature/correctly-load-impl-methods-from-classes

kunalvishwasrao added 3 commits July 4, 2024 21:27

Returning method_list in update_step_resgistry_with_class method (get…

6a01662

…gauge#365) Signed-off-by: Kunal Vishwasrao <[email protected]>

Adding test class for relative import unittest (getgauge#365)

2e0c37a

Signed-off-by: Kunal Vishwasrao <[email protected]>

Adding unittest for relative import (getgauge#365)

b5ea2aa

Signed-off-by: Kunal Vishwasrao <[email protected]>

zabil requested changes Jul 4, 2024

View reviewed changes

getgauge/impl_loader.py Show resolved Hide resolved

zabil requested changes Jul 4, 2024

View reviewed changes

kunalvishwasrao added 2 commits July 5, 2024 00:14

Renaming method to update_step_registry_with_class (getgauge#365)

d322292

Signed-off-by: Kunal Vishwasrao <[email protected]>

Updating unittest for impl loader (getgauge#365)

ec73984

Signed-off-by: Kunal Vishwasrao <[email protected]>

zabil added the ReleaseCandidate label Jul 5, 2024

zabil approved these changes Jul 5, 2024

View reviewed changes

Bumping up python package version (getgauge#365)

9234768

Signed-off-by: Kunal Vishwasrao <[email protected]>

Merge branch 'master' into feature/correctly-load-impl-methods-from-c…

719f112

…lasses

zabil enabled auto-merge (squash) July 6, 2024 20:30

zabil merged commit 76450d7 into getgauge:master Jul 6, 2024
15 checks passed

chadlwilson mentioned this pull request Sep 27, 2024

Update Python unittests and apply Python standard #394

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Correctly loading the methods from relatively imported classes #364

Correctly loading the methods from relatively imported classes #364

kunalvishwasrao commented Jul 2, 2024 •

edited

Loading

zabil commented Jul 3, 2024

kunalvishwasrao commented Jul 3, 2024

chadlwilson commented Jul 3, 2024

zabil commented Jul 3, 2024

kunalvishwasrao commented Jul 3, 2024

kunalvishwasrao commented Jul 4, 2024

zabil Jul 4, 2024

zabil Jul 4, 2024

kunalvishwasrao Jul 4, 2024

kunalvishwasrao commented Jul 4, 2024

gaugebot bot commented Jul 5, 2024

kunalvishwasrao commented Jul 5, 2024

-        self.assertEqual(2, len(method_list))
+        self.assertEqual(["Greet <name> from inside the class",
+            "Greet <name> from outside the class"],
+        [method.step_text for method in method_list])```
+Will be good to make this assertion specific

	method_list = update_step_resgistry_with_class(Sample(), self.relative_file_path)
	method_list = update_step_registry_with_class(Sample(), self.relative_file_path)

Correctly loading the methods from relatively imported classes #364

Correctly loading the methods from relatively imported classes #364

Conversation

kunalvishwasrao commented Jul 2, 2024 • edited Loading

zabil commented Jul 3, 2024

kunalvishwasrao commented Jul 3, 2024

chadlwilson commented Jul 3, 2024

zabil commented Jul 3, 2024

kunalvishwasrao commented Jul 3, 2024

kunalvishwasrao commented Jul 4, 2024

zabil Jul 4, 2024

Choose a reason for hiding this comment

zabil Jul 4, 2024

Choose a reason for hiding this comment

kunalvishwasrao Jul 4, 2024

Choose a reason for hiding this comment

kunalvishwasrao commented Jul 4, 2024

gaugebot bot commented Jul 5, 2024

Please bump up the version as part of this PR.

kunalvishwasrao commented Jul 5, 2024

kunalvishwasrao commented Jul 2, 2024 •

edited

Loading