Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:54:24Z

Sthakur5: /* Proposed Solution */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified:
* Assignment.java 
* BackEnd.java 
* FrontEnd.java 
* FrontEndView.java 
* MySQL5xDataAccessObject.java 
* MySQL80DataAccessObject.java 
* OracleDataAccessObject.java 
* Submission.java 
* SubmissionCollection.java 

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39]. 
The demo can be found [https://www.youtube.com/watch?v=_REy_S142bQ&ab_channel=RachitSharma].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:54:06Z

Sthakur5: /* Proposed Solution */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified
* Assignment.java 
* BackEnd.java 
* FrontEnd.java 
* FrontEndView.java 
* MySQL5xDataAccessObject.java 
* MySQL80DataAccessObject.java 
* OracleDataAccessObject.java 
* Submission.java 
* SubmissionCollection.java 

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39]. 
The demo can be found [https://www.youtube.com/watch?v=_REy_S142bQ&ab_channel=RachitSharma].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:52:45Z

Sthakur5: /* Proposed Solution */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified
* '''Assignment.java * BackEnd.java * FrontEnd.java * FrontEndView.java * MySQL5xDataAccessObject.java * MySQL80DataAccessObject.java * OracleDataAccessObject.java * Submission.java * SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39]. 
The demo can be found [https://www.youtube.com/watch?v=_REy_S142bQ&ab_channel=RachitSharma].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:51:52Z

Sthakur5: /* Github and Related Link */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39]. 
The demo can be found [https://www.youtube.com/watch?v=_REy_S142bQ&ab_channel=RachitSharma].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:51:36Z

Sthakur5: /* Github and Related Link */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].
The demo can be found [https://www.youtube.com/watch?v=_REy_S142bQ&ab_channel=RachitSharma].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:45:10Z

Sthakur5: /* Proposed Solution */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-merge.yml '''maven-build-merge.yml'''] and [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/.github/workflows/maven-build-pr.yml '''maven-build-pr.yml'''] files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:42:42Z

Sthakur5: /* Proposed Solution */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/pom.xml pom.xml]''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:42:07Z

Sthakur5: /* SubmissionCollection.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:41:45Z

Sthakur5: /* FrontEnd.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''[https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java FrontEndTests.java]''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java" '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:40:54Z

Sthakur5: /* FrontEnd.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java" '''FrontEndTests.java'''] file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java" '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:39:23Z

Sthakur5: /* SubmissionCollection.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java" '''FrontEndTests.java'''] file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/SubmissionCollectionTests.java" '''SubmissionCollectionTests.java'''] file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:38:59Z

Sthakur5: /* FrontEnd.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created ["https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/FrontEndTests.java" '''FrontEndTests.java'''] file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created '''SubmissionCollectionTests.java''' file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:38:31Z

Sthakur5: /* TestResult.java */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/TestResultTests.java '''TestResultTests.java'''] file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''FrontEndTests.java''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created '''SubmissionCollectionTests.java''' file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:37:48Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created [https://github.com/Sakshamrzt/SQL-File-Evaluation/blob/master/src/sqlfe/junit/AssignmentTests.java '''AssignmentTests.java'''] file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created '''TestResultTests.java''' file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''FrontEndTests.java''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created '''SubmissionCollectionTests.java''' file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:31:59Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created '''AssignmentTests.java''' file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created '''TestResultTests.java''' file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''FrontEndTests.java''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created '''SubmissionCollectionTests.java''' file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

=== Track our works for collaboration ===

We have used Github projects to keep a track of all the tasks and the progress associated with those tasks.

[[File:progress.png|1200px|project tasks]]

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

File:Progress.png

2022-04-27T15:31:48Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-27T15:10:25Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Files modified===

BackEnd.java

[[File:backend.png|800px|thumb|center|                               ]]

Submissions.java

[[File:Submissions.png|800px|thumb|center|                               ]]

==BackEnd.java==

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

To check the above scenarios we have created '''AssignmentTests.java''' file.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

To check the above scenarios we have created '''TestResultTests.java''' file.

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

To check the above scenarios we have created '''FrontEndTests.java''' file.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

To check the above scenarios we have created '''SubmissionCollectionTests.java''' file.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Default or Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.

[[File:mvn.jpg|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

To implement the proposed changes we have added '''pom.xml''' file.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

To implement the proposed solution '''maven-build-merge.yml''' and '''maven-build-pr.yml''' files are created.

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

To implement the proposed solution the following files are modified '''Assignment.java , BackEnd.java , FrontEnd.java , FrontEndView.java , MySQL5xDataAccessObject.java , MySQL80DataAccessObject.java , OracleDataAccessObject.java , Submission.java and SubmissionCollection.java''' .

[[File:error.png|800px|thumb|center|                               We have redirected the error stream using the following code.]]

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Github and Related Link==
The forked git repository for this project can be found [https://github.com/Sakshamrzt/SQL-File-Evaluation]. 
The pull request can be found [https://github.com/wagnerpj42/SQL-File-Evaluation/pull/39].

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

File:Mvn.jpg

2022-04-27T15:04:57Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-25T01:26:26Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Parsewriter and Commwriter files exist after the function is called.
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist.

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-12T01:43:47Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Check the submission marks and submissions from the returned value of the result from hashcode method and test if they have the respective correct values.
* Check the behavior of the equals method if it correctly checks the 3 categories of inputs: object, submissionMarks, and submissions.
* Parsewriter and Commwriter files exist after the function is called.
* Create a mini submission and check
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist?

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed from the scope of the project.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-12T01:39:00Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Check the submission marks and submissions from the returned value of the result from hashcode method and test if they have the respective correct values.
* Check the behavior of the equals method if it correctly checks the 3 categories of inputs: object, submissionMarks, and submissions.
* Parsewriter and Commwriter files exist after the function is called.
* Create a mini submission and check
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist?

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

'''Note:''' The requirement "Ensure that all file (of SQL queries) parsing errors are logged in the /evaluations/AAA_parse_problems file (this was broken by a previous contributor)" has been removed.

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-12T01:33:05Z

Sthakur5: /* Task 4 */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Check the submission marks and submissions from the returned value of the result from hashcode method and test if they have the respective correct values.
* Check the behavior of the equals method if it correctly checks the 3 categories of inputs: object, submissionMarks, and submissions.
* Parsewriter and Commwriter files exist after the function is called.
* Create a mini submission and check
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist?

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Currently, the project does not contain any automated build functionality. We plan to create a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-12T01:30:39Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Check the submission marks and submissions from the returned value of the result from hashcode method and test if they have the respective correct values.
* Check the behavior of the equals method if it correctly checks the 3 categories of inputs: object, submissionMarks, and submissions.
* Parsewriter and Commwriter files exist after the function is called.
* Create a mini submission and check
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist?

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Creating a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.
===Manual Testing ===

==== Task 1 ====
* Copy the current output file to a directory outside the project scope.
* Run the project generating the new output file.
* The generated output file should be formatted in the same manner as shown in the image above.

==== Task 3 ====
* Trigger the maven build using: mvn clean install
* Check for the existence of a new jar SQLFE.jar is generated in the project's root directory.

==== Task 4 ====
* Navigate to the project's GitHub page. Go to the Github actions page.
* Enter your email in the prompt.
* Choose a branch and trigger a build using Github actions.
* Check your mailbox for an automated mail containing a jar/.exe file.

==== Task 5 ====
* Launch the project.
* Enter the wrong name for the database.
* Try to run an evaluation.
* The project will generate a new file in the evaluation folder containing the error. Check this file for appropriate messages and accurate format.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-12T01:19:15Z

Sthakur5: /* Task 5 */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Technologies Used ==
The technologies used include Maven, Junit, Java, MySQL ,Oracledb. Java is a high level object oriented programming language that is mainly used for back-end server-side development. Java is used in this project to write the underlying program used to assist professors in grading SQL student submissions. Maven is a build automation tool used for building and managing Java based projects. With Maven, the user can have different build profiles to set up different configurations of the Java project used for testing, development, and deployment configurations. Maven has POM files that are basically XML files that contain information related to the project and configuration like dependencies, source directory, plugin, and goals. Junit is a unit testing framework. Similar to Rspec for Ruby, Junit allows the user to automate unit testing to ensure that the classes work well for a system using Java. Oracledb, like any database, is a collection of structured data. This is different from MySQL, which was previously used to store the data on this particular project. However, both database platforms essentially serve the same purpose. In comparison, Oracledb supports parallel and distributed databases and also better indexing than MySQL. Though, MySQL is said to be more configurable, the commercially used Oracledb is the selected relational database management system for this particular project.

== Tasks ==
The project tasks range over several smaller tasks with a cumulative effort directed towards improving the user experience and setting up better processes. As most of the task here are refactoring output files and moving the project to a different build, we don't have any design pattern refactoring.

===Task 1===
Improve the formatting of the query and feedback output in each individual evaluation output file.

====Current Implementation====
The evaluation files that are generated have a randomly formatted output which is hard to read and is not user-friendly.

[[File:s_2201_1.png|800px|thumb|center|           Unformatted AAA_grade_summary.out file. There is no indentation and unwanted commas are present to the end.]]

====Proposed Output====
For a cleaner experience, we are going to remove the commas at the end of the lines. Also, we are going to change the alignment of the lines such that they all are indented in the correct manner.

[[File:s_2201_2.png|800px|thumb|center|                               File is formatted properly. Additionally, undesired characters have been removed.]]

Similar changes will be done for each student's output file.

===Task 2===
Add the JUnit test case coverage for the general SQLFE package. We are aiming to add unit tests for Assignment, FrontEnd, SubmissionCollection, and TestResult classes.

Once the design feature is further pushed to development, this page will be updated with specific code regarding the JUnit test cases desired for this feature. Until then, the following are outlined below:

=====Assignment.java=====
*Check the regular expression for the question with an unacceptable format like a 1, %1, and $2.
*Check the question without the period(.) in the question name.
*Check whether the name of propertiesFilename is valid or not. If the file is invalid it should throw the appropriate exception.
*Check if the final output i.e. the questions is correct. For this we will check the following two values:
        1. The number of questions is the same. 
        2. The points for each question are the same.

=====TestResult.java=====
* Add a warning and check the expected value in the containsWarning function.
* Set the test score and check its expected value in the getScore function.
* Check the TestResult function with parameters and check the expected value of the parameters (score, warning, extraRows, missingRows)

=====FrontEnd.java=====
* Write Frontend information out to the properties file and check the value with set values(in the test case)
* Check to set the input parameters with a different datatype.
* Appropriate action should be taken if the file does not exist.

=====SubmissionCollection.java=====
* Check the submission marks and submissions from the returned value of the result from hashcode method and test if they have the respective correct values.
* Check the behavior of the equals method if it correctly checks the 3 categories of inputs: object, submissionMarks, and submissions.
* Parsewriter and Commwriter files exist after the function is called.
* Create a mini submission and check
* Check if the number of submissions is the same as expected - totalSubmissions is the same as filecount
* Check whether the submission file name is the same as expected.
* Appropriate action should be taken if the submission folder path does not exist?

===Task 3===
==== Current Implementation ====

Currently, the project does not have any integrated build tool. We need to manually download the jars, build the project and run the jar. Instead, we want to automate the build process using the maven build tool.

==== Proposed Solution ====
We need to migrate the project to maven. We will be adding a pom.xml file correspondingly. We are going to add three kinds of profiles:

* Development - This profile will be used when a developer is developing or making changes to the application.
* Testing - This profile triggers all the unit test cases that have been written and gives a consolidated output for the same.
* Deployment - This profile goes hand in hand with the automated builds on Github Actions. The configuration specified here is used when building the application using the CI build.

[[File:s_2201_5.png|800px|thumb|center|                                 Different profiles in maven.                                                              Maven build life cycle. ]]

Since the project is not used as a dependency anywhere else we don't plan to set up a deployment to the maven central repository.

===Task 4===
Creating a CI/CD pipeline for continuous build functionality which will generate an executable, compile all the JUnit test cases as well as, integrates supported databases.

==== Proposed Solution ====
We are thinking of using GitHub Actions for this, as they make it very easy to implement and automate workflows as per our requirement. Our workflow will do the following:
* Action will trigger whenever we make a commit or a pull request to the main/master branch.
* The action will compile the project using 'maven build' command and store the output jar inside project folder.
* We will use another action to email that jar to all the respective stakeholders (alternate solution could be to make it publicly accessible using GitHub pages).
* In case of a pull request, we will create a testing build so that it doesn't break any functionality and the stable build is accessible to those who want that.

[[File:build.jpeg|800px|thumb|center|                                                                                                          CI/CD pipeline]]

=== Task 5 ===

==== Current Implementation ====
Any errors like use of wrong database credentials etc. are currently shown in the GUI for SQLFE. We plan to remove system errors visible to user via GUI to a file in /evaluations folder and hide them from the user.

==== Proposed Solution ====
We plan to create a new file `AAA_system_error.out` which will contain all the system errors/exceptions noticed by the application and remove all the code which was publishing that data to the GUI.

==Test Plan==
The tasks involve minimal code changes and require adding build/deployment functionality. For the code changes(Copy any system.err output to a file in the /evaluations folder instead of going to the console/GUI window.) we plan to add the following JUnit test:
* Create the wrong DAO object and check if a file with the relevant message is created correspondingly.

The rest of the tasks involve Manual testing where we will be manually triggering the builds etc. to check if the purpose of the task is met.

==Team==
Jackson Hardy(jmhardy3) 
Rachit Sharma(rsharm26) 
Saksham Thakur(sthakur5) 
Shubhender Singh(ssingh54) 
'''Mentor:''' Dr. Paul Wagner

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-07T01:17:34Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-06T18:55:33Z

Sthakur5:

File:S 2201 5.png

2022-04-06T18:53:58Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-06T17:11:29Z

Sthakur5:

File:S 2201 5.jpg

2022-04-06T14:36:29Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-06T03:12:17Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-05T21:26:44Z

Sthakur5:

File:S 2201 4.png

2022-04-05T21:23:16Z

Sthakur5:

File:S 2201 3.png

2022-04-05T20:43:06Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-05T20:28:31Z

Sthakur5: /* Assignment.java */

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-05T20:28:22Z

Sthakur5: /* Assignment.java */

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-05T20:28:07Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-04T17:23:43Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-01T02:49:12Z

Sthakur5:

File:S 2201 2.png

2022-04-01T02:45:01Z

Sthakur5:

File:S 2201 1.png

2022-04-01T02:43:54Z

Sthakur5:

CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE

2022-04-01T02:43:22Z

Sthakur5: Created page with "== About SQLFE== SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, l..."

CSC/ECE 517 Spring 2022

2022-04-01T02:07:51Z

Sthakur5: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Spring 2022 - E2200: Testing advice_controller]]
* [[CSC/ECE 517 Spring 2022 - E2203: Adding tests for courses_controller, eula_controller]]
* [[CSC/ECE 517 Spring 2022 - E2204: Adding tests for markup_styles_controller, lock_controller]]
* [[CSC/ECE 517 Spring 2022 - E2208: Testing for submission_records_controller, profile_controller]]
* [[CSC/ECE 517 Spring 2022 - E2218: Refactor response_controller]]
* [[CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires_controller]]
* [[CSC/ECE 517 Spring 2022 - E2216: Refactor late_policies_controller]]
* [[CSC/ECE 517 Spring 2022 - E2215: Refactor student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2022 - E2214: Refactor teams_controller]]
* [[CSC/ECE 517 Spring 2022 - E2219: Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2211: Testing for summary_helper]]
* [[CSC/ECE 517 Spring 2022 - E2225: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2221: Refactor submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2206: Testing for users_controller]]
* [[CSC/ECE 517 Spring 2022 - E2207: Testing for submitted_content_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2205: Testing for participants_controller, versions_controller]]
* [[CSC/ECE 517 Spring 2022 - E2212: Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)]]
* [[CSC/ECE 517 Spring 2022 - S2222: Refactor impersonate_controller]]
* [[CSC/ECE 517 Spring 2022 - E2202- Testing for badges_controller, publishing_controller]]
*[[CSC/ECE 517 Spring 2022 - E2220: Refactor reputation_web_service_controller]]
* [[CSC/ECE 517 Spring 2022 - E2224: Refactor review_mapping_controller]]
* [[CSC/ECE 517 Spring 2022 - E2209: Testing for analytic helper.rb, join team requests helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2227: SQL Injection Fix]]
* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2201: Testing for assignment_questionnaire_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2243. Refactor student_teams functionality]]

== Final Projects ==
* [[CSC/ECE 517 Spring 2022 - E2245: View for results of bidding]]
* [[CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements]]
* [[CSC/ECE 517 Spring 2022 - E2237: Grading audit trail]]
* [[CSC/ECE 517 Spring 2022 - S2201: Improving User Experience for SQLFE]]

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-22T23:26:27Z

Sthakur5: /* JUnit Testing */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes: 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

== Test Plan ==
We wrote test cases for Backend.java class, particulary for the evaluate method. The tests are discussed below.
=== Setup ===
Here we do initial setup of the unit test and create a test object for backend class.
<pre>
@Before
public void setup() {
Utilities.forTesting = true;
backEnd.createTestObject(testDAO, mainFolderPath);
System.setErr(new PrintStream(errContent));
}
</pre>

=== Output files check ===
This test checks if the number of output lines generated is the same as the number of input files. The additional 2 is because of the header of output file.
<pre>
int numberOfFiles = Objects.requireNonNull(new File(backEndSubmissionPath).list()).length;
long lineCount;
try (Stream<String> stream = Files.lines(Paths.get(gradesFileName), StandardCharsets.UTF_8)) {
lineCount = stream.count();
}
assertEquals(lineCount,numberOfFiles+2);
</pre>

=== Submission output has grade ===
This test asserts that every question has been graded for any given submission. It compares the number of delimiter(,) in a line against the total number of questions.
<pre>
// test for each submission the output should contain grade for each question
Assignment a = backEnd.createAssignment(mainFolderPath + "/assignmentProperties-MySQL");

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: a.getQuestions()){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}

int questions= questionToAnswer.size();
Scanner scanner = new Scanner(new File(gradesFileName));
int lineNo=0;
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
if(lineNo>=2){
String[] arrOfStr = line.split(":");
assertEquals(arrOfStr.length,3);
int freqComma =0;
for(int i=0;i<arrOfStr[2].length();i++){
if(arrOfStr[2].charAt(i)==',')
freqComma++;
}
assertEquals(freqComma,questions);
}
lineNo++;
}
</pre>

=== Invalid paths ===
<pre>
// invalid folder paths
backEnd.setSubmissionFolderPath("invalidPath");
backEnd.setEvaluationFolderPath("invalidPath");
backEnd.evaluate();
assertEquals("Error in reading submission collection\n".trim(), errContent.toString().trim());

errContent.reset();
</pre>

=== Invalid DAO ===
<pre>
// invalid DAO object
IDAO invalidDAO = new MySQL80DataAccessObject("localhost", "3306", "sqlf", "roo", "", true);
backEnd.createTestObject(invalidDAO, mainFolderPath);
backEnd.evaluate();
assertEquals("Invalid database properties\n".trim(), errContent.toString().trim());
</pre>

=== Grade summary output file ===
<pre>
//Test for grade submission, the output file should match are predefined one to pass
backEnd.evaluate();
assertEquals(Files.readAllLines(Paths.get(gradesTestFile)), Files.readAllLines(Paths.get(gradesFileName)));
</pre>

== GitHub Links ==
Link to SQLFE repository: [https://github.com/wagnerpj42/sql-file-evaluation here]

Link to the forked repository: [https://github.com/Sakshamrzt/SQL-File-Evaluation here]

== Project Mentor ==
Prof. Paul Wagner (wagnerpj@uwec.edu)

== Team Members ==
Rachit Sharma(rsharm26@ncsu.edu ) 
Saksham Thakur (sthakur5@ncsu.edu) 
Shubhender Singh (ssingh54@ncsu.edu)

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-22T00:31:23Z

Sthakur5: /* GitHub Links */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes: 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

== JUnit Testing ==
We wrote test cases for Backend.java class, particulary for the evaluate method. The tests are discussed below.
=== Setup ===
Here we do initial setup of the unit test and create a test object for backend class.
<pre>
@Before
public void setup() {
Utilities.forTesting = true;
backEnd.createTestObject(testDAO, mainFolderPath);
System.setErr(new PrintStream(errContent));
}
</pre>

=== Output files check ===
This test checks if the number of output lines generated is the same as the number of input files. The additional 2 is because of the header of output file.
<pre>
int numberOfFiles = Objects.requireNonNull(new File(backEndSubmissionPath).list()).length;
long lineCount;
try (Stream<String> stream = Files.lines(Paths.get(gradesFileName), StandardCharsets.UTF_8)) {
lineCount = stream.count();
}
assertEquals(lineCount,numberOfFiles+2);
</pre>

=== Submission output has grade ===
This test asserts that every question has been graded for any given submission. It compares the number of delimiter(,) in a line against the total number of questions.
<pre>
// test for each submission the output should contain grade for each question
Assignment a = backEnd.createAssignment(mainFolderPath + "/assignmentProperties-MySQL");

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: a.getQuestions()){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}

int questions= questionToAnswer.size();
Scanner scanner = new Scanner(new File(gradesFileName));
int lineNo=0;
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
if(lineNo>=2){
String[] arrOfStr = line.split(":");
assertEquals(arrOfStr.length,3);
int freqComma =0;
for(int i=0;i<arrOfStr[2].length();i++){
if(arrOfStr[2].charAt(i)==',')
freqComma++;
}
assertEquals(freqComma,questions);
}
lineNo++;
}
</pre>

=== Invalid paths ===
<pre>
// invalid folder paths
backEnd.setSubmissionFolderPath("invalidPath");
backEnd.setEvaluationFolderPath("invalidPath");
backEnd.evaluate();
assertEquals("Error in reading submission collection\n".trim(), errContent.toString().trim());

errContent.reset();
</pre>

=== Invalid DAO ===
<pre>
// invalid DAO object
IDAO invalidDAO = new MySQL80DataAccessObject("localhost", "3306", "sqlf", "roo", "", true);
backEnd.createTestObject(invalidDAO, mainFolderPath);
backEnd.evaluate();
assertEquals("Invalid database properties\n".trim(), errContent.toString().trim());
</pre>

=== Grade summary output file ===
<pre>
//Test for grade submission, the output file should match are predefined one to pass
backEnd.evaluate();
assertEquals(Files.readAllLines(Paths.get(gradesTestFile)), Files.readAllLines(Paths.get(gradesFileName)));
</pre>

== GitHub Links ==
Link to SQLFE repository: [https://github.com/wagnerpj42/sql-file-evaluation here]

Link to the forked repository: [https://github.com/Sakshamrzt/SQL-File-Evaluation here]

== Project Mentor ==
Prof. Paul Wagner (wagnerpj@uwec.edu)

== Team Members ==
Rachit Sharma(rsharm26@ncsu.edu ) 
Saksham Thakur (sthakur5@ncsu.edu) 
Shubhender Singh (ssingh54@ncsu.edu)

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-21T20:21:00Z

Sthakur5: /* Team Members */

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes: 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

== JUnit Testing ==
We wrote test cases for Backend.java class, particulary for the evaluate method. The tests are discussed below.
=== Setup ===
<pre>
@Before
public void setup() {
Utilities.forTesting = true;
backEnd.createTestObject(testDAO, mainFolderPath);
System.setErr(new PrintStream(errContent));
}
</pre>

=== Output files check ===
<pre>
int numberOfFiles = Objects.requireNonNull(new File(backEndSubmissionPath).list()).length;
long lineCount;
try (Stream<String> stream = Files.lines(Paths.get(gradesFileName), StandardCharsets.UTF_8)) {
lineCount = stream.count();
}
assertEquals(lineCount,numberOfFiles+2);
</pre>

=== Submission output has grade ===
<pre>
// test for each submission the output should contain grade for each question
Assignment a = backEnd.createAssignment(mainFolderPath + "/assignmentProperties-MySQL");

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: a.getQuestions()){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}

int questions= questionToAnswer.size();
Scanner scanner = new Scanner(new File(gradesFileName));
int lineNo=0;
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
if(lineNo>=2){
String[] arrOfStr = line.split(":");
assertEquals(arrOfStr.length,3);
int freqComma =0;
for(int i=0;i<arrOfStr[2].length();i++){
if(arrOfStr[2].charAt(i)==',')
freqComma++;
}
assertEquals(freqComma,questions);
}
lineNo++;
}
</pre>
=== Invalid paths ===
<pre>
// invalid folder paths
backEnd.setSubmissionFolderPath("invalidPath");
backEnd.setEvaluationFolderPath("invalidPath");
backEnd.evaluate();
assertEquals("Error in reading submission collection\n".trim(), errContent.toString().trim());

errContent.reset();
</pre>

=== Invalid DAO ===
<pre>
// invalid DAO object
IDAO invalidDAO = new MySQL80DataAccessObject("localhost", "3306", "sqlf", "roo", "", true);
backEnd.createTestObject(invalidDAO, mainFolderPath);
backEnd.evaluate();
assertEquals("Invalid database properties\n".trim(), errContent.toString().trim());
</pre>

=== Grade summary output file ===
<pre>
//Test for grade submission, the output file should match are predefined one to pass
backEnd.evaluate();
assertEquals(Files.readAllLines(Paths.get(gradesTestFile)), Files.readAllLines(Paths.get(gradesFileName)));
</pre>

== GitHub Links ==
Link to SQLFE repository: [https://www.uwec.edu/profiles/wagnerpj/ here]

Link to the forked repository: [https://github.com/wagnerpj42/sql-file-evaluation here]

== Project Mentor ==
Prof. Paul Wagner (wagnerpj@uwec.edu)

== Team Members ==
Rachit Sharma(rsharm26@ncsu.edu ) 
Saksham Thakur (sthakur5@ncsu.edu) 
Shubhender Singh (ssingh54@ncsu.edu)

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-21T20:20:33Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes: 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

== JUnit Testing ==
We wrote test cases for Backend.java class, particulary for the evaluate method. The tests are discussed below.
=== Setup ===
<pre>
@Before
public void setup() {
Utilities.forTesting = true;
backEnd.createTestObject(testDAO, mainFolderPath);
System.setErr(new PrintStream(errContent));
}
</pre>

=== Output files check ===
<pre>
int numberOfFiles = Objects.requireNonNull(new File(backEndSubmissionPath).list()).length;
long lineCount;
try (Stream<String> stream = Files.lines(Paths.get(gradesFileName), StandardCharsets.UTF_8)) {
lineCount = stream.count();
}
assertEquals(lineCount,numberOfFiles+2);
</pre>

=== Submission output has grade ===
<pre>
// test for each submission the output should contain grade for each question
Assignment a = backEnd.createAssignment(mainFolderPath + "/assignmentProperties-MySQL");

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: a.getQuestions()){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}

int questions= questionToAnswer.size();
Scanner scanner = new Scanner(new File(gradesFileName));
int lineNo=0;
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
if(lineNo>=2){
String[] arrOfStr = line.split(":");
assertEquals(arrOfStr.length,3);
int freqComma =0;
for(int i=0;i<arrOfStr[2].length();i++){
if(arrOfStr[2].charAt(i)==',')
freqComma++;
}
assertEquals(freqComma,questions);
}
lineNo++;
}
</pre>
=== Invalid paths ===
<pre>
// invalid folder paths
backEnd.setSubmissionFolderPath("invalidPath");
backEnd.setEvaluationFolderPath("invalidPath");
backEnd.evaluate();
assertEquals("Error in reading submission collection\n".trim(), errContent.toString().trim());

errContent.reset();
</pre>

=== Invalid DAO ===
<pre>
// invalid DAO object
IDAO invalidDAO = new MySQL80DataAccessObject("localhost", "3306", "sqlf", "roo", "", true);
backEnd.createTestObject(invalidDAO, mainFolderPath);
backEnd.evaluate();
assertEquals("Invalid database properties\n".trim(), errContent.toString().trim());
</pre>

=== Grade summary output file ===
<pre>
//Test for grade submission, the output file should match are predefined one to pass
backEnd.evaluate();
assertEquals(Files.readAllLines(Paths.get(gradesTestFile)), Files.readAllLines(Paths.get(gradesFileName)));
</pre>

== GitHub Links ==
Link to SQLFE repository: [https://www.uwec.edu/profiles/wagnerpj/ here]

Link to the forked repository: [https://github.com/wagnerpj42/sql-file-evaluation here]

== Project Mentor ==
Prof. Paul Wagner (wagnerpj@uwec.edu)

== Team Members ==
Rachit Sharma(rsharm26@ncsu.edu )
Saksham Thakur (sthakur5@ncsu.edu)
Shubhender Singh (ssingh54@ncsu.edu)

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-21T15:41:54Z

Sthakur5:

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes: 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)

2022-03-21T15:41:23Z

== About SQLFE==

SQL File Evaluation (SQLFE) is an open-source tool that helps in the flexible scoring of multiple SQL queries in multiple submitted files from assignments, lab tests, or other work. It was developed by [https://www.uwec.edu/profiles/wagnerpj/ Prof. Paul Wagner] at [https://www.uwec.edu/ University Of Wisconsin Eau Claire]. This tool has features to support the automated grading of the SQL assignments. It allows partial grading of the question to fairly grade the students and also allows students to provide comments, and multiple solutions to the same problem.

== Description about the project ==
This page is a description of SQLFE OSS project S2200 which is Refactoring evaluation of SQL queries (Java/JUnit) and writing test cases for the changes made. SQLFE is an SQL evaluation and grading solution. The core of the functionality deals with going through all the submissions and getting the output for a student's solution via SQL and comparing the output with the desired one. This involves calling the evaluate function which has high complexity and is almost non-readable. Our project primarily focuses on refactoring the complex evaluate function to reduce the complexity by breaking it up into several functions, each dealing with a specific part of the functionality. The goal of this project is to attempt to make this part of the application easier to read and maintain. We have also optimized the code by removing the redundant calls to the same operation and storing the output.

== Files modified in current project ==
BackEnd.java;
QueryEvaluationLists.java;
AbstractTest.java;
BackEndTest.java

=== BackEnd.java ===
This file receives the SQL connection details and assignment details from the frontend and performs the grading for all the students.

====List Of Changes====
We worked on the following changes(CI): 
=====Change 1=====
The calculation of the questions to the possible answer was happening redundantly which was impacting the performance. We moved this code to a separate function and are now using a map to store the question to answer values.

<pre>
while (qIndex < questions.size() && !foundAll) {
// first match
if (!foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
foundOne = true;
currQuestions.add(questions.get(qIndex)); // use this question
qIndex++;
}
// subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) == 0) {
currQuestions.add(questions.get(qIndex)); // add this question too
qIndex++;
}
// first non-match after subsequent match
else if (foundOne && questions.get(qIndex).getQNumStr().indexOf(qa.getQNumStr()) != 0) {
foundAll = true;
qIndex++;
}
// not a match
else {
qIndex++;
}
} // end - while looking for question(s) to match student answer
</pre>

The above operation was happening redundantly for each student. We have moved this code to a separate function which is called in the preprocessing phase.

<pre>
/** Method to create a map of questions
*
* @param questions Array list containing a list of questions.
* @return Arraylist from Integer(question number) to list of questions.
*/
Map<Integer, ArrayList<Question>> createQuestionToAnswer(ArrayList<Question> questions) {

Map<Integer, ArrayList<Question>> questionToAnswer = new HashMap<>();

// iterate through the list of questions.
for( Question question: questions){
// get the question number
Integer questionNo = Integer.parseInt(String.valueOf(question.getQNumStr().charAt(0)));

//Add the question to the map.
questionToAnswer.putIfAbsent(questionNo, new ArrayList<>());
questionToAnswer.get(questionNo).add(question);
}
return questionToAnswer;
}
</pre>

This function creates a map and we can directly use this map to get currQuestions.
<pre>
currQuestions = questionToAnswer.getOrDefault(questionNo, null);
</pre>

=====Change 2=====
The calculation of the evaluation array lists was happening redundantly for each student. We have separated out this part and have created a separate class. This has improved the readability and we are now avoiding doing redundant operations.

<pre>
ArrayList<ISQLTest> questionTests = new ArrayList<ISQLTest>();
ArrayList<Integer> questionPcts = new ArrayList<Integer>();
ArrayList<String> questionConditions = new ArrayList<String>();

// evaluate all tests for this question
for (int tiqIndex = 0; tiqIndex < questionEvalComps.size(); tiqIndex++) {
// get test names
String currTestName = questionEvalComps.get(tiqIndex).getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest)oTest;
questionTests.add(test);
}
catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComps.get(tiqIndex).getPercent();
questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComps.get(tiqIndex).getCondition();
questionConditions.add(currTestCondition);
} // end - for each test in question
</pre>

We have created a new class for keeping the query evaluation arraylists.

<pre>
/*
* QueryEvaluationLists - class that holds query evaluation params.
*
* Created - 1-Mar-2022
*/
package sqlfe.general;

import sqlfe.sqltests.ISQLTest;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class QueryEvaluationLists {

// List that holds query evaluations params.
final private ArrayList<ISQLTest> questionTests ;
final private ArrayList<Integer> questionPcts ;
final private ArrayList<String> questionConditions ;

// methods
// constructors
// all-args constructor
public QueryEvaluationLists(ArrayList<ISQLTest> questionTests, ArrayList<Integer> questionPcts, ArrayList<String> questionConditions) {
this.questionTests = questionTests;
this.questionPcts = questionPcts;
this.questionConditions = questionConditions;
}

// methods
//default constructor
public QueryEvaluationLists() {
this.questionTests = new ArrayList<>();
this.questionPcts = new ArrayList<>();
this.questionConditions = new ArrayList<>();
}

public ArrayList<ISQLTest> getQuestionTests(){
return this.questionTests;
}

public ArrayList<Integer> getQuestionPcts(){
return this.questionPcts;
}

public ArrayList<String> getQuestionConditions(){
return this.questionConditions;
}

/**
* Create a map for the holding question number to metrics . This functions does preprocessing.
* @param questions. A list that holds objects containing data.
* @return the map holding data
*/
public Map<String,QueryEvaluationLists> createQuestionNoToEvaluationMetricsMap(ArrayList<Question> questions) {

Map<String,QueryEvaluationLists> questionNoToEvaluationMetrics= new HashMap<>();

// iterate through the list of questions.
for (Question question:questions) {
// get the question number
String questionName=question.getQNumStr();
// create object to hold the data.
QueryEvaluationLists queryEvaluationLists= new QueryEvaluationLists();

// Get all the tests corresponding to the question.
ArrayList<EvalComponentInQuestion> questionEvalComps = question.getTests();

for (EvalComponentInQuestion questionEvalComp : questionEvalComps) {
// get test names
String currTestName = questionEvalComp.getEvalComponentName();
currTestName = "sqlfe.sqltests." + currTestName;

// make test object out of test name
try {
Class<?> aClass = Class.forName(currTestName);
Object oTest = aClass.newInstance();
ISQLTest test = (ISQLTest) oTest;
queryEvaluationLists.questionTests.add(test);
} catch (Exception e) {
System.out.println("exception in generating class object from name");
}

// get percents
int currTestPct = questionEvalComp.getPercent();
queryEvaluationLists.questionPcts.add(currTestPct);

// get condition
String currTestCondition = questionEvalComp.getCondition();
queryEvaluationLists.questionConditions.add(currTestCondition);
} // end - for each test in question

questionNoToEvaluationMetrics.put(questionName,queryEvaluationLists);

}
return questionNoToEvaluationMetrics;
}

}

</pre>

After this change, we can simply get the map of the current questions by using the question number.

<pre>
Map<String, QueryEvaluationLists> questionNoToEvaluationMetrics = queryEvaluationLists.createQuestionNoToEvaluationMetricsMap(questions);
queryEvaluationLists = questionNoToEvaluationMetrics.get(currQuestion.getQNumStr());
</pre>

=====Change 3 =====
The evaluate function was performing all the activities involving the grading of students. The tasks involved were: 
1. Initialize the variables like gradesWriter which writes to the UI, load the submission corpus.
2. Go through all the submissions.
3. For each individual submission go through all the questions.
4. Grade each question.
5. Calculate the overall score for the assignment and write to the output file.

As we can see the evaluate method is responsible for multiple functionalities. Owing to this the complexity is high with low readability. We have split the evaluate functions into several smaller functions.

1. evaluate 
2. goThroughAllSubmissions 
3. gradeSubmission

CSC/ECE 517 Spring 2022

2022-03-21T13:54:04Z

Sthakur5: /* OSS Projects */

== OSS Projects ==

* [[CSC/ECE 517 Spring 2022 - E2203: Adding tests for courses_controller, eula_controller]]
* [[CSC/ECE 517 Spring 2022 - E2204: Adding tests for markup_styles_controller, lock_controller]]
* [[CSC/ECE 517 Spring 2022 - E2218: Refactor response_controller]]
* [[CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires_controller]]
* [[CSC/ECE 517 Spring 2022 - E2216: Refactor late_policies_controller]]
* [[CSC/ECE 517 Spring 2022 - E2215: Refactor student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2022 - E2214: Refactor teams_controller]]
* [[CSC/ECE 517 Spring 2022 - E2219: Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2211: Testing for summary_helper]]
* [[CSC/ECE 517 Spring 2022 - E2214: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2022 - E2221: Refactor submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2022 - E2206: Testing for users_controller]]
* [[CSC/ECE 517 Spring 2022 - E2205: Testing for participants_controller, versions_controller]]
* [[CSC/ECE 517 Spring 2022 - E2212: Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2022 - S2200: Refactoring evaluation of SQL queries (Java/JUnit)]]

== Final Projects ==