Updated after sprint

isc-svelury · isc-svelury · commit b3d984ce19ce · 2022-04-06T15:32:41.000-04:00
diff --git a/Pre-release Test Plan.md b/Pre-release Test Plan.md
@@ -27,6 +27,23 @@
 2. Wrap mapping creation in else block: This was a small bug fix for the flat folder structure for certain file types enhancement to the mappings. 
 3. Changed the name of the % class replace field to be correct.
 4. Added newlines to outputs wherever necessary for better formatting.
+5. No Folders fix: This involved changing the way we store mappings and changing the mappings form field to account for this. This change allows the user to add paths to mappings with `NoFolders`. 
+6. `NameToInternalName()` tries to get internal names for all file types that have mappings. 
+7. `NameToInternalName()` does not return an empty string for a % class. 
+8. In `Name()`, there was condition that caused it to not match mappings properly. Fixed that.
+9. No more Bifrost: Got rid of the many lines that were created after the first commit because of a bug in the way we were getting substrings. 
+10. Commit graph does not flash and fill up the whole Commit History pane anymore.
+11. Stash drop now works properly.
+12. Fixed the branch modal to look like it did before the refactoring.
+13. Fixed an issue where the `NoFolders` toggle on a new mapping triggered the toggle on the first mapping instead of the clicked toggle. 
+14. Ensure that `GitStatus()` properly filtered out empty strings. 
+15. The passed modal size is now set correctly in the `addPopup()` method.
+16. Settings button in the WebUI is no longer unresponsive if the session expires. 
+17. Added input validation to settings page.
+18. Centred Settings page.
+19. Removed entries from `^SYS("SourceControl","Git","items")` in `ImportRoutines()` if we find that the file has been deleted. 
+20. `RefreshUnCommitted()` now uses git status to prune out files that were committed means other than the `Utils.Commit()` method.
+21. We don't try to source control ZPM documents.
 
 ### Documentation
 
@@ -38,11 +55,15 @@
    - A majority of the changes were related to the sidebar. 
    - All the event handlers were moved, and the accordion was also modified. 
    - I also collapsed the handlers for local and remote checkout and local and remote branch merge into a checkout handler and merge handler respectively. So those should be tested to make sure there aren't any issues.
+2. Unit test for `Utils.NameToInternalName()`.
+3. Unit test for `Utils.Name()`.
 
 ### Enhancements
 
 1. Configurability for how the "%" symbol is changed on export of `%` classes. 
 2. Removed `sc-list.txt` from the project. Everything should be working smoothly without it. Testing Add, Remove and Pull would be good.
+3. New files diff in Workspace: A diff for new files is now displayed in the Workspace in the Staging Area.
+4. Added granularity to `NoFolders` mappings. 
 
 <br>
 
@@ -54,17 +75,29 @@
 ### Setup and Configuration
 
 1. `%` class export configurability.
-2. `NoFolders` toggle (coming soon!)
+2. `NoFolders` toggle.
+3. Settings page input validation.
+4. Mappings storage.
 
 ### Backend/IRIS 
 
 1. **Single file removal from source control**: We need to test this make sure we are removing files correctly from the filesystem, IRIS and source control without affecting anything that shouldn't be.
 2. **No more `sc-list.txt`**: We need to make sure that `^SYS("SourceControl", "Git","items")` gets updated correctly every time the there is a change to list of tracked files &mdash; Add, Remove, Merge. One failure case I know is if the user does a fetch and then does a merge with a remote branch from the WebUI they will have technically executed a git pull that is independent of the package and any changes to the list of tracked files. I am not sure of the implications of the global being out of sync with git. 
+3. **`NameToInternalName()`**: Once we verify that all possible cases are covered in the existing unit test, we just need to run it.
+4. **`Name()`**: Once we verify that all possible cases are covered in the existing unit test, we just need to run it.
+5. **`GitStatus()`**: Run it once with all types of changes - untracked files, additions, deletions, modifications and verify that there are no empty strings in the returned variable. 
+6. **`RefreshUncommitted()`**: Commit a change through the WebUI and verify that the row for that change still exists in the table `%Studio_SourceControl.Change`. Make 2 change through either VS Code or studio, one in a file tracked by git and one in a file that is not. Run the method and verify that the committed change is removed from the queue and of the 2 uncommitted changes, the uncommitted change is still there. 
+7. **No source control for ZPM**: Try and fail to get the `ExternalName` of a `.ZPM` file.
 
 ### Frontend
 1. **Uncommitted check on checkout**: We need to check that files edited by another user are in fact being passed in the response from `api/uncommitted` and make sure that the prompt is being displayed as needed.
 2. **Navigation between Settings page and WebUI**: We need to test that the URL prefix (if any) prepends the URL correctly, and that the CSP session is shared. Initially we did not support URL prefixes. I don't know if there is something else in there that I might have missed. 
 3. **Sidebar operations**: We need to double-check all the sidebar operations after the refactoring to make sure those are all still good and all the prompts and stuff make sense. 
+4. **No more bifrost**: Verify that the extra lines below the first commit are gone.
+5. **Graph flash fill**: Verify that the graph doesn't glitch and fill the whole page, especially where there are more than 5 branches locally or on the remote. 
+6. **Stash Drop**: Verify that dropping a commit from the stash works as expected. 
+7. **Branches Modal**: Verify that the modal created when there are more than 5 local or remote branches looks the same as it did before the refactoring.
+8. **Settings button session expiry**: Verify that the settings button on the WebUI is no longer unresponsive if the CSP session has expired. Also check if when the session has expired, and you click the settings button, it goes to the login page and then to the settings page directly.
 
 ### Things to watch for
 1. Check if the output on the terminal has appropriate spacing.
@@ -91,16 +124,52 @@ Testing environment:
 
 1. **`%` class configurability**: 
    1. Setup: 
-      1. Add "_" as the `%` replacement character. 
+      1. Add "__" as the `%` replacement character. 
    2. Test cases:
       1. Add a `%` class to source control 
       2. Remove the class from source control. 
    3. Expected Results:
-      1. Class should be exported as "_<classname_without_percent>". 
+      1. Class should be exported as "__<class_name_without_percent>". 
       2. This should remove the file from source control and delete the external file.
 
 2. **`NoFolders` toggle**
-3. **Both together**
+   1. Setup:
+      1. Click the + button to add form fields for a new mapping.
+   2. Test cases:
+      1. Toggle the `NoFolders` switch.
+   3. Expected Results:
+      1. Verify that the correct switch is toggled.
+
+3. **Setting page input validation**
+   1. Test cases (in all cases, make the change and save):
+      1. Wrong path to the git executable. 
+      2. Wrong path to the SSH private key. (Only checks if file exists)
+      3. Empty fields in all the mappings fields one by one and then all together. 
+      4. No '@' in the user email.
+   2. Expected results:
+      1. "File not found"
+      2. "File not found"
+      3. You won't be able to submit the form till all the fields are filled. 
+      4. You should see a popup telling you the '@' is missing. 
+4. **Mappings Storage**
+   1. Setup:
+      1. Fill in "XYZ", "*" and "abc/def/xyz" into the form fields and switch off the `NoFolders` toggle. 
+      2. Click Save.
+   2. Test cases:
+      1.  `zw ^SYS("SourceControl", "Git", "settings", "mappings", "XYZ")`
+      2.  Switch on the `NoFolders` toggle and click save. Then run `zw ^SYS("SourceControl", "Git", "settings", "mappings", "XYZ")` in the terminal.
+      3.  Delete the mapping using the settings page and save.
+   3. Expected results:
+      1. `
+         ^SYS("SourceControl","Git","settings","mappings","XYZ","*")="abc/def/xyz"
+         ^SYS("SourceControl","Git","settings","mappings","XYZ","*","NoFolders")=1
+         `
+      2. `
+         ^SYS("SourceControl","Git","settings","mappings","XYZ","*")="abc/def/xyz"
+         `
+      3. `
+         // Should be blank
+         `
 
 ### Backend/IRIS 
 
@@ -129,6 +198,36 @@ Testing environment:
       1. Verify that the global is updated, and the file is exported and being tracked by git.
       2. Verify that the global is updated, and the file is exported and being tracked by git.
       3. Verify that the global is updated, and the file is imported.
+3. **`NameToInternalName()`**: Once we verify that all possible cases are covered in the existing unit test, we just need to run it.
+4. **`Name()`**: Once we verify that all possible cases are covered in the existing unit test, we just need to run it.
+5. **`GitStatus()`**: 
+   1. Setup:
+      1. Create 2 files `file1.txt` and `file2.txt` and commit them. 
+      2. Create another 2 files `file3.txt` and `file4.txt`.
+      3. Edit `file2.txt` to add some text and save it.
+      4. Stage `file4.txt` for commit.
+      5. Delete `file1.txt`
+   2. Test case:
+      1. In the terminal:
+         `d ##class(SourceControl.Git.Utils).GitStatus(.files, 1)
+         zw files
+         `
+   3. Expected result:
+      1. The variable should have 5 top-level subscripts. There should be no empty strings in the subscript or values. 
+6. **`RefreshUncommitted()`**: 
+   1. Setup:
+      1. Make a change in a file tracked by git and IRIS and commit it through the WebUI.
+      2. Verify that the row for that change still exists in the table `%Studio_SourceControl.Change`. 
+      3. Make a second change in a file that is tracked by IRIS but not by git. 
+   2. Test case:
+      1. Run the method.
+   3. Expected Results:
+      1. Check `%Studio_SourceControl.Change`. The row for the committed change should be gone, but the row for the uncommitted change should still be there.  
+7. **No source control for ZPM**: Try and fail to get the `ExternalName` of a `.ZPM` file.
+   1. Test case:
+      1. `w ##class(SourceControl.Git.Utils).Name("git-source-control.zpm")`
+   2. Expected result:
+      1. `""`
 
 ### Frontend
 1. **Uncommitted check on checkout**: We need to check that files edited by another user are in fact being passed in the response from `api/uncommitted` and make sure that the prompt is being displayed as needed.
@@ -170,4 +269,41 @@ Testing environment:
          2. Existing branch checkout: covered in Uncommitted check on checkout
          3. Merge branches
    2. Expected Results:
-      1. All the operations should be executed correctly. Git might throw errors and warnings, but that's okay. 
+      1. All the operations should be executed correctly. Git might throw errors and warnings, but that's okay. 
+4. **No more bifrost**: 
+   1. Expected Results:
+      1. Verify that the extra lines below the first commit are gone.
+5. **Graph flash fill**:  
+   1. Test cases:
+      1. Basic: No setup needed.
+      2. More than 5 local branches: Create enough branches to have 6 or more local branches. 
+      3. More than 5 remote branches: Push them to the remote to have 6 or more remote branches. 
+   2. Expected Results (for all 3 test cases):
+      1. Verify that the graph doesn't glitch and fill the whole page.
+   3. Cleanup:
+      1. Delete the extra local and remote branches after doing 7. 
+      2. Refresh the remote branches in the WebUI to get rid of the deleted refs.
+6. **Stash Drop**: 
+   1. Setup:
+      1. Make a change in a file.
+   2. Test case:
+      1. Stash the changes.
+      2. Go to the Stash and drop stashed changes. 
+   3. Expected results:
+      1. There should be an entry in the stash corresponding to the stashed changes. 
+      2. Dropping an entry should get rid of it but not change anything on the current branch. 
+7. **Branches Modal**: Verify that the modal created when there are more than 5 local or remote branches looks the same as it did before the refactoring.
+   1. Test case:
+      1. Click on the More button to get a list of local and remote branches. 
+   2. Expected results:
+      1. The modals should be appropriately sized (`modal-sm`) and should have no edges or borders. 
+      2. The accordions should be work as expected. 
+8. **Settings button session expiry**: 
+   1. Setup:
+      1. Go to the WebUI
+      2. Run `kill ^%cspSession`
+   2. Test case:
+      1. Click the Settings button
+   3. Expected Results:
+      1. Should be redirected to login page. 
+      2. After logging in, you should go directly to the settings, not back to the WebUI.
