Add parametrized tests for saving/fetching metadata in all products

The Product abstract class defines two abstract methods (fetch_metadata and save_metadata), and each concrete class (such as File) must implement them. Although the implementation is different for each concrete classes, the interface is the same so we need a parametrized test (using pytest.mark.parametrize) that checks that all concrete classes implement both methods correctly.

Concrete classes are defined here: https://github.com/ploomber/ploomber/blob/master/src/ploomber/products/file.py https://github.com/ploomber/ploomber/blob/master/src/ploomber/products/genericproduct.py https://github.com/ploomber/ploomber/blob/master/src/ploomber/products/sql.py

[idomic]

Let’s pause this work now, we’ll assign a new issue to work on since this is a lower priority.

On Fri, Sep 2, 2022 at 10:10 AM Suren @.***> wrote:

Hey, I have some specific questions regarding my issue.

This is an example of a file test I’ve created: `def test_save_metadata(): Path(‘sample.txt’).touch() File(‘sample.txt’).save_metadata({“pageNumber”: “3”}) meta = File(‘sample.txt’).fetch_metadata()

assert meta[‘pageNumber’] == “3”`

• Should I do a series of fetch_metadata() calls to check if its true? (in order to scale with parametrize?)
• Should I make a different test for fetch_metadata since this is technically doing both?
• Is there a way to see test coverage?
• What is the purpose of .source in the condition? see here: https://github.com/ploomber/ploomber/blob/master/tests/products/test_file.py#L143

For the GenericProduct class:

• I’m not sure where to begin with running a test here because it’s not being implemented. It’s using an abstract class after inheriting from another class.
• Line 31, what is happening here? GenericProduct isn’t implementing save_metadata. See here: https://github.com/ploomber/ploomber/blob/master/tests/products/test_genericproduct.py#L31

SQL

• These methods are already tested. How can I get started parametrizing this?

— Reply to this email directly, view it on GitHub https://github.com/ploomber/ploomber/issues/57#issuecomment-1235553044, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACYPJOM2XWZFX5ONGRITDFTV4IDEJANCNFSM4LSECX5Q . You are receiving this because you commented.Message ID: @.***>

[surenzz]

Hey, I have some specific questions regarding my issue.

This is an example of a file test I’ve created:

def test_save_metadata():  
    Path('sample.txt').touch()  
    File('sample.txt').save_metadata({"pageNumber": "3"})  
    meta = File('sample.txt').fetch_metadata()  
    assert meta['pageNumber'] == "3"  

• Should I do a series of fetch_metadata() calls to check if its true? (in order to scale with parametrize?)
• Should I make a different test for fetch_metadata since this is technically doing both?
• Is there a way to see test coverage?
• What is the purpose of .source in the condition? see here: https://github.com/ploomber/ploomber/blob/master/tests/products/test_file.py#L144

For the GenericProduct class:

• I’m not sure where to begin with running a test here because it’s not being implemented. It’s using an abstract class after inheriting from another class.
• Line 31, what is happening here? GenericProduct isn’t implementing save_metadata. See here: https://github.com/ploomber/ploomber/blob/master/tests/products/test_genericproduct.py#L31 and https://github.com/ploomber/ploomber/blob/master/src/ploomber/products/genericproduct.py#L144

SQL

• These methods are already tested. How can I get started parametrizing this?