open-source-labs · KristinHooper · May 2, 2023 · May 2, 2023 · May 2, 2023 · May 2, 2023
diff --git a/.env b/.env
@@ -1,4 +1,4 @@
 APP_DEV=true
 BROWSER=non
 SKIP_PREFLIGHT_CHECK=true
-MONGO_LINK=mongodb://localhost:27017
+MONGO_LINK=mongodb+srv://username:[email protected]/?retryWrites=true&w=majority
diff --git a/.gitignore b/.gitignore
@@ -37,9 +37,13 @@ bower_components
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
+# Test coverage directory
+coverage/
+
 # Dependency directories
 node_modules/
 jspm_packages/
+package-lock.json
 
 # TypeScript v1 declaration files
 typings/
@@ -108,3 +112,5 @@ dist
 /build
 .DS_Store
 .dccache
+
+.env
diff --git a/MyLibrary/.gitignore b/MyLibrary/.gitignore
diff --git a/MyLibrary/.swiftpm/xcode/package.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/MyLibrary/.swiftpm/xcode/package.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
diff --git a/MyLibrary/Package.swift b/MyLibrary/Package.swift
diff --git a/MyLibrary/README.md b/MyLibrary/README.md
diff --git a/MyLibrary/Sources/MyLibrary/MyLibrary.swift b/MyLibrary/Sources/MyLibrary/MyLibrary.swift
diff --git a/MyLibrary/Tests/MyLibraryTests/MyLibraryTests.swift b/MyLibrary/Tests/MyLibraryTests/MyLibraryTests.swift
diff --git a/Notes On Spearmintv15.md b/Notes On Spearmintv15.md
@@ -0,0 +1,55 @@
+The Spearmint Project(ver. XV)
+**_These notes are incomplete, but should give some context to what exists_**
+This is a brief writeup of Spearmint's initial "Weakpoints", Additions&Changes brought about by Iteration 15, and Additional Fixes/Considerations required
+
+Spearmint Problems
+
+Notorious B.U.G., launchers of v15, had 3 Goals
+1.Documenting how Spearmint worked
+2.Upgrading the Accessibility testing tool
+3.Providing a POC that gave an alternative way to structure and handle the testing tools' state, because previous groups found the original too inflexible to expand on to include more Jest capabilities. React(Beta) being the playground for working out
+the POC.
+
+Existed Since We've Started:
+-Some Accessibility Test existed only in name, not in functionality
+-Debugging. Error messages point to bundle. Also, unable to get Electrons "devtools" to
+run react DevTools
+-No Error Handler for Components
+-No Confirmation Dialogue before X'ing out of blocks
+
+Changes Implemented:
+For Accessibility Tool
+-Dependencies updated
+-A Accessibility Test
+
+For React Testing Tool:
+-new State Structure for UI to work with(found in 'updatedTestCaseReducer' file)
+-abstracted add, update, delete methods and workflow(Can be traced from the component, to 'RTFsContextsProvider' file, to the
+'updatedFrontendFrameworkTestCaseActions' file, to the 'updatedTestCaseReducer' file)
+-functions already created for deep copying, adding, changing, and deleting (from)the state object
+
+-Jest Abilities Not Fully Fleshed Out
+-Old testing workflow(look into FireEvent, vs Screen for jest testing)
+-UI not intuitive
+-UI isn't organized in a way to optimize space usage(look into accordions and tabs for consolidating children to describe blocks,test blocks, etc)
+-mock data implementation not intuitive. likely not implemented correctly for potential jest workflows
+-a convoluted way to representing relationships between components, which represented available logic of a jest test (e.g. describes, tests/its, statements). Caused restrictions in app's capability to fully reflect what is possible with Jest testing.(e.g.implementing)
+-Typescript not fully implemented(should be left last until you're feeling sure about how your central state's structure
+should look)
+
+Additinoal fixes/considerations needed needed
+For the React(Beta)
+-Decide for yourself which state structure makes the the most sense for you, and lends itself to implementing full jest testing capabilities
+-AutoFill for options of Action and Assert Components needs to be updated wot work with
+new state structure and re-enabled
+-debug the Props Component so it will render properly
+-Setup Teardowns need to be quanitfied in a way that can be represented
+by a form like setup(e.g. user either fills out inputs or uses drags and drops
+to create the setups and teardowns)
+-add more jest testing capabilities that don't exist yet
+-Props and Statements are not handled correctly yet by "useGenerateTest.jsx"
+-in 'useGenerateTest', use visual Studios 'search' tool to find the code snippets related to 'Updated React'. there should be at least 2, 1 being 'import', the other being 'switch'. There is no need for 2 versions of 'useGenerateTest', but there exists two because of our creating a playground to be safe. the second is called 'updatedUseGenerateTest. decide how u best want to merge them, or if every Tool should have its own 'useGenerateTest' for just its switchcase.
+-for the switch case 'updatedReact' found in 'useGenerateTest'(or more specifically 'updatedUseGenerateTest' if you haven't moved),
+-complete the test file generating needed for the 'updated react' switch case. Needs support for statements.
+
+-lastly,typescript
diff --git a/README-dev.md b/README-dev.md
@@ -1,75 +1,149 @@
 # How to use in development mode
 
-**Mac Developers**: Install Xcode 
+**Mac Developers**: Install Xcode command line tools if you don't already have them.
 
-**Windows Developers**: Install Node.js globally, may also have to run Spearmint in admin mode. 
+**Windows Developers**: Install Node.js globally, may also have to run Spearmint in admin mode.
+
+## Procedure for working on the project as a Windows user.
+
+1. Download VcXsrv or a similar program in order to run an X environment on Windows. [VcXsrv](https://sourceforge.net/projects/vcxsrv/)
+2. Configure XLaunch properly:
+3. On the first settings screen on launch, select the following settings:
+	- Multiple windows
+	- Display number: -1
+4. On the second page select the “Start no client” option
+5. On the third setting screen select the following options:
+   -	Clipboard
+   -  Primary Selection
+   -	Native opengl
+   -	Under “Additional Parameters” textbox write ‘-ac’ (no quotes)
+
+Completing these steps after installing will launch XLaunch and enable you to run Spearmint in the Windows desktop environment.  
+
+# Initial Setup
+
+As of January 2023, spearmint works with node version 20.1.0.
+React must be version 17 due to a dependency for mui. Fix-path must be version 3.0.0 due to 4.0.0 only being usable with an import statement, which is not supported in electron.jsx.
 
 1. Fork and clone this repository.
-2. Use node version 16.13: ```nvm use 16.13``` (make sure that you already installed v 16.13, ```nvm install 16.13```)
-3. ```npm install```
-4. Create a .env file in the root directory of the project
-5. Insert the following lines of code into the .env file
-    ```
-    APP_DEV=true
-    BROWSER=non
-    SKIP_PREFLIGHT_CHECK=true
-    MONGO_LINK=
-    ```
-6. Set MONGO_LINK to your MongoDB URI (ex: mongodb://localhost:27017)
-7. Make sure your MongoDB is running if it's hosted locally. 
-8. ```npm run rebuild``` 
-9. ```npm run watch``` on one terminal
-10. ```npm run start-dev``` on another terminal, make sure you also use node version 16.13 in this terminal. 
 
+2. `npm install`
+
+3. Create a .env file in the root directory of the project
+
+4. Insert the following lines of code into the .env file
+
+   ```
+   APP_DEV=true
+   BROWSER=non
+   SKIP_PREFLIGHT_CHECK=true
+   MONGO_LINK=mongodb+srv://username:[email protected]/?retryWrites=true&w=majority
+   ```
+
+5. Set MONGO_LINK to your MongoDB URI or use the URI we provided (ex: mongodb://localhost:27017)
+
+6. Make sure your MongoDB is running if it's hosted locally.
+
+7. `npm run rebuild` (different from `npm rebuild` so please pay attention to that)
+
+8. `npm run dev`
+
+# Tips for development mode
+
+- To enable hot-module reloading, uncomment line 22 in the electron.jsx file.
+
+      // require('electron-reloader')(module);
+
+- To enable Chrome Dev Tools, uncomment line 70 in the electron.jsx file:
 
+      // mainWindow.webContents.openDevTools();
+
+# Suggestions if you would like contriubute:
+
+1. Exporting test files in TypeScript: the tests currently export in JS.
+
+2. Convert codebase to TypeScript: currently, there are some files in TS, and others in JS. It would be great to convert all to TS.
+
+3. Dry refactoring of codebase: A lot of the folders and files for the frontend frameworks testing are the same, and the codebase would GREATLY benefit from refactoring and modularizing those.
+
+4. Persist user data: there is currently sign up and login functionality. V0.13.0 commented out the login functionality because there is currently no user data being persisted. A great feature would be to save tests to work on them later, or create templates for each user.
+
+5. GitHub OAuth is functional, but Google OAuth is currently broken. If you are planning to persist user data, this is an excellent feature to resolve.
+
+6. Add more customization to the tests themselves such as chaining expects, add the ability to use siblings and children, etc., or having the ability to test more than one component in one test file.
+
+7. Some of test cases needs improvement on UI as they do not have any styling or optimal user experience
+
+8. Continue to improve internal testing coverage – while it has been greatly expanded there are many parts of the internals of the application that are still not being tested, and especially with regards to integration and end to end testing, more could be done.
+
+9. Consider removing MUI framework as it is incompatible with React v18+ and no longer being actively updated - either replacing with another frontend framework or styling via CSS.
+
+10. Consider implementing React Dev Tools in the app. 
+
+**_Please feel free to add any other features or fixes that you would like or are interested in._**
 
 # Build and Run image on Docker
 
-## Pre-requisites 
-- Mongo: Mongodb is used for authentication functionality. If you didn't use locally hosted mongodb URI in .env file, you may skip to the X server section. 
+## Pre-requisites
 
-    1. Add `172.17.0.1` and `0.0.0.0` to the network interfaces of mongo config file.
+- Mongo: Mongodb is used for authentication functionality. If you didn't use locally hosted mongodb URI in .env file, you may skip to the X server section.
 
-        a. Open `mongod.cfg` (Usually located in C:\Program Files\MongoDB\Server\4.4\bin)
+  1.  Add `172.17.0.1` and `0.0.0.0` to the network interfaces of mongo config file.
 
-            # network interfaces
-            net:
-              port: 27017
-              bindIp: 127.0.0.1, 172.17.0.1, 0.0.0.0
+      a. Open `mongod.cfg` (Usually located in C:\Program Files\MongoDB\Server\4.4\bin)
 
-     2. Run mongo on port 27017
+          # network interfaces
+          net:
+            port: 27017
+            bindIp: 127.0.0.1, 172.17.0.1, 0.0.0.0
+
+  2.  Run mongo on port 27017
 
 - X server
 
-    1. Download and run either [X410](https://x410.dev/) or [VcXsrv](https://sourceforge.net/projects/vcxsrv/)
+  1. Download and run either [X410](https://x410.dev/) or [VcXsrv](https://sourceforge.net/projects/vcxsrv/)
 
-        * For X410, use the following configuration
+     - For X410, use the following configuration
 
-        ![x410 with display = 0](/public/x410.png)
+     ![x410 with display = 0](/public/x410.png)
 
-        * For VcXsrv: change the display number to 0, for other settings, use default. 
+     - For VcXsrv: change the display number to 0, for other settings, use default.
 
-        ![VcXsrv with display = 0](/public/VcXsrv.png)
+     ![VcXsrv with display = 0](/public/VcXsrv.png)
 
+## Running the image
 
-## Running the image 
-After running the mongo on port 27017 and running the x server with display number of 0, follow the steps below. 
+After running the mongo on port 27017 and running the x server with display number of 0, follow the steps below.
 
-1. Build the docker image by running the following command
+1.  Build the docker image by running the following command
 
     `docker build -t [image name] .`
 
-2. Run the docker image by using the following command: 
+2.  Run the docker image by using the following command:
+
+        `docker run -e DISPLAY='host.docker.internal:0.0' -it -v [directory of project to be tested]:/[directory to create volume] [image name]`
+
+        - `-e DISPLAY='host.docker.internal:0.0'`: Set environment variable ‘display’ to host.docker.internal:0.0
 
-    `docker run -e DISPLAY='host.docker.internal:0.0' -it -v [directory of project to be tested]:/[directory to create volume] [image name]`
+        - `-it`: Run container as interactive
 
-    - `-e DISPLAY='host.docker.internal:0.0'`: Set environment variable ‘display’ to host.docker.internal:0.0 
+        - `-v`: Creates a volume and mounts the testing application into the container. (ex: `-v [testing files]:[created volume]`)
 
-    - `-it`: Run container as interactive
+        *Please note that once the spearmint container is running, you can only access the folders that you mounted here.`
 
-    - `-v`: Creates a volume and mounts the testing application into the container. (ex: `-v [testing files]:[created volume]`)
+    **_Please note that the image uses root user, as shown in the Dockerfile._**
 
-    *Please note that once the spearmint container is running, you can only access the folders that you mounted here.
+# Resources for onboarding developers
 
-*Please note that the image uses root user, as shown in the Dockerfile.
-
+<div align="center" style="display:flex;flex-direction:column;"}>
+  <div align>
+  <a href="https://excalidraw.com/#room=9abc890c35d8e7d3f149,htwzR9k0SUhZzhwB3zjJ8A">
+      <img width="300" height="72" alt="Connect to the Dev Excalidraw" src="https://img.shields.io/badge/Excalidraw-181717?style=for-the-badge&logo"/>
+  </a>
+  <a href="https://discord.gg/5FNPTvZSTq">
+    <img width="300" height="72" src="https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white"/>
+  </a>
+  <h3>Virtual whiteboard for sketching the structure/data flow of spearmint. Also inside the /public/spearmint.svg file</h3>
+  <h3>Let's stay up to date, ask/answer questions, and connect with one another!</h3>
+  <h3>Join the spearmint developer community Discord!</h3>
+</div>