fix: improved testing environment and fixed existing errors

[wfehr]

Setup a better testing-environment for running tests locally.
This is done via docker(-compose).

Other changes:

• installed black for standardized code formatting
• fixed isort errors

This changes are a good base for future test-implementation. Also some of the occuring errors are getting fixed.

[wfehr]

Taking a look into implementing a test for "basic functionality" now.
Made this PR since the already done changes work independently and already improve the code-base.
-> e.g.: test-hooks/github-checks are running successfully now with this PR.

[codecov]

Codecov Report

Attention: Patch coverage is 48.52941% with 35 lines in your changes are missing coverage. Please review.

Project coverage is 62.12%. Comparing base (eebaa38) to head (a8d7759).

Files	Patch %	Lines
djangocms_transfer/cms_plugins.py	0.00%	15 Missing ⚠️
djangocms_transfer/forms.py	53.33%	14 Missing ⚠️
djangocms_transfer/cms_toolbars.py	0.00%	4 Missing ⚠️
djangocms_transfer/importer.py	0.00%	0 Missing and 1 partial ⚠️
djangocms_transfer/utils.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master      #35       +/-   ##
===========================================
+ Coverage   31.18%   62.12%   +30.94%     
===========================================
  Files          11       11               
  Lines         404      404               
  Branches       61       61               
===========================================
+ Hits          126      251      +125     
+ Misses        278      137      -141     
- Partials        0       16       +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wfehr]

Just pushed the commits including tests to cover some basic functionality of this project.

I also included skipped tests with 8daa9b6. Those would cover more functionality of the imports but since I get errors for the import_file, I'll just leave those as skipped for now.

I think the currently "able to run" tests are a good base for future implementations / changes.

[wfehr]

@fsbraun I'd put this changes up for review now.

[fsbraun]

@wfehr Excellent work! Thank you!
Quick question: What is the docker file needed for?

[wfehr]

@wfehr Excellent work! Thank you! Quick question: What is the docker file needed for?

Hope I didn't interfere anything with my foce-push now ;) I rebased the branch onto the current master.

The Dockerfile is used for running the tests locally via devtools/run-tests (integrated with 34b3bcc).
I can also move the file into devtools/ if the root directory isn't the best place for it.

With this setup you can run tests a little easier with different python-versions for example.
-> for example in the future one could change the base-image python:3.10.. for something like python:3.12 if older versions aren't needed for testing anymore.
I find testing via docker a little more convinient than meeting requirements in the local dev-system.

[marksweb]

We're using ruff for linting and formatting, so we could merge this with black and the old linting setup and tackle ruff as a separate task. But just wanted to raise this here.

It's in pre-commit for django-cms itself; https://github.com/django-cms/django-cms/blob/develop-4/.pre-commit-config.yml#L41

[wfehr]

I can also throw out the commits for "including black"/"formatting running black" if and maybe switch it with ruff for the development process?
Or what would be the workflow you'd want?

[marksweb]

I don't mind the code being formatted with black because the ruff formatter is about 97% the same.

The workflow/process around this area on the whole is using pre-commit hooks;

https://github.com/django-cms/django-cms/blob/develop-4/.pre-commit-config.yml

Combined with a github action that runs the linter;
https://github.com/django-cms/django-cms/blob/develop-4/.github/workflows/linters.yml

[wfehr]

Alright, then I'd leave that 'as is' for now.

[fsbraun]

@wfehr I understand why you're using Docker for testing, but I would like to keep the test setup similar for all django-cms packages. Can you update the tox.ini to run without Docker? We can run the specific python versioned tests in the github actions.

[wfehr]

@wfehr I understand why you're using Docker for testing, but I would like to keep the test setup similar for all django-cms packages. Can you update the tox.ini to run without Docker? We can run the specific python versioned tests in the github actions.

I updated the branch and removed docker from the first commit (34b3bcc => 541b434).

[fsbraun]

This is great work! Thank you @wfehr !! 🚀