Repository navigation
docs: add a Universal Mocker section to the navbar and sidebar - #987
Merged
Merged
Conversation
Universal Mocker (keploy mock) had no place of its own: its pages sat in the Integration Testing list, and the Products menu named only Integration Testing, API Testing and UI Testing. - The Products menu lists "Universal Mocker (Service Virtualization)". - The sidebar has a Universal Mocker category right after API Testing, opening on a new overview page: how record and replay work, when to pick it over Integration Testing or API Testing, and the platforms and dependencies Keploy 3.9.3 supports, from the parsers it registers on each OS. - The mock quickstart, Mock your tests and Mock Registry pages move into the section, and the VS Code extension page is listed there. Each old URL redirects to its new one, and links across the docs point at the new URLs. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
A copy-paste Go package whose tests read PostgreSQL and call an HTTP rates API. It records the calls with keploy mock record --local, replays them with both dependencies off, shows the miss a new test makes, and then checks each test on its own with KEPLOY_PROVEN=1 and keploytest. Every output is from a real run of Keploy 3.9.3 on Linux. Also: - a Universal Mocker card on the docs home and an icon for its sidebar category (SidebarCategoryIcon.js is reformatted by prettier 2.8.8, which CI runs on every changed file); - the installation pages link Mock your tests at its new URL. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
- Docs home: Universal Mocker joins the "How do you want to get started?" entry points (GetStartedPaths), as a card across both columns, and the page's JSON-LD list built from the same data. The Products card added earlier is dropped: the home does not render it. - Mock Registry stays in Integration Testing, at its old URL: it documents how `keploy test` uploads mocks, not `keploy mock`. - Overview: Windows is coming, not supported yet. Sharing through Keploy Cloud needs a Keploy app in keploy.yml and a branch other than main. - Go quickstart: Linux only until it has run on macOS. Step 1 runs git init, Step 2 waits for PostgreSQL, Step 3 lists the four files Keploy writes, Step 6 says -json adds a line per test event, and Step 7 shows what git status prints. - Moved pages: macOS reads PostgreSQL, DynamoDB and Aerospike calls too; Windows is coming; the Python walkthrough records with --local. - Checks: a broken anchor now fails the build, and scripts/verify-moved-urls.js (yarn verify-moved-urls, run in CI) fails when a moved URL stops redirecting to its page. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
- Mock quickstart: its pasted output is from an earlier Keploy release. The page and its description (which llms.txt repeats) now say so, and that the page is being updated for Keploy 3.9.3, instead of calling the output real and the page copy-paste. - Go quickstart, Step 7: the other files in keploy/default/, such as last-replay.yaml, are this machine's run files, and keploy/.gitignore keeps them out of git. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Universal Mocker (
keploy mock), Keploy's service virtualization for the tests a team already has, had no place of its own. Its pages sat in the Integration Testing list, and neither the Products menu nor the docs home named it.What changed
/universal-mocker/overview/):keploy.yml, and a branch other than main;/universal-mocker/quickstarts/go/): a copy-paste Go package whose tests read PostgreSQL and call an HTTP API, on Linux.KEPLOY_PROVEN=1andkeploytest, and shows what to commit.keploy testuploads mocks.plugin-client-redirects).--local, which needs no sign-in, and says its output is from an earlier release while it is updated for Keploy 3.9.3.onBrokenAnchors: "throw": a link to a heading that doesn't exist fails the build, as a broken link already does. The site builds with none today.scripts/verify-moved-urls.js(yarn verify-moved-urls, a new step in "Deploy PR Build and Check"): each moved URL must hold a redirect to its new URL, and a real page must be there. Add an entry when a page moves.SidebarCategoryIcon.jsis reformatted by prettier 2.8.8, which CI runs on every changed file.How it was checked
yarn build(Docusaurus,onBrokenLinksandonBrokenAnchors: throw) and every verify script, the new one included, on Node 22, as CI builds it./keploy-cloud/mock-registry/is still a page.prettier@2.8.8 --checkon every changed.jsand.mdfile, as CI runs it.verify-moved-urls. Each check in the script was also broken on purpose, and a case caught it.