rm -rf oxapi_demo, replace w cli

[jessfraz]

oxidecomputer/console#716 to prove it works

[bnaecker]

Maybe a naive question, but if we're developing the API itself (adding routes, modifying types), how could one test such changes with the CLI?

[jessfraz]

The api command! Bottom example :D It’s like fancy curl

…

On Mar 23, 2022, at 1:38 PM, bnaecker ***@***.***> wrote:  Maybe a naive question, but if we're developing the API itself (adding routes, modifying types), how could one test such changes with the API? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.

[smklein]

Are we publishing releases for illumos?

[jessfraz]

I couldnt get cargo cross to work for illumos but maybe @jclulow can, its easy to turn on if it compiles

[jessfraz]

https://github.com/oxidecomputer/cli/blob/main/Makefile#L25

[smklein]

I'm reading through https://github.com/cross-rs/cross - I don't think illumos is a supported target by that project.

Manually, I checked out the CLI repo and tried building the x86_64-unknown-illumos target via cross compilation, and am hitting a variety of linker errors (which I think makes sense; it's trying to use my host (Linux) linker).

On the other hand, I can totally check out the CLI repo and build it manually on my Helios machine. If cross-compilation doesn't work, we could add a buildomat job to natively compile + publish the CLI tool?

[jessfraz]

yep for sure i already have a matrix for the others on release https://github.com/oxidecomputer/cli/blob/main/.github/workflows/make-release.yml#L10

[jclulow]

I have opened a PR: oxidecomputer/oxide.rs#117

This should produce an oxide binary for illumos systems. Is there a way, from GitHub Actions, to poll on the completion of a check run from outside GitHub Actions?

[jessfraz]

dope! hmm not sure, but since I'm uploading things to GCS maybe the release stuff could be changed to wait for everything to be in the bucket before generating things, idk

[jessfraz]

illumos releases https://github.com/oxidecomputer/cli/releases/tag/v0.1.0

[david-crespo]

Maybe a naive question, but if we're developing the API itself (adding routes, modifying types), how could one test such changes with the CLI?

You could use oxide api to hit the new route directly, but if you wanted to get fancy you might also want to generate the new OpenAPI spec and plug it into a locally cloned copy of the CLI, re-generate the client, and use that. It doesn't look like there are instructions in the CLI repo for doing that — I'd like to see that too. Do you currently use oxapi_demo for this purpose?

[jessfraz]

the cli is also generated from the spec I can add instructions so basically you'd update the spec in the API (oxide.rs) and (cli) repos and go, the cli is a macro from the spec file so its just updating the file.

[bnaecker]

@david-crespo Yep, I do use oxapi_demo that way, especially for testing user-visible errors, prototyping an integration test I want to build, reminding myself what some of the outputs look like, and probably other things I'm forgetting.

It looks like the oxide api satisfies most or all of those, which is great!

[jessfraz]

Added some notes : https://github.com/oxidecomputer/cli/blob/main/README.md#updating-the-spec

[bnaecker]

Thanks @jessfraz, that's what I was looking for! I'm glad we can still test out the user-facing aspects or just dog-food this repo with a command-line tool, thanks for making sure that's possible!

[jessfraz]

to be fair i stole the api command idea from gh who i think stole it from stripe who idk where they got it from..

[bnaecker]

to be fair i stole the api command idea from gh who i think stole it from stripe who idk where they got it from..

Great artists? Shoulders of giants? Pick your platitude, it's a good idea :)

[jessfraz]

if you want to get really fancy too you can do the following, because the alias command allows you to set up aliases:

say you are testing a endpoint like /organizations/{org_name}/projects/{project_name}/snapshots/{snapshot_id}

that's super long right for testing

you can do

oxide alias set get_snapshot 'api /organizations/$1/projects/$2/snapshots/$3'

such that when you run

oxide get_snapshot myorgname myproject my-snapshot-id

it populates the above... anyways if you want to get fancy with it