Skip to content

Commit

Permalink
docs: update test runbook and third party notices
Browse files Browse the repository at this point in the history
  • Loading branch information
stew-ro committed Jun 23, 2020
1 parent b1acec8 commit d81fd4d
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 5 deletions.
78 changes: 78 additions & 0 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -330,3 +330,81 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

==========

foreman

The MIT License

Copyright (c) IBM Corp. 2012,2016. All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

==========

file-type

The MIT License

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

==========

electron

The MIT License

Copyright (c) 2013-2020 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

==========
48 changes: 44 additions & 4 deletions docs/manual_testing/manual-test-runbook.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# Test Runbook

## **Feat: support Electron for on premise solution**

> ### Feature description ###
- Support FoTT's existing features in Electon
- Support local file system provider in Electron

> ### Use Case ###
**`As`** a user
**`I want`** to use FoTT's existing features through a desktop app
**`So`** I don't have to use a browser to use FoTT

**`As`** a user
**`I want`** to use files in my local file system
**`So`** I can keep all files on premise

> ### Acceptance criteria ###
#### Scenario One ####

**`Given`** I've installed new dependencies and started FoTT in Electron.\
**`When`** I click a command item in the title bar.\
**`Then`** FoTT should perform the command as expected.\

#### **Scenario Two** ####

**`Given`** I've installed new dependencies and started FoTT in Electron.\
**`When`** I perform an action for any existing feature.\
**`Then`** FoTT should perform as expected (the same as through a browser).\

#### ***Scenario Three*** ####

**`Given`** I've installed new dependencies and started FoTT in Electron.\
**`When`** I create a new connection with local file system as the provider.\
**`Then`** I should be able to create a project with the created connection.\

#### ***Scenario Four*** ####

**`Given`** I've installed new dependencies and started FoTT in Electron. And, I have an existing project in my local file system.\
**`When`** I click "Open local project" on the home page and select the existing project.\
**`Then`** FoTT should load the project as expected.\

___

## **Fix: enable to reorder tags quickly**

> ### Feature description ###
Expand All @@ -20,7 +64,6 @@ Enable reordering tags quickly
**`When`** I clicking fast on tags buttons `'Move tag up'` or `'Move tag down'`\
**`Then`** it moves without visible jittering.

___
___

## **Enable rerun OCR for current or all documents**
Expand Down Expand Up @@ -51,8 +94,6 @@ Adding the following buttons to the canvas command bar:
**`When`** I click "Run OCR on all documents" in the canvas command bar\
**`Then`** I should see "Running OCR..." for all documents. When running OCR finishes for each document, I should be ale to view each document's updated OCR JSON file.


___
___

## **Feat: enable compose model and add model name when training a new model**
Expand Down Expand Up @@ -87,7 +128,6 @@ ___
**`When`** I type customerized model name in input field and click compose button on modal\
**`Then`** I should see "Model is composing, please wait...". After that the list shows up again, new composed model with given name will be on the top of the list. The new composed model also has a "combine" icon.


#### ***Scenario Three*** ####

**`Given`** I've opened a project containing documents and I'm on the Model Compose page.\
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"private": true,
"main": "build/main.js",
"dependencies": {
"electron": "^8.3.0",
"file-type": "^14.6.2",
"@azure/storage-blob": "10.3.0",
"@fluentui/react": "^7.117.2",
Expand Down Expand Up @@ -95,6 +94,7 @@
"@types/redux-logger": "^3.0.7",
"acorn": "^7.1.1",
"foreman": "^3.0.1",
"electron": "^8.3.0",
"electron-builder": "^22.6.1",
"enzyme": "^3.10.0",
"enzyme-adapter-react-16": "^1.15.1",
Expand Down

0 comments on commit d81fd4d

Please sign in to comment.