Manual Test Sensei is born

easy-software-ufal · Mar 29, 2023 · fd88504 · fd88504
1 parent cc4e171
commit fd88504
Show file tree

Hide file tree

Showing 44 changed files with 19,643 additions and 1,888 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,5 @@
 *.htm
 testcases/page.htm
 testcases/results.csv
-*.csv
 manual_test_smells.egg-info
 testcases/file.log
diff --git a/testcases/.gitignore → ManualTestSensei/.gitignore b/testcases/.gitignore → ManualTestSensei/.gitignore
diff --git a/testcases/AmbiguosTest.py → ManualTestSensei/AmbiguosTest.py b/testcases/AmbiguosTest.py → ManualTestSensei/AmbiguosTest.py
diff --git a/ManualTestSensei/README.md b/ManualTestSensei/README.md
@@ -0,0 +1,33 @@
+# Creating a venv
+We advise the creation of a virtual enviroment. Run this:
+`python -m venv venv`
+Then, activate the venv.
+
+on linux:
+`source ./venv/bin/activate`
+
+on windows:
+
+`.\venv\Scripts\`
+
+Now, you must install the dependencies.
+
+# Installing
+To run the program, you must install some packages. Run this: 
+
+`pip install -r requirements.txt`
+
+After downloading everything, you must download spacy's model.
+
+`python -m spacy download en_core_web_trf`
+
+After this, you are done.
+
+# Running
+To run the program, simply call it using the python runner and follow the instructions:
+
+`python main.py english`
+
+# After running
+After the program has ended, a .csv file will be created. It will always be named following this format:
+`result-date-time-model.csv`
diff --git a/testcases/boilerplate.py → ManualTestSensei/boilerplate.py b/testcases/boilerplate.py → ManualTestSensei/boilerplate.py
diff --git a/testcases/csv_writter.py → ManualTestSensei/csv_writter.py b/testcases/csv_writter.py → ManualTestSensei/csv_writter.py
diff --git a/testcases/data.py → ManualTestSensei/data.py b/testcases/data.py → ManualTestSensei/data.py
@@ -48,13 +48,13 @@ def smells_loader(smell_acronym: str) -> pd.DataFrame:
     return smells_loader
 
 
-def smells_loader_closure_v2():
-    df = pd.read_csv('dirs.txt', header=None)
-    df.columns = [FILE_COL]
-    df = df.loc[df[FILE_COL].apply(lambda x: Path(x).exists())]
-    df[FILE_COL] = df[FILE_COL].apply(lambda x: Path(x))
-    print(df)
-    return df.reset_index(drop=True)
+# def smells_loader_closure_v2():
+#     df = pd.read_csv('dirs.txt', header=None)
+#     df.columns = [FILE_COL]
+#     df = df.loc[df[FILE_COL].apply(lambda x: Path(x).exists())]
+#     df[FILE_COL] = df[FILE_COL].apply(lambda x: Path(x))
+#     print(df)
+#     return df.reset_index(drop=True)
 
 
 smells_loader = smells_loader_closure()

diff --git a/...ndency_rules/ambiguous_test_adjectives.py → ...ndency_rules/ambiguous_test_adjectives.py b/...ndency_rules/ambiguous_test_adjectives.py → ...ndency_rules/ambiguous_test_adjectives.py
diff --git a/...rules/ambiguous_test_adverbs_of_manner.py → ...rules/ambiguous_test_adverbs_of_manner.py b/...rules/ambiguous_test_adverbs_of_manner.py → ...rules/ambiguous_test_adverbs_of_manner.py
@@ -1,4 +1,4 @@
-from testcases.keywords import Keywords
+from keywords import Keywords
 
 adverbs_of_manner_termination = Keywords().keywords['adverbs_of_manner_termination']
 

diff --git a/...les/ambiguous_test_comparative_adverbs.py → ...les/ambiguous_test_comparative_adverbs.py b/...les/ambiguous_test_comparative_adverbs.py → ...les/ambiguous_test_comparative_adverbs.py
diff --git a/.../ambiguous_test_indefinite_determiners.py → .../ambiguous_test_indefinite_determiners.py b/.../ambiguous_test_indefinite_determiners.py → .../ambiguous_test_indefinite_determiners.py
diff --git a/...les/ambiguous_test_indefinite_pronouns.py → ...les/ambiguous_test_indefinite_pronouns.py b/...les/ambiguous_test_indefinite_pronouns.py → ...les/ambiguous_test_indefinite_pronouns.py
diff --git a/...ases/dependency_rules/conditional_test.py → ...nsei/dependency_rules/conditional_test.py b/...ases/dependency_rules/conditional_test.py → ...nsei/dependency_rules/conditional_test.py
diff --git a/testcases/dependency_rules/eager_step.py → ...TestSensei/dependency_rules/eager_step.py b/testcases/dependency_rules/eager_step.py → ...TestSensei/dependency_rules/eager_step.py
diff --git a/...ependency_rules/misplaced_precondition.py → ...ependency_rules/misplaced_precondition.py b/...ependency_rules/misplaced_precondition.py → ...ependency_rules/misplaced_precondition.py
diff --git a/...misplaced_result_affirmative_sentences.py → ...misplaced_result_affirmative_sentences.py b/...misplaced_result_affirmative_sentences.py → ...misplaced_result_affirmative_sentences.py
diff --git a/...cy_rules/misplaced_result_verification.py → ...cy_rules/misplaced_result_verification.py b/...cy_rules/misplaced_result_verification.py → ...cy_rules/misplaced_result_verification.py
@@ -1,4 +1,4 @@
-from testcases.keywords import Keywords
+from keywords import Keywords
 
 verifications = Keywords().keywords['verifications']
 

diff --git a/testcases/dependency_rules/misplaced_step.py → ...Sensei/dependency_rules/misplaced_step.py b/testcases/dependency_rules/misplaced_step.py → ...Sensei/dependency_rules/misplaced_step.py
@@ -1,4 +1,4 @@
-from testcases.keywords import Keywords
+from keywords import Keywords
 
 verifications = Keywords().keywords['verifications']
 

diff --git a/testcases/dependency_rules/optional_test.py → ...tSensei/dependency_rules/optional_test.py b/testcases/dependency_rules/optional_test.py → ...tSensei/dependency_rules/optional_test.py
diff --git a/testcases/dependency_rules/undefined_wait.py → ...Sensei/dependency_rules/undefined_wait.py b/testcases/dependency_rules/undefined_wait.py → ...Sensei/dependency_rules/undefined_wait.py
diff --git a/...dependency_rules/unspecified_parameter.py → ...dependency_rules/unspecified_parameter.py b/...dependency_rules/unspecified_parameter.py → ...dependency_rules/unspecified_parameter.py
diff --git a/testcases/dir_finder.py → ManualTestSensei/dir_finder.py b/testcases/dir_finder.py → ManualTestSensei/dir_finder.py
@@ -1,3 +1,5 @@
+# This is an auxiliary tool to identify all the files on the repo.
+
 import glob
 from rich import print
 import os

diff --git a/testcases/displacy.py → ManualTestSensei/displacy.py b/testcases/displacy.py → ManualTestSensei/displacy.py
diff --git a/ManualTestSensei/file.log b/ManualTestSensei/file.log
diff --git a/ManualTestSensei/files.csv b/ManualTestSensei/files.csv
diff --git a/testcases/keywords.py → ManualTestSensei/keywords.py b/testcases/keywords.py → ManualTestSensei/keywords.py
diff --git a/testcases/log.config → ManualTestSensei/log.config b/testcases/log.config → ManualTestSensei/log.config
diff --git a/testcases/logger.py → ManualTestSensei/logger.py b/testcases/logger.py → ManualTestSensei/logger.py
diff --git a/testcases/main.py → ManualTestSensei/main.py b/testcases/main.py → ManualTestSensei/main.py
@@ -1,7 +1,7 @@
 import logging.config
 
 from data import get_tests
-from testcases import matchers
+import matchers
 
 logging.config.fileConfig(fname='log.config', disable_existing_loggers=False)
 log = logging.getLogger(__name__)

diff --git a/testcases/matchers.py → ManualTestSensei/matchers.py b/testcases/matchers.py → ManualTestSensei/matchers.py
diff --git a/testcases/matchers_factory.py → ManualTestSensei/matchers_factory.py b/testcases/matchers_factory.py → ManualTestSensei/matchers_factory.py
diff --git a/testcases/pipeline.py → ManualTestSensei/pipeline.py b/testcases/pipeline.py → ManualTestSensei/pipeline.py
diff --git a/testcases/requirements.txt → ManualTestSensei/requirements.txt b/testcases/requirements.txt → ManualTestSensei/requirements.txt
@@ -83,7 +83,7 @@ smart-open==5.2.1
     # via
     #   pathy
     #   spacy
-spacy==3.5
+spacy==3.4.1
     # via manual-test-smells (setup.py)
 spacy-legacy==3.0.12
     # via spacy

diff --git a/ManualTestSensei/results-20230329-125316-en_core_web_lg.csv b/ManualTestSensei/results-20230329-125316-en_core_web_lg.csv
diff --git a/testcases/setup.py → ManualTestSensei/setup.py b/testcases/setup.py → ManualTestSensei/setup.py
@@ -11,7 +11,7 @@
     name='manual_test_smells',
     version='0.0.2',
     packages=find_packages(),
-    install_requires=['spacy==3.5',
+    install_requires=['spacy==3.4.1',
                         'pandas',
                         'rich',
                         'scipy',

diff --git a/testcases/stats.py → ManualTestSensei/stats.py b/testcases/stats.py → ManualTestSensei/stats.py
diff --git a/testcases/tests.py → ManualTestSensei/tests.py b/testcases/tests.py → ManualTestSensei/tests.py
diff --git a/README.md b/README.md
@@ -1,6 +1,19 @@
-# Ubuntu Manual Test Smell Analysis
-This repository contains the manual testcases utilized by the quality team for testing ubuntu (and its flavors) packages and images, as well as manual tests for hardware compatibility. 
+# Manual Test Sensei 🥷
+Manual Test Sensei is a tool for detecting "test smells" in manual testing. Test smells are patterns of poor testing practices that can lead to ineffective or incomplete testing. By identifying and addressing these issues, Manual Test Sensei can help improve the quality and effectiveness of manual testing.
+
+The smells identified by our Sensei are based on the paper [Hunting for smells in natural language tests](https://ieeexplore.ieee.org/document/6606682/), by _Hauptmann et al._, on the [Open Test Smells Catalog](https://easy.github.io/testsmells/index.html), and on the tool creators' expertise on the subject.
+
+Also, there is a written paper associated 
+
+This repository is divided in two main folders. `\ManualTestSensei\` which is our tool, `\testcases\` where the UbuntuOS testcases are located.
+
+## `\ManualTestSensei\`
+
+This folder contains the tool and it's packages. There's a `README.md` inside it, guiding the reader on how to use the tool. If you want to run the tool, enter this folder.
+
+## `\testcases\`
+This folder contains the manual testcases utilized by the quality team for testing ubuntu (and its flavors) packages and images, as well as manual tests for hardware compatibility. It's a fork of [Ubuntu Manual Tests](https://launchpad.net/ubuntu-manual-tests) that has been analyzed in search of test smells. If you want to see how a manual test is written, enter this folder.
+
 
-Also, this is a fork of [Ubuntu Manual Tests](https://launchpad.net/ubuntu-manual-tests) that has been analyzed in search of test smells. These smells are based on Hauptmann et al. and on the [Open Test Smells Catalog](https://easy.github.io/testsmells/index.html).