Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add user-driven sidebar links via config #119

Merged
merged 38 commits into from
Jul 6, 2023
Merged

feat: add user-driven sidebar links via config #119

merged 38 commits into from
Jul 6, 2023

Commits on Jun 23, 2023

  1. feat: add kubeflow_dashboard_sidebar lib 

    Adds:
* KubeflowDashboardSidebarRequirer
* KubeflowDashboardSidebarProvider
* SidebarItem
* associated tests
    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    cadfd27 View commit details
    Browse the repository at this point in the history

  2. feat: add capture_events lib 

    Used as a helper in unit tests
    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    aca8dd6 View commit details
    Browse the repository at this point in the history

  3. refactor: move charm's k8s contex to a property 

    This change delays the computation of the k8s context until it is needed, instead of in __init__.  It does not change the outward function of the charm.

This change was implemented because in future, the sidebar links will be obtained from a relation and this should not be done in __init__.
    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    a3c5839 View commit details
    Browse the repository at this point in the history

  4. fix: handle multiple relations in sidebar Provider 

    previously, the Provider lib had a bug that would return only the last relation's data, not the entire set of data.  This fixes that bug.
    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    ab795b4 View commit details
    Browse the repository at this point in the history

  5. fix: handle empty relations in sidebar Provider

    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    ed3e471 View commit details
    Browse the repository at this point in the history

  6. feat: add Provider.get_sidebar_items_as_json

    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    f9a713e View commit details
    Browse the repository at this point in the history

  7. feat: implement sidebar Provider in charm 

    Includes unit tests
    @ca-scribner
    ca-scribner committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    44ccb52 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2023

  1. fix: handle relation-broken in get_sidebar_items() 

    This adds the feature to get_sidebar_items to, when executed during a relation-broken event for this relation, omit the relation data for the breaking app (the app leaving the relation).  For context, see https://chat.charmhub.io/charmhub/pl/

Possibly controversially, this feature uses the Juju environment variables to determine what event type is being executed.  This is to avoid having to pass the `BoundEvent` object to every `get_sidebar_items()` call, and to keep this hack entirely in the relation library so the charm does not need to know about it.
    @ca-scribner
    ca-scribner committed Jun 26, 2023
    Configuration menu
    Copy the full SHA
    54992ac View commit details
    Browse the repository at this point in the history

  2. fix: rendering of dashboard configmap 

    Previously, the links portion of the kubeflow dashboard configmap was incorrectly rendering only the menulinks, not all links.
    @ca-scribner
    ca-scribner committed Jun 26, 2023
    Configuration menu
    Copy the full SHA
    82c4543 View commit details
    Browse the repository at this point in the history

Commits on Jun 27, 2023

  1. feat: add integration tests for dynamic sidebar

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    102e434 View commit details
    Browse the repository at this point in the history

  2. fix: formatting and linting

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    17b6148 View commit details
    Browse the repository at this point in the history

  3. fix: removed unused BASE_SIDEBAR variable

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    7ac6531 View commit details
    Browse the repository at this point in the history

  4. fix: removed unused BASE_SIDEBAR variable from charm.py

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    17b5cbe View commit details
    Browse the repository at this point in the history

  5. fix: formatting/linting

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    f50a033 View commit details
    Browse the repository at this point in the history

  6. feat: add log dumping to integration CI

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    7de140c View commit details
    Browse the repository at this point in the history

  7. feat: add log dumping to integration CI

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    e02bd9a View commit details
    Browse the repository at this point in the history

  8. refactor: renamed interface to kubeflow_dashboard_sidebar

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    0bc7153 View commit details
    Browse the repository at this point in the history

  9. fix: linting and linting configuration

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    8c15742 View commit details
    Browse the repository at this point in the history

  10. fix: typo in dump-charm-debug-artifacts action call

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    c470658 View commit details
    Browse the repository at this point in the history

  11. docs: add missing docstrings, comments.

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    1e17e01 View commit details
    Browse the repository at this point in the history

  12. fix: remove outdate part of dashboard_links integration test 

    Removes tests for previously defined static links.
    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    2738bb3 View commit details
    Browse the repository at this point in the history

  13. fix: formatting

    @ca-scribner
    ca-scribner committed Jun 27, 2023
    Configuration menu
    Copy the full SHA
    0afc21c View commit details
    Browse the repository at this point in the history

Commits on Jun 28, 2023

  1. fix: dashboard quickLinks and Documentation links 

    When refactoring the template, the links were changed by mistake.  This reverts those changes.
    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    5b35b9c View commit details
    Browse the repository at this point in the history

  2. doc: add docstring in tests

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    b1f0e24 View commit details
    Browse the repository at this point in the history

  3. dox: capture relation-broken handling in github issue

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    887bcaf View commit details
    Browse the repository at this point in the history

  4. refactor generation of relation-driven sidebar items 

    This is a precursor step that makes the _context generation more extendable for other sources of links.
    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    f438eba View commit details
    Browse the repository at this point in the history

  5. feat: add user-defined sidebar links 

    This adds a config option additional-sidebar-links which accepts a YAML or JSON formatted input defining additional sidebar links.  These are combined with the relation-driven sidebar links.
    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    6ca9c7a View commit details
    Browse the repository at this point in the history

  6. feat: add tests for user-driven sidebar links

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    b03861a View commit details
    Browse the repository at this point in the history

  7. fix: typo in integration test names

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    0cb4218 View commit details
    Browse the repository at this point in the history

  8. fix: formatting

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    3a180ec View commit details
    Browse the repository at this point in the history

  9. Merge remote-tracking branch 'origin/kf-3664-dynamic-sidebar-feature-… 

    …branch' into kf-3664-add-user-defined-sidebar-links

# Conflicts:
#	src/charm.py
#	tests/integration/sidebar_requirer_tester_charm/src/charm.py
#	tests/integration/test_charm.py
#	tests/unit/test_operator.py
#	tests/unit/test_sidebar_lib.py
    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    4ba426a View commit details
    Browse the repository at this point in the history

  10. fix: library version

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    7063fab View commit details
    Browse the repository at this point in the history

  11. fix: remove duplicate library version

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    0ac3a17 View commit details
    Browse the repository at this point in the history

  12. fix: rebase error

    @ca-scribner
    ca-scribner committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    13577ff View commit details
    Browse the repository at this point in the history

Commits on Jun 29, 2023

  1. fix: tester charm name in integration tests

    @ca-scribner
    ca-scribner committed Jun 29, 2023
    Configuration menu
    Copy the full SHA
    92b269f View commit details
    Browse the repository at this point in the history

  2. fix: pin reusable CI workflow to commit 

    main branch of charmed-kubeflow-workflows has a breaking UI change for _quality-checks.yaml that does not work here.  Temporarily pinning quality-checks.yaml to a commit
    @ca-scribner
    ca-scribner committed Jun 29, 2023
    Configuration menu
    Copy the full SHA
    67817eb View commit details
    Browse the repository at this point in the history

Commits on Jul 5, 2023

  1. doc: add docstring entry about the sidebar_requirer_tester_charm in t… 

    …ests
    @ca-scribner
    ca-scribner committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    2f1e18f View commit details
    Browse the repository at this point in the history

  2. add catch for yaml.YAMLError in charm.py

    @ca-scribner
    ca-scribner committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    32d7863 View commit details
    Browse the repository at this point in the history