test_odb.py

# Copyright 2010-2025 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file.  (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; see the file COPYING.  If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.

"""Tests for Odb objects."""

# Standard Library
import binascii
from collections.abc import Generator
from pathlib import Path

import pytest

# pygit2
from pygit2 import Odb, Oid, Repository
from pygit2.enums import ObjectType

from . import utils

BLOB_HEX = 'af431f20fc541ed6d5afede3e2dc7160f6f01f16'
BLOB_RAW = binascii.unhexlify(BLOB_HEX.encode('ascii'))
BLOB_OID = Oid(raw=BLOB_RAW)
BLOB_CONTENTS = b'a contents\n'


def test_emptyodb(barerepo: Repository) -> None:
    odb = Odb()

    assert len(list(odb)) == 0
    assert BLOB_HEX not in odb
    path = Path(barerepo.path) / 'objects'
    odb.add_disk_alternate(path)
    assert BLOB_HEX in odb


@pytest.fixture
def odb(barerepo: Repository) -> Generator[Odb, None, None]:
    odb = barerepo.odb
    yield odb


def test_iterable(odb: Odb) -> None:
    assert BLOB_HEX in odb


def test_contains(odb: Odb) -> None:
    assert BLOB_HEX in odb


def test_read(odb: Odb) -> None:
    with pytest.raises(TypeError):
        odb.read(123)  # type: ignore
    utils.assertRaisesWithArg(KeyError, '1' * 40, odb.read, '1' * 40)

    ab = odb.read(BLOB_OID)
    a = odb.read(BLOB_HEX)
    assert ab == a
    assert (ObjectType.BLOB, BLOB_CONTENTS) == a
    assert isinstance(a[0], ObjectType)

    a2 = odb.read('7f129fd57e31e935c6d60a0c794efe4e6927664b')
    assert (ObjectType.BLOB, b'a contents 2\n') == a2
    assert isinstance(a2[0], ObjectType)

    a_hex_prefix = BLOB_HEX[:4]
    a3 = odb.read(a_hex_prefix)
    assert (ObjectType.BLOB, BLOB_CONTENTS) == a3
    assert isinstance(a3[0], ObjectType)


def test_read_header(odb: Odb) -> None:
    with pytest.raises(TypeError):
        odb.read_header(123)  # type: ignore
    utils.assertRaisesWithArg(KeyError, '1' * 40, odb.read_header, '1' * 40)

    ab = odb.read_header(BLOB_OID)
    a = odb.read_header(BLOB_HEX)
    assert ab == a
    assert (ObjectType.BLOB, len(BLOB_CONTENTS)) == a
    assert isinstance(a[0], ObjectType)


def test_write(odb: Odb) -> None:
    data = b'hello world'
    # invalid object type
    with pytest.raises(ValueError):
        odb.write(ObjectType.ANY, data)

    oid = odb.write(ObjectType.BLOB, data)
    assert type(oid) is Oid