feat: add slur detection test for chrome. fixes #181 and closes #186

ogbv-ml-rest/README.md

@@ -29,3 +29,14 @@ Note that if you are on windows and are using PowerShell, you might need to run
 ```
 Invoke-RestMethod -Method 'Post' -Uri http://localhost:8080/predict -Body (@{"text"="The food in this restaurant is disgusting"}|ConvertTo-Json) -ContentType "application/json"
 ```
+## Testing
+
+1. Go to the following url and download the extension zip file present in the release: https://github.com/tattle-made/OGBV/releases
+2. Extract the files locally and put the path to the dist folder present in the newly extracted files in the "options.add_argument" function in the slur_detection_tester.py file
+3. Run the following in your test environment (in order):
+
+```
+pip install selenium
+pip install webdriver-manager
+```
+4. Find a tweet with a known slur, you can look them up here: https://github.com/tattle-made/OGBV/blob/main/browser-extension/plugin/src/slur-replace.js. You'll need to hardcode the url in the "driver.get()" function. A known url is the following: https://twitter.com/jackantonoff/status/1579311659742416896. This should set you up for running the code. 

ogbv-ml-rest/slur_detection_tester.py

@@ -0,0 +1,35 @@
+from selenium import webdriver
+from selenium.webdriver.chrome.service import Service
+from webdriver_manager.chrome import ChromeDriverManager
+from selenium.common.exceptions import NoSuchElementException
+
+from time import sleep
+from selenium.webdriver.remote.webelement import WebElement
+
+
+
+
+
+# Configure the necessary command-line option
+options = webdriver.ChromeOptions()
+# Note that you will need to download the build of the extension and put the path to the dist folder 
+options.add_argument(r'--load-extension=path\to\dist_folder_of_extension')
+
+# installing chromedriver 
+driver = webdriver.Chrome(service=Service(ChromeDriverManager().install()), options = options)
+sleep(2)
+# add a hardcoded url leading to a particular tweet which you are using for testing 
+driver.get('your url here')
+sleep(5)
+# Check if the extension worked and log the result. 
+try:
+    # logic to check if the slur is replaced
+    ele = driver.find_element('xpath','//span[contains(text(),"▓")]')
+    print('Success! :-)')
+    # if no such span is present where the character - ▓ - is not present then the Failure message will show up
+    # Note that this will return success if the tweet by default contains the replacement character 
+except NoSuchElementException:
+    print('Failure! :-(')
+finally:
+    ''' Clean up. '''
+    driver.quit()