Add insomnia V4 import support to Insomnia CLI

[abbasc52]

Unable to use insomnia designer export with CLI
I am planning to use the inso cli to integrate with CI. I don't plan on create a separate git repo and would like to use it along with my existing repo.

Importing insomnia export in the CLI
If the cli can import the insomnia_export file and create the .insomnia folder or directly run it , that can simplify using inso for CI

[develohpanda]

Insomnia Designer can certainly sync with an existing repo, co-exist with other files. There are some edge cases that we need to work through, but the intention is for your code and Insomnia Designer data to co-exist. The .insomnia folder format is a little nicer to review changes for, because each model exists as a standalone file in a particular folder structure.

Would that suffice as a long-term solution?

I'm saying that, I do agree that consuming the v4 export format as a data source for inso is an entirely valid request as well, and we had talked about it in the past but had not implemented. This would be a great short term solution, and it shouldn't be too challenging as the data structures used by the app and inso are very similar.

Also, I'd love to understand what your intended workflow is, and maybe what your ideal workflow would be. I'm assuming you have a manual process to export the v4 format file and place it in your repository?

[abbasc52]

@develohpanda you are right having .insomnia folder would we ideal for a long term solution. But the current challenge i am facing is essential exporting the designer data to a local folder which can be directly accessed by CLI. It would also work if insomnia designer can create .insomnia folder via export data feature. Although we plan on maintaining versioning for the data, we would prefer handling it ourselves as it gives us more freedom

[develohpanda]

Great point about the freedom it provides, keen to explore that as you further implement your workflow. Perhaps inso can be extended with some export functionality.

What is your reason for needing a local folder containing designer data for inso?

Running inso locally, it should detect the app data folder for Designer, and work seamlessly. (And running inso in CI, it would detect the .insomnia folder and use that automatically.)

Could there be something I'm missing, in that it's not detecting your local app data folder?

[abbasc52]

@develohpanda let me explain my scenario:
We have our API project and we plan to run tests on CI
We also have some strict rules where we can't check in any credentials.
So currently we use postman and export the collection to our repository and run newman(postman cli) for our CI tests.

I am planning to replace it with insomnia designer + inso but having trouble with exporting it and running it on CI
Essentially if i could locally export the tests, i can push it to whichever repository i want. Also as i mentioned, we are little skeptic of giving a tool credentials to check in code on our behalf.

[develohpanda]

Totally makes sense. Thanks for explaining your workflow, that's very insightful!

I'll add some notes to this issue (when on computer) around how to add v4 support to inso 👍

[develohpanda]

For anybody looking to pick this up, it is a matter of adding a new adapter here for the Insomnia V4 export format, returning a database object in this format:

insomnia/packages/insomnia-inso/src/db/index.js

Lines 17 to 25 in 19a9d6a

	export type Database = {|
	ApiSpec: Array<ApiSpec>,
	Environment: Array<Environment>,
	Request: Array<BaseModel>,
	RequestGroup: Array<BaseModel>,
	Workspace: Array<Workspace>,
	UnitTestSuite: Array<UnitTestSuite>,
	UnitTest: Array<UnitTest>,
	|};

An update will be required to loadDb in order to consume the new adapter:

insomnia/packages/insomnia-inso/src/db/index.js

Lines 48 to 52 in 19a9d6a

	export const loadDb = async ({
	workingDir,
	appDataDir,
	filterTypes,
	}: Options = {}): Promise<Database> => {

There will also need to be a global option to specify the export file:

insomnia/packages/insomnia-inso/src/cli.js

Lines 171 to 178 in 19a9d6a

	// Global options
	cmd
	.option('-w, --workingDir <dir>', 'set working directory')
	.option('-a, --appDataDir <dir>', 'set the app data directory')
	.option('--config <path>', 'path to configuration file')
	.option('--verbose', 'show additional logs while running the command')
	.option('--printOptions', 'print the loaded options')
	.option('--ci', 'run in CI, disables all prompts');

The new option will need to be configurable via a config file:

insomnia/packages/insomnia-inso/src/get-options.js

Lines 21 to 27 in 19a9d6a

	const OptionsSupportedInConfigFile: Array<$Keys<GlobalOptions>> = [
	'appDataDir',
	'workingDir',
	'ci',
	'verbose',
	'printOptions',
	];

There are lots of unit tests set up, so please add to them as well. 😄

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Aconitin]

I'm having the same issue(s) - I'd like to use an existing Insomnia Export (with all the tests in it) to run CLI tests with, but inso doesn't allow importing that.