Skip to content

Commit

Permalink
Fix Asset Docs (#6677)
Browse files Browse the repository at this point in the history
* update line

* update asset-sync readme to reflect reality as far as breadcrumb and the like
  • Loading branch information
scbedd authored Aug 4, 2023
1 parent d6bee9d commit d8ab868
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 7 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 5 additions & 7 deletions tools/test-proxy/documentation/asset-sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,19 +197,17 @@ In summary, once an assets.json is present, the shim _must_ be updated to **actu

Once a package or service has an assets.json and a targeted tag, each language-repo test framework will automatically provide this assets.json alongside the recording file path. This will allow the test-proxy to automatically restore recordings as necessary.

Here is the result of running tests in `playback`-mode for a couple packages within the python repo:
In practice, this is what a code repo will look like after running `playback`-mode for a couple packages. Specifically, this is for the python repo.

![assets store](../_images/example_assets_store.png)
![assets store](../_images/assets_on_disk.png)

One can see the automatically restored assets repos within the `.assets` folder. Each of the top-level folders within the `.assets` folder contains a single slice of the assets repo.

The below diagram illustrates how an individual assets.json, language repo, and assets repo relate to each other. Text that appears as a specific color can be traced to its source in the assets.json.
The below diagram illustrates how an individual assets.json, language repo, and assets repo relate to each other.

![assets diagram](../_images/organization_of_assets.png)
![assets diagram](../_images/organization_of_assets1.png)

> Side note: the `.breadcrumb` file is created/updated as an artifact of the test-proxy restore/push/reset operations. Don't look for one if you haven't restored at least one assets.json first!
One can use visual inspection of the `.breadcrumb` file to _find_ which folder contains the files for your assets.json. Or, more conveniently, a user can use the `config` verb to access this data! Using assets diagram directly above. we can work an example:
A user can use the `config` verb to access this the location of their assets on disk! Using assets diagram directly as a reference. we can work an example:

```powershell
# from the root of the azure-sdk-for-net repo, run:
Expand Down

0 comments on commit d8ab868

Please sign in to comment.