Adding Tests for GGUFWriter Class

[mendax0110]

Description

This pull request adds comprehensive tests for the GGUFWriter class. Previously, there were no tests available for this class.

Changes Made

• Introduced tests for the following methods:
  • test_add_uint8
  • test_add_int8
  • test_add_uint16
  • test_write_tensors_to_file
  • test_add_description
  • test_add_uint32
  • test_add_float32

Purpose

The purpose of these tests is to ensure the reliability, correctness, and expected behavior of the GGUFWriter methods under different scenarios.

Benefits

• Enhances code quality by ensuring existing functionalities work as intended.
• Guards against potential regressions by establishing a testing suite for future changes.

Additional Notes

• All tests have been successfully validated and pass without issues.
• The tests leverage temporary directories and context managers to maintain a clean testing environment.

[cebtenzzre]

You'll have to reduce the amount of copy-pasting by using one or more shared functions for this to be mergeable. You could also consider testing more than one feature at a time, which provides less fine-grained failure information but has the same level of coverage.

[cebtenzzre]

The tests don't work. There's a warning:

E/usr/lib/python3.11/unittest/case.py:622: ResourceWarning: unclosed file <_io.BufferedWriter name='/tmp/tmpuro9bqgy/test4.gguf'>
  with outcome.testPartExecutor(self):
ResourceWarning: Enable tracemalloc to get the object allocation traceback

And an error:

======================================================================
ERROR: test_add_description (__main__.TestGGUFWriter.test_add_description)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/jared/src/forks/llama.cpp/gguf-py/tests/test_gguf.py", line 58, in test_add_description
    gguf_writer.write_kv_data_to_file()
  File "/home/jared/src/forks/llama.cpp/gguf-py/gguf/gguf_writer.py", line 87, in write_kv_data_to_file
    raise ValueError(f'Expected output file to contain the header, got {self.state}')
ValueError: Expected output file to contain the header, got WriterState.EMPTY

For several tests.

[mendax0110]

The tests don't work. There's a warning:

E/usr/lib/python3.11/unittest/case.py:622: ResourceWarning: unclosed file <_io.BufferedWriter name='/tmp/tmpuro9bqgy/test4.gguf'>
  with outcome.testPartExecutor(self):
ResourceWarning: Enable tracemalloc to get the object allocation traceback

And an error:

======================================================================
ERROR: test_add_description (__main__.TestGGUFWriter.test_add_description)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/jared/src/forks/llama.cpp/gguf-py/tests/test_gguf.py", line 58, in test_add_description
    gguf_writer.write_kv_data_to_file()
  File "/home/jared/src/forks/llama.cpp/gguf-py/gguf/gguf_writer.py", line 87, in write_kv_data_to_file
    raise ValueError(f'Expected output file to contain the header, got {self.state}')
ValueError: Expected output file to contain the header, got WriterState.EMPTY

For several tests.

I cannot reproduce the errors you got. Can you give me the steps to reproduce these errors?

[cebtenzzre]

You must call write_header_to_file before write_kv_data_to_file. I know because I wrote those exceptions. The only reason I can think it would pass is if you are testing an old version of the gguf module - the latest is 0.6.0.

[cebtenzzre]

The tests in this PR still don't work, please run pip install -U gguf to test with the latest gguf package. (I just published the latest one.)

[mendax0110]

I did this. I will uninstall/install gguf again and try it again.