Skip to content

armgit / burr

Public Imported from GitHub
0

Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.

4.6 KB
Raw Blame
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import pathlib

import pytest

from burr.core import ApplicationBuilder
from burr.core.graph import GraphBuilder

from tests.core.test_graph import PassedInAction


@pytest.fixture
def base_counter_action():
    yield PassedInAction(
        reads=["count"],
        writes=["count"],
        fn=lambda state: {"count": state.get("count", 0) + 1},
        update_fn=lambda result, state: state.update(**result),
        inputs=[],
    )


@pytest.fixture
def graph(base_counter_action):
    yield (
        GraphBuilder()
        .with_actions(counter=base_counter_action)
        .with_transitions(("counter", "counter"))
        .build()
    )


@pytest.mark.parametrize(
    "filename, write_dot", [("app", False), ("app.png", False), ("app", True), ("app.png", True)]
)
def test_visualize_dot_output(graph, tmp_path: pathlib.Path, filename: str, write_dot: bool):
    """Handle file generation with `graph.Digraph` `.render()` and `.pipe()`"""
    output_file_path = f"{tmp_path}/{filename}"

    graph.visualize(
        output_file_path=output_file_path,
        write_dot=write_dot,
    )

    # assert pathlib.Path(tmp_path, "app.png").exists()
    assert pathlib.Path(tmp_path, "app").exists() == write_dot


def test_visualize_no_dot_output(graph, tmp_path: pathlib.Path):
    """Check that no dot file is generated when output_file_path=None"""
    dot_file_path = tmp_path / "dag"

    graph.visualize(output_file_path=None)

    assert not dot_file_path.exists()


@pytest.mark.parametrize(
    "reads, writes, expected_label",
    [
        ([], [], "label=counter"),
        (["count"], [], r"counter\lreads:\l  count\l"),
        ([], ["count"], r"counter\lwrites:\l  count\l"),
        (
            ["count", "user_input"],
            ["count"],
            r"counter\lreads:\l  count\l  user_input\lwrites:\l  count\l",
        ),
    ],
)
def test_visualize_include_state_multiline_label(reads: list, writes: list, expected_label: str):
    """Reads and writes should each be displayed on their own line (issue #402)"""
    action = PassedInAction(
        reads=reads,
        writes=writes,
        fn=lambda state: {"count": state.get("count", 0) + 1},
        update_fn=lambda result, state: state.update(**result),
        inputs=[],
    )
    graph = (
        GraphBuilder().with_actions(counter=action).with_transitions(("counter", "counter")).build()
    )

    digraph = graph.visualize(include_state=True)

    assert expected_label in digraph.source


def test_visualize_engine_kwargs_attr_dicts(graph):
    """Attribute dicts passed through ``engine_kwargs`` reach the graphviz.Digraph,
    including ones (like ``edge_attr``) that have no Burr default to merge into."""
    digraph = graph.visualize(
        graph_attr={"rankdir": "LR"},
        node_attr={"fontname": "Courier"},
        edge_attr={"color": "red"},
    )

    assert digraph.graph_attr["rankdir"] == "LR"
    assert digraph.graph_attr["ranksep"] == "0.4"  # Burr default is kept
    assert digraph.node_attr["fontname"] == "Courier"
    assert digraph.node_attr["fillcolor"] == "#b4d8e4"  # Burr default is kept
    assert digraph.edge_attr == {"color": "red"}


def test_application_visualize_edge_attr(graph):
    """``Application.visualize`` is the path users call; it forwards ``edge_attr``."""
    app = ApplicationBuilder().with_graph(graph).with_entrypoint("counter").build()

    digraph = app.visualize(edge_attr={"color": "red"})

    assert digraph.edge_attr == {"color": "red"}
    assert digraph.graph_attr["rankdir"] == "TB"  # Burr default is kept


def test_visualize_none_attr_keeps_defaults(graph):
    """Passing ``graph_attr=None`` behaves like not passing it."""
    digraph = graph.visualize(graph_attr=None, node_attr=None, edge_attr=None)

    assert digraph.graph_attr["rankdir"] == "TB"
    assert digraph.node_attr["fillcolor"] == "#b4d8e4"
    assert digraph.edge_attr == {}