Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bottle reader unit test #183

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

ChasonSmith
Copy link

contains the code for the bottle reader unit test

@ChasonSmith ChasonSmith self-assigned this Apr 2, 2024
@ChasonSmith ChasonSmith added vision Relating to image or visual stream handling and processing unit test Relating to the creation of unit test for a module. labels Apr 2, 2024
@cjhr95 cjhr95 self-requested a review April 3, 2024 00:50
import json
import os.path
from typing import TypedDict
import unittest
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The unittest package isn't currently in the poetry environment for the SUAS2023 repo. Is it necessary for the test's functionality, or can the file run without the package?

Comment on lines +15 to +17

"test file exists"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Class needs a more descriptive docstring


"test file exists"

def test_bottle_file(self) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

function needs a numpy-style docstring

Comment on lines +24 to +26
"""
make sure bottle list has what it should in it
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be moved into the function docstring

make sure bottle list has what it should in it
"""

def test_bottle_read(self) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Numpy docstring for this function as well

@cjhr95 cjhr95 linked an issue Apr 11, 2024 that may be closed by this pull request
Copy link
Contributor

@eblake003 eblake003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Make a test that verifies that the structure of the bottle.json file is correct
  • Change test_bottle_read() to verify that load_bottle_info() loads information about shapes, not just that it matches the json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
unit test Relating to the creation of unit test for a module. vision Relating to image or visual stream handling and processing
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

Add Unit Test for bottle_reader.py
3 participants