LexLeo 0.0.0-dev+f8e5087-dirty
Technical documentation
Loading...
Searching...
No Matches
stream unit tests

It covers:

stream_default_ops() unit tests

See stream_default_ops() specifications

Functions under test

const stream_ops_t *stream_default_ops(void);
stream_default_ops
const stream_ops_t * stream_default_ops(void)
Return the default borrower-facing ops table for the stream port.
Definition stream.c:123
stream_ops_t
Borrower-facing operation table for the stream port.
Definition stream_types.h:76

Test doubles

  • none

Tested scenarios

WHEN EXPECT
stream_default_ops() is called retis non-NULL;
ret->read != NULL;
ret->write != NULL;
ret->flush != NULL

Notes

  • This function establishes the “non-NULL ops pointer implies well-formed” invariant for the stream port.

stream_default_env() unit tests

Functions under test

stream_env_t stream_default_env(const osal_mem_ops_t *mem_ops);
stream_default_env
stream_env_t stream_default_env(const osal_mem_ops_t *mem_ops)
Build a default stream_env_t from injected memory operations.
Definition stream.c:132
osal_mem_ops_t
Definition osal_mem_ops.h:12
stream_env_t
Runtime environment for the stream port.
Definition stream_env.h:35

Success

  • env.mem == mem_ops.

Failure

  • None.

Test doubles

Tested scenarios

WHEN EXPECT
stream_default_env(mem_ops) is called with a valid mem_ops pointer returns a stream_env_t such that env.mem == mem_ops

Notes

  • This helper preserves the allocator dependency provided by the caller.

stream_create() / stream_destroy() unit tests

Functions under test

stream_status_t stream_create(
stream_t **out,
const stream_vtbl_t *vtbl,
void *backend,
const stream_env_t *env);
void stream_destroy(stream_t **s);
stream_create
stream_status_t stream_create(stream_t **out, const stream_vtbl_t *vtbl, void *backend, const stream_env_t *env)
Create a generic stream handle from adapter-provided backend bindings.
Definition stream.c:69
stream_destroy
void stream_destroy(stream_t **s)
Destroy a stream handle.
Definition stream.c:98
stream_status_t
stream_status_t
Public status codes used by the stream port.
Definition stream_types.h:40
stream_t
Private handle structure for a stream_t.
Definition stream_handle.h:34
stream_vtbl_t
Adapter dispatch table bound to a stream_t instance.
Definition stream_adapters_api.h:122

Invalid arguments

  • out, vtbl, env must not be NULL.
  • vtbl->read, vtbl->write, vtbl->flush, vtbl->close must not be NULL.
  • env->mem must not be NULL.

Success

  • Returns STREAM_STATUS_OK.
  • Stores a valid stream handle in *out.
  • The produced handle must be destroyed via stream_destroy().

Failure

  • Returns:
    • STREAM_STATUS_INVALID for invalid arguments
    • STREAM_STATUS_OOM on allocation failure
  • Leaves *out unchanged if out is not NULL.

Lifecycle

  • stream_destroy() does nothing if s == NULL or *s == NULL.
  • Otherwise, it releases the stream object and sets *s to NULL.

Test doubles

  • fake_memory

Tested scenarios

WHEN EXPECT
stream_create(out, vtbl, backend, env) is called with valid arguments returns STREAM_STATUS_OK;
stores a non-NULL stream handle in *out;
the produced handle is eligible for destruction by stream_destroy()
out == NULL returns STREAM_STATUS_INVALID;
no stream handle is produced
vtbl == NULL and out != NULL returns STREAM_STATUS_INVALID;
leaves *out unchanged
env == NULL and out != NULL returns STREAM_STATUS_INVALID;
leaves *out unchanged
env != NULL but env->mem == NULL and out != NULL returns STREAM_STATUS_INVALID;
leaves *out unchanged
allocation of the stream handle fails returns STREAM_STATUS_OOM;
leaves *out unchanged
stream_create() succeeds and stream_destroy() is called twice first stream_destroy(&s) releases the handle and sets s to NULL;
second stream_destroy(&s) is a no-op and keeps s as NULL
vtbl != NULL but vtbl->read == NULL and out != NULL returns STREAM_STATUS_INVALID;
leaves *out unchanged

stream_read() unit tests

Functions under test

size_t stream_read(stream_t *s, void *buf, size_t n, stream_status_t *st);
stream_read
size_t stream_read(stream_t *s, void *buf, size_t n, stream_status_t *st)
Read bytes from a stream.
Definition stream.c:19

Precondition

  • If s != NULL, s has been created by stream_create() with fake_stream_vtbl and fake_stream_backend.

Test doubles

  • fake_stream_backend_t
  • fake_stream_vtbl

Tested scenarios

WHEN EXPECT
n == 0 and st != NULL returns 0;
sets *st = STREAM_STATUS_OK;
does not call fake_stream_vtbl.read/write/flush/close
n == 0 and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_INVALID;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and buf == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_INVALID;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and buf == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_NO_BACKEND;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st != NULL, with fake_stream_backend configured as read_ret = n and read_st_to_set = STREAM_STATUS_OK calls fake_stream_vtbl.read(fake_stream_backend, buf, n, st) exactly once;
does not call fake_stream_vtbl.write/flush/close;
returns n;
sets *st = STREAM_STATUS_OK
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st != NULL, with fake_stream_backend configured as read_ret = 0 and read_st_to_set = STREAM_STATUS_EOF calls fake_stream_vtbl.read(fake_stream_backend, buf, n, st) exactly once;
does not call fake_stream_vtbl.write/flush/close;
returns 0;
sets *st = STREAM_STATUS_EOF
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st == NULL, with fake_stream_backend configured as read_ret = 5 calls fake_stream_vtbl.read(fake_stream_backend, buf, n, st = NULL) exactly once;
does not call fake_stream_vtbl.write/flush/close;
returns 5

Notes

  • For n == 0, the operation succeeds immediately without consulting the backend.
  • When st == NULL, status propagation is omitted but return-value and forwarding behavior remain verified.
  • The nominal scenarios validate borrower forwarding to the backend read operation and the absence of unrelated backend calls.

stream_write() unit tests

Functions under test

size_t stream_write(stream_t *s, const void *buf, size_t n, stream_status_t *st);
stream_write
size_t stream_write(stream_t *s, const void *buf, size_t n, stream_status_t *st)
Write bytes to a stream.
Definition stream.c:38

Precondition

  • If s != NULL, s has been created by stream_create() with fake_stream_vtbl and fake_stream_backend.

Test doubles

  • fake_stream_backend_t
  • fake_stream_vtbl

Tested scenarios

WHEN EXPECT
n == 0 and st != NULL returns 0;
sets *st = STREAM_STATUS_OK;
does not call fake_stream_vtbl.read/write/flush/close
n == 0 and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_INVALID;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and buf == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_INVALID;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and buf == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend == NULL and st != NULL returns 0;
sets *st = STREAM_STATUS_NO_BACKEND;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend == NULL and st == NULL returns 0;
does not call fake_stream_vtbl.read/write/flush/close
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st != NULL, with fake_stream_backend configured as write_ret = n and write_st_to_set = STREAM_STATUS_OK calls fake_stream_vtbl.write(fake_stream_backend, buf, n, st) exactly once;
does not call fake_stream_vtbl.read/flush/close;
returns n;
sets *st = STREAM_STATUS_OK
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st != NULL, with fake_stream_backend configured as write_ret = 0 and write_st_to_set = STREAM_STATUS_IO_ERROR calls fake_stream_vtbl.write(fake_stream_backend, buf, n, st) exactly once;
does not call fake_stream_vtbl.read/flush/close;
returns 0;
sets *st = STREAM_STATUS_IO_ERROR
n > 0 and s != NULL and buf != NULL and s->backend != NULL and st == NULL, with fake_stream_backend configured as write_ret = 5 calls fake_stream_vtbl.write(fake_stream_backend, buf, n, st = NULL) exactly once;
does not call fake_stream_vtbl.read/flush/close;
returns 5

Notes

  • For n == 0, the operation succeeds immediately without consulting the backend.
  • When st == NULL, status propagation is omitted but return-value and forwarding behavior remain verified.
  • The nominal scenarios validate borrower forwarding to the backend write operation and the absence of unrelated backend calls.

stream_flush() unit tests

Functions under test

stream_status_t stream_flush(stream_t *s);
stream_flush
stream_status_t stream_flush(stream_t *s)
Flush a stream.
Definition stream.c:62

Precondition

  • If s != NULL, s has been created by stream_create() with fake_stream_vtbl and fake_stream_backend.

Test doubles

  • fake_stream_backend_t
  • fake_stream_vtbl

Tested scenarios

WHEN EXPECT
s == NULL returns STREAM_STATUS_INVALID;
does not call fake_stream_vtbl.read/write/flush/close
s != NULL and s->backend == NULL returns STREAM_STATUS_NO_BACKEND;
does not call fake_stream_vtbl.flush
s != NULL and s->backend != NULL, with fake_stream_backend configured as flush_ret = STREAM_STATUS_OK returns STREAM_STATUS_OK;
calls fake_stream_vtbl.flush(fake_stream_backend) exactly once;
does not call fake_stream_vtbl.read/write/close
s != NULL and s->backend != NULL, with fake_stream_backend configured as flush_ret = STREAM_STATUS_IO_ERROR returns STREAM_STATUS_IO_ERROR;
calls fake_stream_vtbl.flush(fake_stream_backend) exactly once;
does not call fake_stream_vtbl.read/write/close

Notes

  • The nominal scenarios validate borrower forwarding to the backend flush operation and the absence of unrelated backend calls.
  • The backend == NULL case verifies that the port reports the missing backend without attempting any flush operation.