ni / ni/nisystemlink-clients-python

Unstable Notebook client tests - Metadata field is not in valid format

Open
#186 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug tests
Dominant language
Python
Stars
10
Forks
32
Avg merge
12h 42m
Merged PRs (30d)
2

Description

Frequently experiencing NotebookClient integration tests failing as part of GitHub Actions but recoverable on manual retry

=========================== short test summary info ============================
FAILED tests/integration/notebook/test_notebook_client.py::TestNotebookClient::test__update_existing_notebook_content__update_notebook_content_succeeds - nisystemlink.clients.core._api_exception.ApiException: Server responded with <400 Bad Request> (https://test-api.lifecyclesolutions.ni.com/ninotebook/v1/notebook).

name='Notebook.InvalidMetadataFormat' code=-252526 message='Metadata field is not in valid format.' args=[] resource_type=None resource_id=None inner_errors=[]
FAILED tests/integration/notebook/test_notebook_client.py::TestNotebookClient::test__query_notebook_by_id__return_notebook_matches_id - nisystemlink.clients.core._api_exception.ApiException: Server responded with <400 Bad Request> (https://test-api.lifecyclesolutions.ni.com/ninotebook/v1/notebook).

name='Notebook.InvalidMetadataFormat' code=-252526 message='Metadata field is not in valid format.' args=[] resource_type=None resource_id=None inner_errors=[]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with tests/integration/notebook/test_notebook_client.py and the two failing NotebookClient tests named in the report. Run them in GitHub Actions or locally and inspect the notebook metadata sent to https://test-api.lifecyclesolutions.ni.com/ninotebook/v1/notebook. Done means both tests pass reliably without manual retries and no longer receive Notebook.InvalidMetadataFormat.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
api, ci-cd, testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.