Skip to content

Commit

Permalink
[FEATURE] Add markdown file to document test case flows (#392)
Browse files Browse the repository at this point in the history
Co-authored-by: Ian Seabock (Centific Technologies Inc) <[email protected]>
  • Loading branch information
iseabock and Ian Seabock (Centific Technologies Inc) committed Nov 17, 2023
1 parent 056939b commit 376ccac
Showing 1 changed file with 77 additions and 0 deletions.
77 changes: 77 additions & 0 deletions TEST_CASE_FLOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Introduction
Below are some flows to follow to make sure code changes are tested effectivly and efficiently.
The goal is to make sure that this is repeatable and can be done by anyone to avoid regressions.

## Test Case Flows
- with data, streaming
- with data, non streaming
- without data, streaming
- without data, non streaming
- All of the above with and without chat history

### With Data, Streaming
The following environment variables are required to run this test case:

`AZURE_SEARCH_SERVICE`\
`AZURE_SEARCH_INDEX`\
`AZURE_SEARCH_KEY`

`AZURE_OPENAI_STREAM` should be set to `true`

### With Data, Streaming, Chat History
Keep the same environment variables as above, but add the following:

`AZURE_COSMOSDB_DATABASE`\
`AZURE_COSMOSDB_ACCOUNT`\
`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\
`AZURE_COSMOSDB_ACCOUNT_KEY`

### With Data, Nonstreaming
The following environment variables are required to run this test case:
`AZURE_SEARCH_SERVICE`\
`AZURE_SEARCH_INDEX`\
`AZURE_SEARCH_KEY`

`AZURE_OPENAI_STREAM` should be set to `false`

### With Data, Nonstreaming, Chat History
Keep the same environment variables as above, but add the following:

`AZURE_COSMOSDB_DATABASE`\
`AZURE_COSMOSDB_ACCOUNT`\
`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\
`AZURE_COSMOSDB_ACCOUNT_KEY`

### Without Data, Streaming
The following environment variables should **not** be set:

`AZURE_SEARCH_SERVICE`\
`AZURE_SEARCH_INDEX`\
`AZURE_SEARCH_KEY`

`AZURE_OPENAI_STREAM` should be set to `true`

### Without Data, Streaming, Chat History
Keep the same environment variables as above, but add the following:

`AZURE_COSMOSDB_DATABASE`\
`AZURE_COSMOSDB_ACCOUNT`\
`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\
`AZURE_COSMOSDB_ACCOUNT_KEY`

### Without Data, Nonstreaming
The following environment variables should **not** be set:

`AZURE_SEARCH_SERVICE`\
`AZURE_SEARCH_INDEX`\
`AZURE_SEARCH_KEY`

`AZURE_OPENAI_STREAM` should be set to `false`

### Without Data, Nonstreaming, Chat History
Keep the same environment variables as above, but add the following:

`AZURE_COSMOSDB_DATABASE`\
`AZURE_COSMOSDB_ACCOUNT`\
`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\
`AZURE_COSMOSDB_ACCOUNT_KEY`

0 comments on commit 376ccac

Please sign in to comment.