Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-23T03:22:54Z

Vdeo: /* 🔗 References */

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method: get_responses_for_question_in_a_survey_deployment ===

==== Description ====
This method returns an array of counts representing how many times each score (defined by the `@range_of_scores` variable) was selected in answers to a specific question within a given survey deployment. It does this by:

* Identifying response maps linked to the survey deployment (supports types: Assignment, Course, Global).
* Fetching all responses from those maps.
* Counting how many times each score was recorded for the provided question across all responses.

==== Test Scenarios ====
'''Scenario 1: Counts multiple answers of the same score'''

Validates that if multiple answers with the same score exist for a question, the count is aggregated correctly.

'''Scenario 2: Returns all zeros if no answers exist'''

Ensures the method returns a zero count array if there are no answers associated with the question.

'''Scenario 3: Handles mixed score distribution'''

Tests the function's ability to correctly assign counts to different scores within the same response.

'''Scenario 4: Aggregates across multiple response maps'''

Ensures answers from multiple response maps are all considered in the score aggregation.

'''Scenario 5: Returns zeros for invalid deployment ID'''

Verifies that the method gracefully returns all zeros when given a non-existent survey deployment ID.

'''Scenario 6: Raises error on invalid question ID'''

Ensures that the method throws an `ActiveRecord::RecordNotFound` error if the question ID does not exist.

'''Scenario 7: Handles nil @range_of_scores'''

Tests the behavior when `@range_of_scores` is not defined. It should return an empty array without errors.

'''Scenario 8: Supports custom score range (e.g., 1 to 3)'''

Validates correct operation when a non-default range of scores is provided.

'''Scenario 9: Ignores answers with scores outside the range'''

Ensures that scores not included in `@range_of_scores` are excluded from the count.

'''Scenario 10: Ignores answers with nil scores'''

Confirms that answers with no score (nil) do not affect the result array.

'''Scenario 11: Returns zeros when response maps have no responses'''

Tests behavior when response maps exist but have no associated responses.

'''Scenario 12: Ignores answers from other questions'''

Ensures that only answers corresponding to the specific question ID are counted.

'''Scenario 13: Handles high-volume datasets'''

Simulates performance with 50 responses and ensures results remain accurate.

'''Scenario 14: Works across supported response map types'''

Ensures compatibility with AssignmentSurveyResponseMap, CourseSurveyResponseMap, and GlobalSurveyResponseMap.

=== Method: allowed_question_type? ===

==== Description ====
This method determines whether a given question type is eligible for statistical analysis in the UI. According to the application logic, only questions of type `'Criterion'` and `'Checkbox'` are valid for such calculations.

It returns:
* `true` for questions of type `'Criterion'` or `'Checkbox'`
* `false` for any other type, including unknown, `nil`, or incorrectly formatted inputs

==== Test Scenarios ====

'''Scenario 1: Accepts "Criterion" type'''

Confirms that the method returns `true` when the question type is `'Criterion'`, which is allowed for statistical reporting.

'''Scenario 2: Accepts "Checkbox" type'''

Ensures that `'Checkbox'` is recognized as a valid statistical question type and returns `true`.

'''Scenario 3: Rejects "TextArea" type'''

Validates that unsupported question types such as `'TextArea'` are rejected and return `false`.

'''Scenario 4: Rejects nil as type'''

Checks that if a question has a `nil` type, the method returns `false` without error.

'''Scenario 5: Rejects empty string as type'''

Ensures empty strings (`''`) are not mistakenly treated as valid question types.

'''Scenario 6: Rejects unknown types like "Dropdown"'''

Tests that the method returns `false` for unknown types not explicitly whitelisted (e.g., `'Dropdown'`).

'''Scenario 7: Accepts real Criterion question instance'''

Confirms that the method returns `true` when passed a real ActiveRecord question object of type `'Criterion'`.

'''Scenario 8: Enforces case sensitivity'''

Checks that lowercase valid types (e.g., `'criterion'`) are rejected, ensuring type matching is case-sensitive.

'''Scenario 9: Rejects non-string type like symbol'''

Verifies that a non-string type such as `:Criterion` is rejected, maintaining strict type checking.

=Testing Details=
====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

====How to See Test Coverage====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for both files
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* Design patterns like SRP, OCP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza/pull/2955 Pull Request]
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]
* [https://youtu.be/3ujM1Dzx9Q0 Demo]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T03:32:30Z

Vdeo: /* 📈 Final Outcomes */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T03:31:56Z

Vdeo: /* Test Scenarios */

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method: get_responses_for_question_in_a_survey_deployment ===

==== Description ====
This method returns an array of counts representing how many times each score (defined by the `@range_of_scores` variable) was selected in answers to a specific question within a given survey deployment. It does this by:

* Identifying response maps linked to the survey deployment (supports types: Assignment, Course, Global).
* Fetching all responses from those maps.
* Counting how many times each score was recorded for the provided question across all responses.

==== Test Scenarios ====
'''Scenario 1: Counts multiple answers of the same score'''

Validates that if multiple answers with the same score exist for a question, the count is aggregated correctly.

'''Scenario 2: Returns all zeros if no answers exist'''

Ensures the method returns a zero count array if there are no answers associated with the question.

'''Scenario 3: Handles mixed score distribution'''

Tests the function's ability to correctly assign counts to different scores within the same response.

'''Scenario 4: Aggregates across multiple response maps'''

Ensures answers from multiple response maps are all considered in the score aggregation.

'''Scenario 5: Returns zeros for invalid deployment ID'''

Verifies that the method gracefully returns all zeros when given a non-existent survey deployment ID.

'''Scenario 6: Raises error on invalid question ID'''

Ensures that the method throws an `ActiveRecord::RecordNotFound` error if the question ID does not exist.

'''Scenario 7: Handles nil @range_of_scores'''

Tests the behavior when `@range_of_scores` is not defined. It should return an empty array without errors.

'''Scenario 8: Supports custom score range (e.g., 1 to 3)'''

Validates correct operation when a non-default range of scores is provided.

'''Scenario 9: Ignores answers with scores outside the range'''

Ensures that scores not included in `@range_of_scores` are excluded from the count.

'''Scenario 10: Ignores answers with nil scores'''

Confirms that answers with no score (nil) do not affect the result array.

'''Scenario 11: Returns zeros when response maps have no responses'''

Tests behavior when response maps exist but have no associated responses.

'''Scenario 12: Ignores answers from other questions'''

Ensures that only answers corresponding to the specific question ID are counted.

'''Scenario 13: Handles high-volume datasets'''

Simulates performance with 50 responses and ensures results remain accurate.

'''Scenario 14: Works across supported response map types'''

Ensures compatibility with AssignmentSurveyResponseMap, CourseSurveyResponseMap, and GlobalSurveyResponseMap.

=== Method: allowed_question_type? ===

==== Description ====
This method determines whether a given question type is eligible for statistical analysis in the UI. According to the application logic, only questions of type `'Criterion'` and `'Checkbox'` are valid for such calculations.

It returns:
* `true` for questions of type `'Criterion'` or `'Checkbox'`
* `false` for any other type, including unknown, `nil`, or incorrectly formatted inputs

==== Test Scenarios ====

'''Scenario 1: Accepts "Criterion" type'''

Confirms that the method returns `true` when the question type is `'Criterion'`, which is allowed for statistical reporting.

'''Scenario 2: Accepts "Checkbox" type'''

Ensures that `'Checkbox'` is recognized as a valid statistical question type and returns `true`.

'''Scenario 3: Rejects "TextArea" type'''

Validates that unsupported question types such as `'TextArea'` are rejected and return `false`.

'''Scenario 4: Rejects nil as type'''

Checks that if a question has a `nil` type, the method returns `false` without error.

'''Scenario 5: Rejects empty string as type'''

Ensures empty strings (`''`) are not mistakenly treated as valid question types.

'''Scenario 6: Rejects unknown types like "Dropdown"'''

Tests that the method returns `false` for unknown types not explicitly whitelisted (e.g., `'Dropdown'`).

'''Scenario 7: Accepts real Criterion question instance'''

Confirms that the method returns `true` when passed a real ActiveRecord question object of type `'Criterion'`.

'''Scenario 8: Enforces case sensitivity'''

Checks that lowercase valid types (e.g., `'criterion'`) are rejected, ensuring type matching is case-sensitive.

'''Scenario 9: Rejects non-string type like symbol'''

Verifies that a non-string type such as `:Criterion` is rejected, maintaining strict type checking.

=Testing Details=
====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

====How to See Test Coverage====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for helper module
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* SRP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza/pull/2955 Pull Request]
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T03:31:31Z

Vdeo: /* Test Scenarios */

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method: get_responses_for_question_in_a_survey_deployment ===

==== Description ====
This method returns an array of counts representing how many times each score (defined by the `@range_of_scores` variable) was selected in answers to a specific question within a given survey deployment. It does this by:

* Identifying response maps linked to the survey deployment (supports types: Assignment, Course, Global).
* Fetching all responses from those maps.
* Counting how many times each score was recorded for the provided question across all responses.

==== Test Scenarios ====
'''Scenario 1: Counts multiple answers of the same score'''

Validates that if multiple answers with the same score exist for a question, the count is aggregated correctly.

'''Scenario 2: Returns all zeros if no answers exist'''

Ensures the method returns a zero count array if there are no answers associated with the question.

'''Scenario 3: Handles mixed score distribution'''

Tests the function's ability to correctly assign counts to different scores within the same response.

'''Scenario 4: Aggregates across multiple response maps'''

Ensures answers from multiple response maps are all considered in the score aggregation.

'''Scenario 5: Returns zeros for invalid deployment ID'''

Verifies that the method gracefully returns all zeros when given a non-existent survey deployment ID.

'''Scenario 6: Raises error on invalid question ID'''

Ensures that the method throws an `ActiveRecord::RecordNotFound` error if the question ID does not exist.

'''Scenario 7: Handles nil @range_of_scores'''

Tests the behavior when `@range_of_scores` is not defined. It should return an empty array without errors.

'''Scenario 8: Supports custom score range (e.g., 1 to 3)'''

Validates correct operation when a non-default range of scores is provided.

'''Scenario 9: Ignores answers with scores outside the range'''

Ensures that scores not included in `@range_of_scores` are excluded from the count.

'''Scenario 10: Ignores answers with nil scores'''

Confirms that answers with no score (nil) do not affect the result array.

'''Scenario 11: Returns zeros when response maps have no responses'''

Tests behavior when response maps exist but have no associated responses.

'''Scenario 12: Ignores answers from other questions'''

Ensures that only answers corresponding to the specific question ID are counted.

'''Scenario 13: Handles high-volume datasets'''

Simulates performance with 50 responses and ensures results remain accurate.

'''Scenario 14: Works across supported response map types'''

Ensures compatibility with AssignmentSurveyResponseMap, CourseSurveyResponseMap, and GlobalSurveyResponseMap.

=== Method: allowed_question_type? ===

==== Description ====
This method determines whether a given question type is eligible for statistical analysis in the UI. According to the application logic, only questions of type `'Criterion'` and `'Checkbox'` are valid for such calculations.

It returns:
* `true` for questions of type `'Criterion'` or `'Checkbox'`
* `false` for any other type, including unknown, `nil`, or incorrectly formatted inputs

==== Test Scenarios ====

'''Scenario 1: Accepts "Criterion" type'''

Confirms that the method returns `true` when the question type is `'Criterion'`, which is allowed for statistical reporting.

'''Scenario 2: Accepts "Checkbox" type'''

Ensures that `'Checkbox'` is recognized as a valid statistical question type and returns `true`.

'''Scenario 3: Rejects "TextArea" type'''

Validates that unsupported question types such as `'TextArea'` are rejected and return `false`.

'''Scenario 4: Rejects nil as type'''

Checks that if a question has a `nil` type, the method returns `false` without error.

'''Scenario 5: Rejects empty string as type'''

Ensures empty strings (`''`) are not mistakenly treated as valid question types.

'''Scenario 6: Rejects unknown types like "Dropdown"'''

Tests that the method returns `false` for unknown types not explicitly whitelisted (e.g., `'Dropdown'`).

'''Scenario 7: Accepts real Criterion question instance'''

Confirms that the method returns `true` when passed a real ActiveRecord question object of type `'Criterion'`.

'''Scenario 8: Enforces case sensitivity'''

Checks that lowercase valid types (e.g., `'criterion'`) are rejected, ensuring type matching is case-sensitive.

'''Scenario 9: Rejects non-string type like symbol'''

Verifies that a non-string type such as `:Criterion` is rejected, maintaining strict type checking.

=Testing Details=
====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

====How to See Test Coverage====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for helper module
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* SRP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza/pull/2955 Pull Request]
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:47:22Z

Vdeo: /* 🔗 References */

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method 1: get_responses_for_question_in_a_survey_deployment ===

==== Description ====

Returns a count of how many times each answer option (score) was selected for a given question, across all response maps of types:

#AssignmentSurveyResponseMap
#CourseSurveyResponseMap
#GlobalSurveyResponseMap

==== Test Scenarios ====

* Counts multiple answers of the same score correctly

* Returns all zeros if no answers are given

* Handles responses for mixed score values accurately

* Aggregates across multiple response maps

* Returns zeros for invalid deployment ID

* Raises error on invalid question ID

* Handles nil `@range_of_scores` cleanly

* Supports custom score ranges like (1..3)

* Ignores answers with scores outside the range

* Ignores nil answers

* Returns zeros when response maps exist but have no responses

* Ignores unrelated questions and isolates correct question answers

* Handles high-volume response datasets efficiently (tested with 50 responses)

* Works reliably for all allowed response map types

=== Method 2: allowed_question_type? ===

==== Description ====

Returns true if the question type is either Criterion or Checkbox.

==== Test Scenarios ====

* Accepts `Criterion`
* Accepts `Checkbox`
* Rejects non-statistical types like `TextArea`
* Rejects `nil` type
* Rejects empty string
* Rejects unknown types like `Dropdown`
* Accepts real instance of a valid question
* Case-sensitive check (`criterion` fails)
* Rejects non-string types (e.g., `:Criterion` symbol)

=Testing Details=
====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

====How to See Test Coverage====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for helper module
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* SRP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza/pull/2955 Pull Request]
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:38:40Z

Vdeo: /* Testing Details */

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method 1: get_responses_for_question_in_a_survey_deployment ===

==== Description ====

Returns a count of how many times each answer option (score) was selected for a given question, across all response maps of types:

#AssignmentSurveyResponseMap
#CourseSurveyResponseMap
#GlobalSurveyResponseMap

==== Test Scenarios ====

* Counts multiple answers of the same score correctly

* Returns all zeros if no answers are given

* Handles responses for mixed score values accurately

* Aggregates across multiple response maps

* Returns zeros for invalid deployment ID

* Raises error on invalid question ID

* Handles nil `@range_of_scores` cleanly

* Supports custom score ranges like (1..3)

* Ignores answers with scores outside the range

* Ignores nil answers

* Returns zeros when response maps exist but have no responses

* Ignores unrelated questions and isolates correct question answers

* Handles high-volume response datasets efficiently (tested with 50 responses)

* Works reliably for all allowed response map types

=== Method 2: allowed_question_type? ===

==== Description ====

Returns true if the question type is either Criterion or Checkbox.

==== Test Scenarios ====

* Accepts `Criterion`
* Accepts `Checkbox`
* Rejects non-statistical types like `TextArea`
* Rejects `nil` type
* Rejects empty string
* Rejects unknown types like `Dropdown`
* Accepts real instance of a valid question
* Case-sensitive check (`criterion` fails)
* Rejects non-string types (e.g., `:Criterion` symbol)

=Testing Details=
====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

====How to See Test Coverage====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for helper module
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* SRP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:38:12Z

Vdeo:

= 📘 Project Overview =

== Problem Statement ==
The SurveyDeployment feature in Expertiza is responsible for deploying surveys that collect feedback from students across different scopes: assignments, courses, and globally. Each survey is tied to a questionnaire and operates within a scheduled time window (start and end dates).

When we received the project, there were no existing RSpec tests for the SurveyDeploymentHelper module.

== Project Accomplishments ==
Developed comprehensive RSpec test cases for:
* SurveyDeployment model
* SurveyDeploymentHelper module
** Created a new spec file for the helper module from scratch
** Achieved 100% test coverage
** Structured tests around SOLID principles
** Ensured coverage of edge cases and large dataset performance

== Files Involved ==
{| class="wikitable"
! File Path !! Description
|-
| <code>app/models/survey_deployment.rb</code> || Model for managing survey deployment lifecycle
|-
| <code>app/helpers/survey_deployment_helper.rb</code> || Helper methods for aggregating and filtering survey-related data
|-
| <code>spec/models/survey_deployment_spec.rb</code> || To be expanded for model validations and polymorphic behavior
|-
| <code>spec/helpers/survey_deployment_helper_spec.rb</code> || New file with complete helper test suite
|}

== Mentor ==

* Mitesh Anil Agarwal

== Team Members ==

* Vibhav Deo
* Marmik Patel
* Harsh Vora

= 📂 Class and Method Overview =

== SurveyDeployment Model ==
This model ensures that surveys are deployed with valid time intervals and are associated with a questionnaire. It also acts as a parent class to specific types of surveys like <code>AssignmentSurveyDeployment</code> and <code>CourseSurveyDeployment</code>.

* '''Key Method:''' <code>valid_start_end_time?</code>
** Checks that both <code>start_date</code> and <code>end_date</code> are present
** Ensures <code>end_date</code> is after or equal to <code>start_date</code>
** Requires that <code>end_date</code> is in the future

* '''Polymorphic Methods (to be tested):'''
** <code>response_maps</code>: Returns response maps associated with a specific deployment (delegated to subclasses)
** <code>parent_name</code>: Abstract placeholder for future UI reference

== SurveyDeploymentHelper Module ==
This module contains utility methods that support survey response aggregation and question filtering.

* <code>get_responses_for_question_in_a_survey_deployment(q_id, sd_id)</code>
** Collects responses to a question across multiple survey types (Assignment, Course, Global)

* <code>allowed_question_type?(question)</code>
** Returns true for allowed types (<code>Criterion</code>, <code>Checkbox</code>)
** Used to filter questions eligible for statistical reporting

= 🔍 Testing Summary =

== Model: SurveyDeployment ==
=== Single Responsibility Principle (SRP) ===
Each method in the SurveyDeployment model is responsible for a distinct task.

#The valid_start_end_time? method encapsulates all validation logic for date consistency.
#Abstract methods parent_name and response_maps are defined for implementation in child classes such as AssignmentSurveyDeployment and CourseSurveyDeployment.

=== Open/Closed Principle (OCP) ===
The model is open for extension but closed for modification.

#Abstract methods allow subclasses to define custom behavior without changing the base class logic.
#This promotes maintainability and adherence to polymorphic design.

== Validation Logic ==
=== Method: valid_start_end_time? ===
Validates that:

#Both start_date and end_date are present.
#end_date is after or equal to start_date.
#end_date is in the future.

== Test Scenarios ==
'''Scenario 1: Missing start_date'''

Tests that a SurveyDeployment is invalid if the start_date is not provided. It verifies that the appropriate error message is added to the model.

'''Scenario 2: Missing end_date'''

Ensures the model is invalid when the end_date is missing. Confirms that the validation catches this case and produces a corresponding error.

'''Scenario 3: Both start_date and end_date are nil'''

Checks the custom validation logic in valid_start_end_time? by omitting both start_date and end_date. The test confirms that a specific base-level error message is shown indicating both fields are required.

'''Scenario 4: end_date is before start_date'''

Validates that the model correctly identifies when end_date is earlier than start_date and adds an appropriate error message.

'''Scenario 5: end_date is in the past'''

Confirms that a deployment is invalid if its end_date lies in the past (i.e., before the current time), ensuring the deployment period is always forward-looking.

'''Scenario 6: Valid start_date and end_date'''

Tests a case with a valid start_date and a future end_date that follows it. The model should be valid in this scenario.

'''Scenario 7: start_date and end_date are the same'''

Ensures the model allows deployments where both dates are the same, which is logically acceptable since the duration would be zero.

== Abstract Method Tests ==
'''Scenario 1: Responds to parent_name'''

Verifies that instances of SurveyDeployment respond to the parent_name method without raising an error, even though it is not implemented in the base class.

'''Scenario 2: Responds to response_maps'''

Similar to the above, this confirms that the SurveyDeployment base class defines the response_maps method as abstract and callable.

'''Scenario 3: AssignmentSurveyDeployment returns associated response maps'''

Tests that the AssignmentSurveyDeployment subclass implements the response_maps method properly and returns the expected response maps when queried using the instance’s ID.

== Helper: SurveyDeploymentHelper ==

=== SOLID Principles: ===

* SRP (Single Responsibility Principle):** Each method in the helper module is focused on one clear task.
* DIP (Dependency Inversion Principle):** All logic depends on external inputs via parameters, not internal hardcoded state, making the methods testable and modular.

=== Method 1: get_responses_for_question_in_a_survey_deployment ===

==== Description ====

Returns a count of how many times each answer option (score) was selected for a given question, across all response maps of types:

#AssignmentSurveyResponseMap
#CourseSurveyResponseMap
#GlobalSurveyResponseMap

==== Test Scenarios ====

* Counts multiple answers of the same score correctly

* Returns all zeros if no answers are given

* Handles responses for mixed score values accurately

* Aggregates across multiple response maps

* Returns zeros for invalid deployment ID

* Raises error on invalid question ID

* Handles nil `@range_of_scores` cleanly

* Supports custom score ranges like (1..3)

* Ignores answers with scores outside the range

* Ignores nil answers

* Returns zeros when response maps exist but have no responses

* Ignores unrelated questions and isolates correct question answers

* Handles high-volume response datasets efficiently (tested with 50 responses)

* Works reliably for all allowed response map types

=== Method 2: allowed_question_type? ===

==== Description ====

Returns true if the question type is either Criterion or Checkbox.

==== Test Scenarios ====

* Accepts `Criterion`
* Accepts `Checkbox`
* Rejects non-statistical types like `TextArea`
* Rejects `nil` type
* Rejects empty string
* Rejects unknown types like `Dropdown`
* Accepts real instance of a valid question
* Case-sensitive check (`criterion` fails)
* Rejects non-string types (e.g., `:Criterion` symbol)

=Testing Details=
====Demo Videos====
# [https://drive.google.com/file/d/1UTeJC7oc8pbWZeOuCZt3JcdfW5uDv3Fu/view?usp=drive_link Demo Video for Tag Prompt Deployment Controller]
# [https://drive.google.com/file/d/1dJjeqZxuDon11R12YUp6UVXHD846Ogdz/view?usp=drive_link Demo Video for Answer Tags Controller]

====Using RSpec====

We implemented tests in [https://github.com/VibhavDeo/expertiza/blob/main/spec/models/survey_deployment_spec.rb survey_deployment_spec.rb] and [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb survey_deployment_helper_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/VibhavDeo/expertiza/blob/main/spec/helpers/survey_deployment_helper_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

=Results=
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====survey_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 1.9

[[File:Survey_deployment_coverage_2025.png|500px]]

====survey_deployment_helper_spec.rb====

: Coverage: 100%
: Hits/line: 47.5

[[File:Survey_deployment_helper_coverage_2025.png|800px]]

= 📈 Final Outcomes =
* 100% test coverage for helper module
* Survey logic is now fully tested for correctness, completeness, and edge-case handling
* SRP and DIP ensured for future-proofing
* Tests are modular, clean, and isolated with repeatable results

= 🔗 References =
* [https://github.com/expertiza/expertiza Expertiza GitHub Repository]
* [http://expertiza.ncsu.edu/ Expertiza Wiki Documentation]
* [https://rspec.info/documentation/ RSpec Docs]
* [https://guides.rubyonrails.org/testing.html Rails Testing Guide]

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:34:57Z

Vdeo: /* survey_deployment_helper_spec.rb */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:34:48Z

Vdeo: /* survey_deployment_helper_spec.rb */

File:Survey deployment helper coverage 2025.png

2025-04-22T02:34:33Z

Vdeo:

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:34:15Z

Vdeo: /* survey_deployment_spec.rb */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:34:06Z

Vdeo: /* survey_deployment_spec.rb */

File:Survey deployment coverage 2025.png

2025-04-22T02:33:34Z

Vdeo:

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:32:36Z

Vdeo: /* survey_deployment_spec.rb */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:30:52Z

Vdeo: /* survey_deployment_spec.rb */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:29:02Z

Vdeo: /* survey_deployment_helper_spec.rb */

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:26:29Z

Vdeo:

CSC/ECE 517 Spring 2025 - E2528 Testing for Survey Deployment

2025-04-22T02:20:45Z