nautobot 2.1.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

nautobot/ui/src/views/Home.js

@@ -1,142 +0,0 @@
-import {
-    AutomationIcon,
-    DcimIcon,
-    IpamIcon,
-    NautobotGridItem,
-    PlatformIcon,
-    SecurityIcon,
-    Table,
-    TableContainer,
-    Tab,
-    Tabs,
-    TabList,
-    TabPanel,
-    TabPanels,
-    Tag,
-    TagLabel,
-    Tbody,
-    Td,
-    Text,
-    Th,
-    Thead,
-    Tr,
-} from "@nautobot/nautobot-ui";
-import HomeChangelogPanel from "@components/HomeChangelogPanel";
-import HomePanel from "@components/HomePanel";
-import JobHistoryTable from "@components/JobHistoryTable";
-import { LoadingWidget } from "@components/LoadingWidget";
-import { useGetObjectCountsQuery, useGetRESTAPIQuery } from "@utils/api";
-import GenericView from "@views/generic/GenericView";
-
-export default function Home() {
-    const { data: jobResultData } = useGetRESTAPIQuery({
-        app_label: "extras",
-        model_name: "job-results",
-        limit: 1,
-        depth: 0,
-    });
-    const {
-        data: objectCountData,
-        isLoading,
-        isError,
-    } = useGetObjectCountsQuery();
-
-    if (isLoading) {
-        return (
-            <GenericView>
-                <NautobotGridItem colSpan="4">
-                    <LoadingWidget />
-                </NautobotGridItem>
-            </GenericView>
-        );
-    }
-
-    if (isError) {
-        return (
-            <GenericView>
-                <NautobotGridItem colSpan="4">
-                    <Text textAlign="center">Error loading.</Text>
-                </NautobotGridItem>
-            </GenericView>
-        );
-    }
-
-    return (
-        <GenericView columns="1 1 1 1 3 1" gridBackground="white-0">
-            <HomePanel
-                icon={<DcimIcon />}
-                title="Inventory"
-                data={objectCountData["Inventory"]}
-            />
-            <HomePanel
-                icon={<IpamIcon />}
-                title="Networks"
-                data={objectCountData["Networks"]}
-            />
-            {/*TODO: this should use objectCountData["Security"]*/}
-            <HomePanel
-                icon={<SecurityIcon />}
-                title="Security"
-                data={objectCountData["Security"]}
-            />
-            <HomePanel
-                icon={<PlatformIcon />}
-                title="Platform"
-                data={objectCountData["Platform"]}
-            />
-            <NautobotGridItem colSpan="3">
-                {/*TODO: this should probably be extracted to a HomeAutomationPanel component for readability?*/}
-                <TableContainer>
-                    <Table>
-                        <Thead>
-                            <Tr _hover={{}}>
-                                <Th width="3em">
-                                    <AutomationIcon />
-                                </Th>
-                                <Th>Automation</Th>
-                            </Tr>
-                        </Thead>
-                        <Tbody>
-                            <Tr _hover={{}}>
-                                <Td colSpan={2}>
-                                    <Tabs variant="outline">
-                                        <TabList>
-                                            <Tab>
-                                                Job History{" "}
-                                                <Tag size="sm" variant="info">
-                                                    <TagLabel>
-                                                        {jobResultData?.count}
-                                                    </TagLabel>
-                                                </Tag>
-                                            </Tab>
-                                            <Tab hidden={true}>
-                                                Schedule{" "}
-                                                <Tag size="sm" variant="info">
-                                                    <TagLabel>7</TagLabel>
-                                                </Tag>
-                                            </Tab>
-                                            <Tab hidden={true}>
-                                                Approvals{" "}
-                                                <Tag size="sm" variant="info">
-                                                    <TagLabel>3</TagLabel>
-                                                </Tag>
-                                            </Tab>
-                                        </TabList>
-                                        <TabPanels>
-                                            <TabPanel>
-                                                <JobHistoryTable />
-                                            </TabPanel>
-                                            <TabPanel></TabPanel>
-                                            <TabPanel></TabPanel>
-                                        </TabPanels>
-                                    </Tabs>
-                                </Td>
-                            </Tr>
-                        </Tbody>
-                    </Table>
-                </TableContainer>
-            </NautobotGridItem>
-            <HomeChangelogPanel />
-        </GenericView>
-    );
-}

nautobot/ui/src/views/InstalledApps.js

@@ -1,80 +0,0 @@
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
-import { faBookOpen, faGear, faHome } from "@fortawesome/free-solid-svg-icons";
-import {
-    Button,
-    Link,
-    Table,
-    TableContainer,
-    Tbody,
-    Td,
-    Th,
-    Thead,
-    Tr,
-} from "@nautobot/nautobot-ui";
-import { useGetRESTAPIQuery } from "@utils/api";
-import GenericView from "@views/generic/GenericView";
-
-export default function InstalledApps() {
-    const { data, isLoading } = useGetRESTAPIQuery({
-        app_label: "plugins",
-        model_name: "installed-plugins",
-    });
-
-    if (isLoading) {
-        return <GenericView gridBackground="white-0" />;
-    }
-
-    return (
-        <GenericView gridBackground="white-0">
-            <TableContainer>
-                <Table>
-                    <Thead>
-                        <Tr>
-                            <Th>Name</Th>
-                            <Th>Description</Th>
-                            <Th>Version</Th>
-                            <Th>Links</Th>
-                        </Tr>
-                    </Thead>
-                    <Tbody>
-                        {Object.values(data).map((app) => (
-                            <Tr>
-                                <Td>{app.name}</Td>
-                                <Td>{app.description}</Td>
-                                <Td>{app.version}</Td>
-                                <Td>
-                                    <Link href={app.home_url}>
-                                        <Button
-                                            variant="primary"
-                                            isDisabled={!app.home_url}
-                                        >
-                                            <FontAwesomeIcon icon={faHome} />
-                                        </Button>
-                                    </Link>
-                                    <Link href={app.config_url}>
-                                        <Button
-                                            variant="primaryAction"
-                                            isDisabled={!app.config_url}
-                                        >
-                                            <FontAwesomeIcon icon={faGear} />
-                                        </Button>
-                                    </Link>
-                                    <Link href={app.docs_url}>
-                                        <Button
-                                            variant="primary"
-                                            isDisabled={!app.docs_url}
-                                        >
-                                            <FontAwesomeIcon
-                                                icon={faBookOpen}
-                                            />
-                                        </Button>
-                                    </Link>
-                                </Td>
-                            </Tr>
-                        ))}
-                    </Tbody>
-                </Table>
-            </TableContainer>
-        </GenericView>
-    );
-}

nautobot/ui/src/views/Login.js

@@ -1,48 +0,0 @@
-import {
-    Button,
-    FormControl,
-    FormLabel,
-    Input,
-    Box,
-    Spinner,
-} from "@nautobot/nautobot-ui";
-
-import { useGetSessionQuery, useLoginMutation } from "@utils/api";
-
-export default function Login() {
-    const { refetch: refetchSession } = useGetSessionQuery();
-    const [login, { isLoading }] = useLoginMutation();
-
-    /** Handle the form submission. */
-    const handleSubmit = (e) => {
-        e.preventDefault();
-        login({
-            username: e.target.username.value,
-            password: e.target.password.value,
-        })
-            .then(refetchSession)
-            .catch(console.log);
-    };
-
-    return (
-        <Box boxShadow="base" p="6" rounded="md" bg="white">
-            {/* Show that we're trying to log in while we wait for the server to respond. */}
-            {isLoading && <Spinner />}
-            <form method="POST" onSubmit={handleSubmit}>
-                <FormControl>
-                    <FormLabel>Username</FormLabel>
-                    <Input isRequired={true} name="username"></Input>
-                </FormControl>
-                <FormControl>
-                    <FormLabel>Password</FormLabel>
-                    <Input
-                        isRequired={true}
-                        name="password"
-                        type="password"
-                    ></Input>
-                </FormControl>
-                <Button type="submit">Log In</Button>
-            </form>
-        </Box>
-    );
-}

nautobot/ui/src/views/Logout.js

@@ -1,20 +0,0 @@
-import { useEffect } from "react";
-import { useSelector, useDispatch } from "react-redux";
-
-import { useLogoutMutation } from "@utils/api";
-import { isLoggedInSelector, flushSessionState } from "@utils/store";
-
-export default function Logout() {
-    const isLoggedIn = useSelector(isLoggedInSelector); // While the router _should_ never try to render this view if we aren't logged in, we should still check.
-    const [logout] = useLogoutMutation();
-    const dispatch = useDispatch();
-
-    /** Log out only when mounting the component, we should be logged out by the time it tries to render. */
-    useEffect(() => {
-        if (isLoggedIn) {
-            logout().then(dispatch(flushSessionState())).catch(console.log);
-        }
-    }, []); // eslint-disable-line react-hooks/exhaustive-deps -- only run on mount
-
-    return <></>;
-}

nautobot/ui/src/views/__tests__/BSCreateViewTemplate.test.js

@@ -1,11 +0,0 @@
-// import React from "react";
-// import { render, fireEvent, waitFor } from "@testing-library/react";
-// import BSCreateViewTemplate from '../BSCreateViewTemplate';
-
-describe("BSCreateViewTemplate component", () => {
-    it("renders a form with the correct schema", () => {
-        // TODO(timizuo): Write test for this component; I currently importing BSCreateViewTemplate raises
-        //  SyntaxError: Cannot use import statement outside a module;
-        //
-    });
-});

nautobot/ui/src/views/__tests__/BSListViewTemplate.test.js

@@ -1,107 +0,0 @@
-// import { render, screen } from "@testing-library/react";
-// import { BrowserRouter } from "react-router-dom";
-// import useSWR from "swr";
-// import BSListViewTemplate from "../BSListViewTemplate";
-
-// jest.mock("swr");
-
-describe("BSListViewTemplate component", () => {
-    // TODO: This needs to be update to test ObjectList.js
-    // it("should render `Failed to load` if swr error", async () => {
-    //     useSWR.mockReturnValue({
-    //         error: { message: "" },
-    //     });
-    //     render(
-    //         <BrowserRouter>
-    //             <BSListViewTemplate list_url="http://localhost:8000/api/items/" />
-    //         </BrowserRouter>
-    //     );
-    //     screen.getByText("Failed to load http://localhost:8000/api/items/");
-    // });
-
-    // it("should render empty page if swr yet to load (undefined)", async () => {
-    //     useSWR.mockReturnValue({
-    //         data: undefined,
-    //         error: undefined,
-    //     });
-    //     const { container } = render(
-    //         <BrowserRouter>
-    //             <BSListViewTemplate list_url="http://localhost:8000/api/items/" />
-    //         </BrowserRouter>
-    //     );
-    //     expect(container.innerHTML).toBe("");
-    // });
-
-    // it("Render page properly if swr request successfull", async () => {
-    //     const mockData = [
-    //         {
-    //             formData: {
-    //                 count: 2,
-    //                 next: null,
-    //                 previous: null,
-    //                 results: [
-    //                     {
-    //                         id: 1,
-    //                         name: "Example One",
-    //                         status: "active",
-    //                     },
-    //                     {
-    //                         id: 2,
-    //                         name: "Example Two",
-    //                         status: "deactivated",
-    //                     },
-    //                 ],
-    //             },
-    //         },
-    //         {
-    //             formData: {
-    //                 data: [
-    //                     { name: "name", label: "Name" },
-    //                     { name: "status", label: "Status" },
-    //                 ],
-    //             },
-    //         },
-    //     ];
-    //     useSWR.mockReturnValue({
-    //         data: mockData,
-    //     });
-    //     render(
-    //         <BrowserRouter>
-    //             <BSListViewTemplate list_url="http://localhost:8000/api/items/" />
-    //         </BrowserRouter>
-    //     );
-
-    //     // Assert we have 3 buttons: Add, Import and Export
-    //     const buttons = screen.getAllByRole("button");
-    //     expect(buttons.length).toBe(3);
-    //     // const addBtn = buttons[0];
-    //     // const importBtn = buttons[1];
-    //     // const exportBtn = buttons[2];
-    //     // expect(addBtn.getAttribute("to")).toBe("/add")
-    //     // expect(addBtn.getAttribute("class")).toBe("btn btn-primary")
-    //     // expect(addBtn.innerHTML).toContain("Add")
-    //     // expect(importBtn.getAttribute("class")).toBe("btn btn-info")
-    //     // expect(importBtn.innerHTML).toContain("Import")
-    //     // expect(exportBtn.getAttribute("class")).toBe("btn btn-success")
-    //     // expect(exportBtn.innerHTML).toContain("Export")
-
-    //     // Assert table has correct data
-    //     // const tableDom = document.evaluate('//table', document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue
-    //     // const tableHeader = tableDom.children[0]
-    //     // expect(tableHeader.innerHTML).toContain("<th>Name</th><th>Status</th>")
-
-    //     // // Assert Table body has two rows and three colums
-    //     // const tableBody = tableDom.children[1].children
-    //     // expect(tableBody.length).toBe(2)
-    //     // expect(tableBody[0].children.length).toBe(3)
-
-    //     // // Assert Table
-    //     // const firstRow = '<td><div class=""><input type="checkbox" class="form-check-input"></div></td><td><a href="/1">Example One</a></td><td>active</td>'
-    //     // const secondRow = '<td><div class=""><input type="checkbox" class="form-check-input"></div></td><td><a href="/2">Example Two</a></td><td>deactivated</td>'
-    //     // expect(tableBody[0].innerHTML).toBe(firstRow)
-    //     // expect(tableBody[1].innerHTML).toBe(secondRow)
-
-    //     // NOTE: Im not validating table and pagination here; Cause they have properly been tested in other test cases
-    // });
-    it("should be true", async () => expect(true).toBe(true));
-});

nautobot/ui/src/views/__tests__/Login.test.js

@@ -1,15 +0,0 @@
-// import { render, screen } from "@testing-library/react";
-
-// import Login from "../Login";
-
-describe("Login component", () => {
-    it("renders the login form", () => {
-        // TODO: Need to setup Redux for Jest: https://redux.js.org/usage/writing-tests#setting-up-a-reusable-test-render-function
-        // render(<Login />);
-        // screen.getByLabelText("Username");
-        // screen.getByLabelText("Password");
-        // screen.getByRole("button", { name: "Log In" });
-        expect(true).toBe(true);
-    });
-    // TODO(timizuo): It would be nice to test for on submit of the login form
-});

nautobot/ui/src/views/generic/GenericView.js

@@ -1,191 +0,0 @@
-import {
-    Breadcrumb,
-    Breadcrumbs,
-    calc,
-    Flex,
-    getCssVar,
-    NautobotGrid,
-} from "@nautobot/nautobot-ui";
-import { FiltersPanelContainer } from "@components/FiltersPanel";
-import { Navbar } from "@components/Navbar";
-import { useMemo } from "react";
-import { useSelector } from "react-redux";
-import {
-    Link as ReactRouterLink,
-    useLocation,
-    useParams,
-} from "react-router-dom";
-
-import { useGetUIMenuQuery } from "@utils/api";
-import { uiUrl } from "@utils/url";
-
-// Descend into the menu "data" until we find a leaf whose URL matches "pathname", and return the keys to get there
-function findMenuPathRecursive(pathname, data) {
-    for (const key in data) {
-        if (typeof data[key] == "string") {
-            if (pathname.startsWith(data[key])) {
-                return [key];
-            }
-        } else {
-            let pathToLeaf = findMenuPathRecursive(pathname, data[key]);
-            if (pathToLeaf !== null) {
-                return [key].concat(pathToLeaf);
-            }
-        }
-    }
-    return null;
-}
-
-// Descend into the menu "data" until we find the first leaf and return its URL.
-function firstLinkInMenu(data) {
-    return typeof data === "string"
-        ? data
-        : firstLinkInMenu(Object.values(data)[0] ?? "");
-}
-
-// Descend into the menu "data" along the given path and construct breadcrumbs/menus corresponding to that path
-function breadcrumbsRecursive(pathToLeaf, data, objectData, depth = 0) {
-    let key = pathToLeaf[0];
-    let entry = {
-        children: key,
-        items: Object.keys(data).map((peer_name) => ({
-            as: ReactRouterLink,
-            children: peer_name,
-            to: firstLinkInMenu(data[peer_name]),
-        })),
-        key: `${depth}_${key}`,
-        type: "menu",
-    };
-    if (pathToLeaf.length === 1) {
-        // Selected leaf within the menu, plus (below) possibly a specific object instance
-        return [
-            entry,
-            ...(objectData
-                ? [
-                      {
-                          as: ReactRouterLink,
-                          children: objectData.display,
-                          key: `${depth + 1}_${objectData.id}`,
-                          to: uiUrl(objectData.url),
-                          type: "link",
-                      },
-                  ]
-                : []),
-        ];
-    }
-    return [entry].concat(
-        breadcrumbsRecursive(
-            pathToLeaf.slice(1),
-            data[key],
-            objectData,
-            depth + 1
-        )
-    );
-}
-
-export default function GenericView({
-    children,
-    columns = "4",
-    objectData,
-    rows,
-    gridBackground,
-}) {
-    const BREADCRUMB_KEY_HOME = "0_home";
-
-    const { pathname } = useLocation();
-    const { app_label, model_name, object_id } = useParams();
-
-    const { data: menu, isSuccess } = useGetUIMenuQuery();
-
-    // Using useMemo to prevent unnecessary re-execution of findMenuPathRecursive
-    const menuPath = useMemo(
-        () => findMenuPathRecursive(pathname, menu),
-        [menu, pathname]
-    );
-    const breadcrumbs = useMemo(
-        () =>
-            (function () {
-                if (pathname === "/" || !isSuccess || !menu) {
-                    return [
-                        {
-                            key: BREADCRUMB_KEY_HOME,
-                            type: "text",
-                        },
-                    ];
-                }
-                return breadcrumbsRecursive(menuPath, menu, objectData);
-            })(),
-        [menu, objectData, pathname, isSuccess, menuPath]
-    );
-
-    const currentState = useSelector((state) => state.appState);
-
-    const hasBreadcrumbs =
-        breadcrumbs.length > 0 && breadcrumbs[0].key !== BREADCRUMB_KEY_HOME;
-
-    const isListView = Boolean(app_label && model_name && !object_id);
-
-    return (
-        <Flex
-            background="gray-0"
-            direction="column"
-            gap="md"
-            height="full"
-            paddingTop="md"
-            width="full"
-        >
-            <Navbar appState={currentState} />
-
-            <Flex flex="1" overflow="hidden">
-                <Flex
-                    direction="column"
-                    flex="1"
-                    overflow="auto"
-                    paddingBottom="md"
-                    paddingX="md"
-                >
-                    {hasBreadcrumbs ? (
-                        <Breadcrumbs
-                            flex="none"
-                            marginBottom="md"
-                            position="relative"
-                            zIndex="5"
-                        >
-                            {breadcrumbs.map((props) => (
-                                <Breadcrumb {...props} />
-                            ))}
-                        </Breadcrumbs>
-                    ) : null}
-
-                    <NautobotGrid
-                        alignItems="start"
-                        columns={columns}
-                        rows={rows}
-                        background={gridBackground}
-                        gridAutoRows="auto"
-                        {...(hasBreadcrumbs
-                            ? { minHeight: "auto" }
-                            : { flex: "1 0 auto" })}
-                        {...(isListView
-                            ? {
-                                  gridAutoRows:
-                                      getCssVar("sizes.full").reference,
-                                  maxHeight: calc.subtract(
-                                      getCssVar("sizes.full"),
-                                      getCssVar("lineHeights.normal"),
-                                      getCssVar("space.md")
-                                  ),
-                              }
-                            : undefined)}
-                    >
-                        {typeof children === "function"
-                            ? children(menuPath)
-                            : children}
-                    </NautobotGrid>
-                </Flex>
-
-                <FiltersPanelContainer />
-            </Flex>
-        </Flex>
-    );
-}