Merge remote-tracking branch 'origin/master' into pypi_publish_and_tag_release

ajmirsky · ajmirsky · commit 0e5f6d302e75 · 2024-12-12T12:51:29.000-05:00
diff --git a/.github/actions/setup-python-build-env/action.yml b/.github/actions/setup-python-build-env/action.yml
@@ -4,8 +4,7 @@ description: "Install everything needed to build"
 runs:
   using: "composite"
   steps:
-  - name: Upgrage pip and install poetry
+  - name: Install poetry
     shell: bash
     run: |
-      pip install --upgrade pip
-      pip install --user "poetry==1.5.1"
+      pipx install poetry
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,21 @@
+### Changes included in this PR 
+
+*(Bug fix, feature, docs update, ...)*
+
+### Current behavior
+
+*Link to an open issue here...*
+
+### New behavior
+
+*If this is a feature change, describe the new behavior*
+
+### Impact
+
+*Describe breaking changes, including changes a users might need to make due to this PR*
+
+### Checklist
+
+1. [ ] Does your submission pass the existing tests?
+2. [ ] Are there new tests that cover these additions/changes? 
+3. [ ] Have you linted your code locally before submission?
diff --git a/.github/workflows/inactive-issue.yml b/.github/workflows/inactive-issue.yml
@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -16,6 +16,7 @@ jobs:
         - "3.10"
         - "3.11"
         - "3.12"
+        - "3.13"
     steps:
       - uses: actions/checkout@master
       - name: Set up Python ${{ matrix.version }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Change log
 
+## 2.0.0-rc.3 (2024-12-09)
+- [#665](https://github.com/mobilityhouse/ocpp/pull/665) chore: Updated Python setup action to version v5 by @jainmohit2001
+- [#663](https://github.com/mobilityhouse/ocpp/pull/663) bugfix: Changed total_cost type from Optional[int] to Optional[float] by @jainmohit2001
+- [#667](https://github.com/mobilityhouse/ocpp/pull/667) feat: Added optional logger param to ChargePoint class by @jainmohit2001
+- [#686](https://github.com/mobilityhouse/ocpp/pull/666) bugfix: Handling UnicodeDecodeError in unpack function by @jainmohit2001
+- [#668](https://github.com/mobilityhouse/ocpp/pull/668) chore: Update CODEOWNERS by @jainmohit2001
+- [#652](https://github.com/mobilityhouse/ocpp/pull/652) add executor to validate_payload by @drc38
+- [#629](https://github.com/mobilityhouse/ocpp/pull/629) fix typo for InternalError in exceptions.py by @hhuseyinpay
+- [#679](https://github.com/mobilityhouse/ocpp/pull/679) Add issue templates by @mdwcrft
+- [#686](https://github.com/mobilityhouse/ocpp/pull/686) Update readme - ocpp 2 edition 3 is supported by @wafa-yah
+- [#678](https://github.com/mobilityhouse/ocpp/pull/678) Disable threads if messages.ASYNC_VALIDATION = False by @astrand
+- [#685](https://github.com/mobilityhouse/ocpp/pull/685) Test with python 3.13 by @drc38
+- [#673](https://github.com/mobilityhouse/ocpp/pull/673) chore: Added inactive issue workflow by @jainmohit2001
+
 ## 2.0.0-rc.2 (2024-06-18)
 
 - [#315](https://github.com/mobilityhouse/ocpp/pull/315) Allow to skip schema validation in `ChargePoint.call()`. Thanks [@esiebert](https://github.com/esiebert)!
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{ email }}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+## Contributing
+
+[fork]: /fork
+[pr]: /compare
+[style]: https://standardjs.com/
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
+
+## Issues and PRs
+
+If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
+
+We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
+
+Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository.
+2. Create a new branch: `git checkout -b my-branch-name`.
+3. Configure and install the dependencies: `poetry install`.
+4. Make sure the tests pass on your machine: `make install & make tests`
+5. Make your change, add tests, and make sure the tests still pass.
+6. Push to your fork and [submit a pull request][pr] and complete the information in the pull request template.
+
+## Linting requirements
+
+using `make install & make tests` will also run the following linters:
+
+- [Black: The uncompromising Python code formatter](https://black.readthedocs.io/en/stable/)
+- [isort your imports, so you don't have to](https://pycqa.github.io/isort/)
+- [flake8: Your Tool For Style Guide Enforcement](https://flake8.pycqa.org/en/latest/)
+
+using `make format` will run isort and black and apply any formatting suggestions from them
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)
diff --git a/Makefile b/Makefile
@@ -18,7 +18,7 @@ help:
 	@echo "  release version=<sem. version>   bumps the project version to <sem. version>, using poetry;"
 	@echo "                                   Updates also docs/source/conf.py version;"
 	@echo "                                   If no version is provided, poetry outputs the current project version"
-	@echo "  test                             run all the tests and linting"
+	@echo "  tests                            run all the tests and linting"
 	@echo "  update                           updates the dependencies in poetry.lock"
 	@echo ""
 	@echo "Check the Makefile to know exactly what each target is doing."
@@ -37,7 +37,7 @@ docs: .install-poetry
 	poetry run sphinx-build -b html docs/source docs/build
 
 format: .install-poetry
-	poetry run isort ocpp tests  && poetry run black ocpp tests
+	poetry run isort ocpp tests && poetry run black ocpp tests
 
 tests: .install-poetry
 	poetry run black --check --diff ocpp tests
diff --git a/README.rst b/README.rst
@@ -203,6 +203,14 @@ To lower the logs for this package only use the following code:
   logging.getLogger('ocpp').setLevel(level=logging.DEBUG)
   logging.getLogger('ocpp').addHandler(logging.StreamHandler())
 
+Aknowledgements
+---------------
+
+Till the end of 2024, this project has been lead and maintained by `Auke Oosterhoff`_ and
+`Jared Newell`_. We thank them for work their work! 
+
+Since than, the project is lead by `Chad Meadowcroft`_, `Mohit Jain`_ and `Patrick Roelke`_.
+
 License
 -------
 
@@ -217,3 +225,9 @@ Attribution-NoDerivatives 4.0 International Public License.
 .. _rtd: https://ocpp.readthedocs.io/en/latest/index.html
 .. _The Mobility House: https://www.mobilityhouse.com/int_en/
 .. _websockets: https://pypi.org/project/websockets/
+
+.. _Auke Oosterhoff:  https://github.com/orangetux
+.. _Jared Newell: https://github.com/Jared-Newell-Mobility
+.. _Chad Meadowcroft: https://github.com/mdwcrft
+.. _Mohit Jain: https://github.com/jainmohit2001
+.. _Patrick Roelke: https://github.com/proelke
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,33 @@
+# Security Policy
+
+This document outlines security procedures and general policies for this OCPP project.
+
+## Supported Versions
+
+The currently supported versions of this OCPP project are:
+
+| Version  | Supported          |
+|----------|--------------------|
+| 2.0.0    | :soon:             |
+| 1.0.0    | :white_check_mark: |
+| < 1.0.0  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please include the requested information listed below (as much as you can provide) to help
+us better understand the nature and scope of the possible issue:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved please submit a
+pull request. Thanks!
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,34 @@
+# Support
+
+This article explains where to get help with this OCPP project.
+Please read through the following guidelines.
+
+> 👉 **Note**: before participating in our community, please read our
+> [code of conduct][coc].
+> By interacting with this repository, organization, or community you agree to
+> abide by its terms.
+
+## Asking quality questions
+
+Questions can go to [GitHub discussions][chat].
+
+Help us help you!
+Spend time framing questions and add links and resources.
+Spending the extra time up front can help save everyone time in the long run.
+Here are some tips:
+
+* Search to find out if a similar question has been asked or a similar issue has been reported
+* Check to see if a PR is already in progress for the issue you want to raise
+* Try to define what you need help with:
+  * Is there something in particular you want to do?
+  * What problem are you encountering and what steps have you taken to try
+    and fix it?
+  * Is there a concept you don’t understand?
+* Provide sample code, such as a [CodeSandbox][cs] or video, if possible
+* Screenshots can help, but if there’s important text such as code or error
+  messages in them, please also provide those as text
+* The more time you put into asking your question, the better we can help you
+
+## Contributions
+
+See [`contributing.md`][contributing] on how to contribute.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,7 +23,7 @@
 author = "Auke Willem Oosterhoff"
 
 # The full version, including alpha/beta/rc tags
-release = "2.0.0-rc.2"
+release = "2.0.0-rc.3"
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/ocpp/charge_point.py b/ocpp/charge_point.py
@@ -295,9 +295,8 @@ async def _handle_call(self, msg):
             return
 
         if not handlers.get("_skip_schema_validation", False):
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, msg, self._ocpp_version
-            )
+            await validate_payload(msg, self._ocpp_version)
+
         # OCPP uses camelCase for the keys in the payload. It's more pythonic
         # to use snake_case for keyword arguments. Therefore the keys must be
         # 'translated'. Some examples:
@@ -344,9 +343,7 @@ async def _handle_call(self, msg):
         response = msg.create_call_result(camel_case_payload)
 
         if not handlers.get("_skip_schema_validation", False):
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, response, self._ocpp_version
-            )
+            await validate_payload(response, self._ocpp_version)
 
         await self._send(response.to_json())
 
@@ -415,9 +412,7 @@ async def call(
         )
 
         if not skip_schema_validation:
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, call, self._ocpp_version
-            )
+            await validate_payload(call, self._ocpp_version)
 
         # Use a lock to prevent make sure that only 1 message can be send at a
         # a time.
@@ -440,9 +435,7 @@ async def call(
             raise response.to_exception()
         elif not skip_schema_validation:
             response.action = call.action
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, response, self._ocpp_version
-            )
+            await validate_payload(response, self._ocpp_version)
 
         snake_case_payload = camel_to_snake_case(response.payload)
         # Create the correct Payload instance based on the received payload. If
diff --git a/ocpp/messages.py b/ocpp/messages.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py
diff --git a/tests/test_messages.py b/tests/test_messages.py
