Test eventio.ksy #1
Conversation
|
Github action is running fine on my repository: https://github.com/zonca/eventio_kaitai/actions/runs/6788645920/job/18454092780 |
|
@zonca I added you as developer to this repository, so in principle you don't need to fork. |
|
@maxnoe thanks, I added that function as a standalone function. |
| # This workflow will install Python dependencies, run tests and lint with a single version of Python | ||
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | ||
|
|
||
| name: Python application |
There was a problem hiding this comment.
Can we simplify away the not needed parts of this example? Also fill in better names?
E.g. rename python-app.yaml to python-tests.yaml
build -> CI or run tests
There was a problem hiding this comment.
will do this later, when I'll do a python package, see #4
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install flake8 pytest | ||
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi |
There was a problem hiding this comment.
Let's not use requirements.txt but make a proper package using pyproject.toml and setuptools
There was a problem hiding this comment.
will do this later, when I'll do a python package, see #4
| # stop the build if there are Python syntax errors or undefined names | ||
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | ||
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | ||
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics |
There was a problem hiding this comment.
What do we do if we get linting errors on the auto-generated kaitai python module?
There was a problem hiding this comment.
kaitai python module is generated later, I do not think we need to do linting on autogenerated code
| - name: Compile Python module from definition | ||
| run: | | ||
| make py | ||
| - name: Test with pytest |
There was a problem hiding this comment.
Since we discussed in #5 that we need to bundle the generated python code, I think we should have a test here that checks that the bundled module is up to date with the kaitai definition
| @@ -0,0 +1,2 @@ | |||
| kaitaistruct==0.10 | |||
There was a problem hiding this comment.
See comment above, let's make a proper package and use pyproject.toml for dependencie specification
| EventioKaitaiParser.from_file(TESTFILE) | ||
|
|
||
|
|
||
| def test_file_has_objects_at_expected_position(): |
There was a problem hiding this comment.
Thinking about it, I think it is not necessary to test the addresses.
It should be good enough to check the expected types, versions and ids of all expected objects. There is basically no way to get a false positive here, if you got those correct, you have the file structure parsed correctly
There was a problem hiding this comment.
is there any application that needs the addresses?
if we want to provide this as part of the interface, we should probably test it
There was a problem hiding this comment.
No, it is just used for testing the Reader and debugging
|
@maxnoe thanks for the feedback. I wanted to do this small improvement over the current status of the repository and do a Python package for the next step, see #4. So I wouldn't bother with issues related to packaging and to the makefile right now. |
|
I don't mind the order, if this already helps, let's go |
improved makefile, by default compiles the parser
|
@maxnoe ok done |
just to familiarize myself with the tools, I've ported most of the
test_open_file.pyunit test frompyeventioto the Kaitai version and used Github Actions to run it.