feat(hypothesis): Added hypothesis as an option #134

ayeankit · 2023-06-20T17:59:51Z

Pull Request description

Issue #23

How to test these changes

...

Pull Request checklists

This PR is a:

bug-fix
new feature
maintenance

About this PR:

it includes tests.
the tests are executed on CI.
the tests generate log file(s) (path).
pre-commit hooks were executed locally.
this PR requires a project documentation update.

Author's checklist:

I have reviewed the changes and it contains no misspelling.
The code is well commented, especially in the parts that contain more complexity.
New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

xmnlab · 2023-06-20T21:00:45Z

src/scicookie/{{cookiecutter.project_slug}}/tests/test_{{cookiecutter.project_slug}}.py

@@ -1,4 +1,5 @@
 """Tests for `{{ cookiecutter.project_slug }}` package."""
+{%- if cookiecutter.use_pytest == "yes" -%}


could you revisit this file again?

keep in mind that it would be possible to have both pytest and hypothesis.
also please, check the result locally to see what is the final result for this file for all the 3 possibilities (pytest, hypothesis, pytest + hypothesis).

also pay attention on the jinja2 modifications %-/-%, %+/+% or just % .. and the combinations among them

src/scicookie/{{cookiecutter.project_slug}}/pyproject.toml

ayeankit · 2023-06-20T22:52:53Z

@xmnlab and @Saransh-cpp I do not know why its failing the main/test (pull_request). Can you review it?

xmnlab · 2023-06-20T23:06:17Z

@xmnlab and @Saransh-cpp I do not know why its failing the main/test (pull_request). Can you review it?

all the files need to end with one empty line, no more, no less.
and this PR has 2 files that that problem: https://github.com/osl-incubator/scicookie/actions/runs/5328022194/jobs/9652160700?pr=134#step:6:21

Fixing src/scicookie/cookiecutter.json
Fixing src/scicookie/{{cookiecutter.project_slug}}/pyproject.toml

these issues should be caught by the pre-commit locally. check if you have it installed with pre-commit install

xmnlab · 2023-06-20T23:06:34Z

and run locally pre-commit run --all-files --verbose

xmnlab · 2023-06-20T23:16:18Z

src/scicookie/{{cookiecutter.project_slug}}/Makefile

 .PHONY:test
 test: ## run tests quickly with the default Python
 	pytest
-{% endif %}
+{%- endif +%}
+{% if cookiecutter.use_hypothesis == "yes" -%}


one problem here is that,
if pytest == yes and hypothesis == yes, it will create the test target twice.

ayeankit · 2023-06-21T12:52:36Z

hey @xmnlab and @Saransh-cpp again these test cases are failing , I am using pre-commit locally but here it not passing on gh workflows. I think I am not correctly dealing with makefile when pytest + hypothesis both options are selected. Can you look into it?

src/scicookie/{{cookiecutter.project_slug}}/tests/test_{{cookiecutter.package_slug}}.py

Anavelyz

@ayeankit, it seems that the docstrings are giving problems, I left you some suggestions. I hope it works.

src/scicookie/{{cookiecutter.project_slug}}/tests/test_{{cookiecutter.package_slug}}.py

ayeankit · 2023-06-26T19:22:40Z

@Anavelyz after changing the auto-string, it's still failing the gh actions. Can you see why its failing?

xmnlab · 2023-06-26T19:38:23Z

I didn't check the CI error ..but if it is just about the docstring .. just keep it shorter.
as it is just a placeholder, it does't matter too much.

ayeankit · 2023-06-28T01:14:02Z

@xmnlab I added the documentation in guide.md , contributing.md and Readme.md files as suggested. Can you review it once again?

Saransh-cpp · 2023-06-28T13:17:12Z

README.md

-  - Flexible build system selection: Choose between popular build systems like
-      [Poetry](https://python-poetry.org/) or [Flit](https://flit.pypa.io) based
-      on your preference.


I think this shouldn't have been removed.

Saransh-cpp · 2023-06-28T13:19:17Z

docs/guide.md

+  -  [**Pytest**](https://docs.pytest.org/en/7.3.x/contents.html): is a powerful property-based testing library for Python. It generates test cases based on properties, uncovering bugs and corner cases. Learn more in the Hypothesis documentation.
+
+- [**Hypothesis**](https://hypothesis.readthedocs.io/): is a powerful property-based testing library for Python. It generates test cases based on properties, uncovering bugs and corner cases. Learn more in the Hypothesis documentation.


Some formatting issues and repetition here 🙂

README.md

Co-authored-by: Saransh Chopra <saransh0701@gmail.com>

ayeankit · 2023-06-28T18:12:56Z

@xmnlab I changed the files as suggested by @Saransh-cpp. Can you review it once again?

docs/guide.md

xmnlab

@ayeankit in general it looks good. thanks!
could you just improve a bit the documentation in the template side please?

you can get some ideas from here https://github.com/osl-incubator/scicookie/pull/136/files#diff-f1c71bca02a04da875655ec4b14b5bc1ed65d7c025276bd97efbf97bc464a3b1

In general, you should try to see the documentation from the perspective of a new developer. Maybe a new developer would not know what is pytest or hypothesis.

so maybe 1 or 2 paragraphs about that and a link to the official web/documentation page would be great.

other than that, it looks great :)

Co-authored-by: Ivan Ogasawara <ivan.ogasawara@gmail.com>

ayeankit · 2023-06-29T18:27:55Z

@xmnlab I changed the files as suggested . Can you review it once again?

docs/guide.md

Saransh-cpp · 2023-06-29T19:40:17Z

README.md

  - Flexible build system selection: Choose between popular build systems like
      [Poetry](https://python-poetry.org/) or [Flit](https://flit.pypa.io) based
      on your preference.
+  - Release workflow with semantic release and github actions


This looks unrelated to this PR 🙂

Should be okay though, just moved down

Co-authored-by: Saransh Chopra <saransh0701@gmail.com>

xmnlab

thanks for working on that @ayeankit !

xmnlab · 2023-06-29T20:07:13Z

@ayeankit next time, please provide more information in the Pull Request description section in the first comment in the PR. thanks

github-actions · 2023-07-05T20:54:47Z

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

0.3.0
GitHub release

Your semantic-release bot 📦🚀

ayeankit added 2 commits June 20, 2023 23:28

Added hypothesis

4a5c849

Added hypothesis with last line

cd7d7eb

xmnlab reviewed Jun 20, 2023

View reviewed changes

src/scicookie/{{cookiecutter.project_slug}}/pyproject.toml Outdated Show resolved Hide resolved

xmnlab changed the title ~~Feat(hypotheis): Added hypothesis as an option~~ feat(hypothesis): Added hypothesis as an option Jun 20, 2023

xmnlab reviewed Jun 20, 2023

View reviewed changes

pre-commit -verbose

0485179

ayeankit force-pushed the hypothesis branch from 9ff8afe to 0485179 Compare June 20, 2023 23:58

ayeankit added 3 commits June 21, 2023 17:30

pre-commit erroe solved

d3525eb

makim file changed

2d14b74

modified makefile

8f0550a

ayeankit added 6 commits June 21, 2023 21:33

modified makefile

6802a9b

modified makefile and toml file

450d456

modified makefile

99f8cdb

modified makefile

d77d5c6

modified makefile

b6dcba4

modified makefile

ca65a13

ayeankit force-pushed the hypothesis branch from f3758ab to ca65a13 Compare June 23, 2023 21:23

ayeankit added 2 commits June 26, 2023 22:17

added changes

99dd379

added changes

72025f7

Anavelyz reviewed Jun 26, 2023

View reviewed changes

formatted test_osl

d9ebada

ayeankit force-pushed the hypothesis branch from 5a699cf to d9ebada Compare June 26, 2023 20:17

ayeankit and others added 6 commits June 28, 2023 05:46

added changes

5d36b5e

formatted test_osl

35b18fb

test file changed

d496312

Merge branch 'main' into hypothesis

e0ff366

documentation added

d33571d

Update test_{{cookiecutter.package_slug}}.py

96b8366

Saransh-cpp reviewed Jun 28, 2023

View reviewed changes

ayeankit and others added 3 commits June 28, 2023 20:37

Update README.md

cd3d635

Co-authored-by: Saransh Chopra <saransh0701@gmail.com>

Update README.md

19f3900

Update guide.md

5e147e2

xmnlab reviewed Jun 28, 2023

View reviewed changes

docs/guide.md Show resolved Hide resolved

xmnlab reviewed Jun 28, 2023

View reviewed changes

docs/guide.md Show resolved Hide resolved

xmnlab requested changes Jun 28, 2023

View reviewed changes

ayeankit and others added 4 commits June 29, 2023 21:27

Update docs/guide.md

348599d

Co-authored-by: Ivan Ogasawara <ivan.ogasawara@gmail.com>

Update docs/guide.md

8205a05

Co-authored-by: Ivan Ogasawara <ivan.ogasawara@gmail.com>

Update guide.md

07d6ffd

Update guide.md

da2e552

Update guide.md

ba5e81f

Saransh-cpp reviewed Jun 29, 2023

View reviewed changes

ayeankit and others added 3 commits June 30, 2023 01:20

Update docs/guide.md

4270925

Co-authored-by: Saransh Chopra <saransh0701@gmail.com>

Update docs/guide.md

cc905eb

Co-authored-by: Saransh Chopra <saransh0701@gmail.com>

Update README.md

a4c64ca

xmnlab approved these changes Jun 29, 2023

View reviewed changes

xmnlab merged commit 791ca16 into osl-incubator:main Jun 29, 2023

github-actions bot added the released label Jul 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(hypothesis): Added hypothesis as an option #134

feat(hypothesis): Added hypothesis as an option #134

ayeankit commented Jun 20, 2023

xmnlab Jun 20, 2023

ayeankit commented Jun 20, 2023

xmnlab commented Jun 20, 2023

xmnlab commented Jun 20, 2023

xmnlab Jun 20, 2023

ayeankit commented Jun 21, 2023

Anavelyz left a comment

ayeankit commented Jun 26, 2023

xmnlab commented Jun 26, 2023

ayeankit commented Jun 28, 2023

Saransh-cpp Jun 28, 2023

Saransh-cpp Jun 28, 2023

ayeankit commented Jun 28, 2023

xmnlab left a comment

ayeankit commented Jun 29, 2023

Saransh-cpp Jun 29, 2023

xmnlab left a comment

xmnlab commented Jun 29, 2023

github-actions bot commented Jul 5, 2023

		@@ -1,4 +1,5 @@
		"""Tests for `{{ cookiecutter.project_slug }}` package."""
		{%- if cookiecutter.use_pytest == "yes" -%}

		- [Pytest](https://docs.pytest.org/en/7.3.x/contents.html): is a powerful property-based testing library for Python. It generates test cases based on properties, uncovering bugs and corner cases. Learn more in the Hypothesis documentation.

		- [Hypothesis](https://hypothesis.readthedocs.io/): is a powerful property-based testing library for Python. It generates test cases based on properties, uncovering bugs and corner cases. Learn more in the Hypothesis documentation.

feat(hypothesis): Added hypothesis as an option #134

feat(hypothesis): Added hypothesis as an option #134

Conversation

ayeankit commented Jun 20, 2023

Pull Request description

How to test these changes

Pull Request checklists

Additional information

Reviewer's checklist

xmnlab Jun 20, 2023

Choose a reason for hiding this comment

ayeankit commented Jun 20, 2023

xmnlab commented Jun 20, 2023

xmnlab commented Jun 20, 2023

xmnlab Jun 20, 2023

Choose a reason for hiding this comment

ayeankit commented Jun 21, 2023

Anavelyz left a comment

Choose a reason for hiding this comment

ayeankit commented Jun 26, 2023

xmnlab commented Jun 26, 2023

ayeankit commented Jun 28, 2023

Saransh-cpp Jun 28, 2023

Choose a reason for hiding this comment

Saransh-cpp Jun 28, 2023

Choose a reason for hiding this comment

ayeankit commented Jun 28, 2023

xmnlab left a comment

Choose a reason for hiding this comment

ayeankit commented Jun 29, 2023

Saransh-cpp Jun 29, 2023

Choose a reason for hiding this comment

xmnlab left a comment

Choose a reason for hiding this comment

xmnlab commented Jun 29, 2023

github-actions bot commented Jul 5, 2023