Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-12-16T09:51:37Z

Agarg9: /* Steps to Implement the Automated Deployment Process */

==Introduction to Expertiza==

The Expertiza project is a web application to create reusable learning objects through peer review. It supports various features such as team projects and the submission of various documents including URLs and wiki pages. It is being used extensively across various universities for select courses.

==Project Description==

===Problem Statement===

Currently, setting up the infrastructure for expertiza is done manually. The task is to write a Chef-solo<ref>[https://docs.chef.io/chef_solo.html Chef Solo]</ref> recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby<ref>[https://www.ruby-lang.org/en/ Ruby]</ref> code.

===What needs to be done===

We need to provide a single step setup of expertiza for production.

*It should include setting up the basic environment, application dependency, configuration setup and database setup.
*It should also include recipe for regular deployment.

==Some Terminology==
===Chef Solo<ref>https://docs.chef.io/chef_solo.html</ref>===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one(or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client(which is installed on every node) does the actual configuration.

*'''Node:'''
:A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*'''Recipe: '''
:A recipe specifies the resources to use and the order in which they are to be applied. It is mostly a collection of resources, defined using patterns(resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*'''Cookbook:'''
:A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*'''WorkStation:'''
:A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
:The workstation is the location from which most users do most of their work.
:One(or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*'''Chef Server:'''
:The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*'''Chef-client:'''
:The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===Nginx===

Nginx is a free, open-source, high-performance [HTTP] server and reverse proxy<ref>[https://www.nginx.com/resources/glossary/reverse-proxy-server/]</ref>, as well as an IMAP<ref>https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol</ref>/POP3<ref>https://en.wikipedia.org/wiki/Post_Office_Protocol</ref> proxy server. Nginx is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.<ref>[https://www.nginx.com/resources/wiki/ Nginx Sever]</ref>

===Unicorn===

Unicorn is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. Slow clients should only be served by placing a reverse proxy capable of fully buffering both the the request and response in between unicorn and slow clients.
<ref>[https://github.com/defunkt/unicorn Unicorn Web Server]</ref>

==Plan of Action==
===Steps to Implement the Automated Deployment Process===

[[File:Img01ExpInfra.png | frame|none|Expertiza Virtual Infrastructure]]

1. Setup a virtual Vanilla<ref>[https://en.wikipedia.org/wiki/Vanilla_software Vanilla]</ref> Ubuntu<ref>[http://www.ubuntu.com Ubuntu]</ref> Machine.

2. Update the Ubuntu to the specified version.

3. Clone Expertiza from Github.

4. Install packages for Java, Ruby and all the ruby dependencies.

5. Bundle install, install all gems

6. Install MYSQL<ref>[https://mysql.com Mysql server]</ref>, configure it and migrate databases.

7. Install Unicorn gem. Unicorn is a Rack<ref>[https://en.wikipedia.org/wiki/Rack_%28web_server_interface%29 Rack Server]</ref> HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

8. Make changes in the nginx configuration.

9. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

10. Configure Unicorn and integrate it to work with nginx.

11. Start both Unicorn and Nginx server.

==Expertiza Stack==

[[File:Exp1.png]]

The above visually describes the expertiza stack on the virtual machine. The stack includes nginx as the front end, web server which will redirect the requests to the unicorn server. The scope of the project includes just 1 unicorn server but the recipe will be written in a way that later modifications can be made to add more than 1 unicorn servers under a load balancer. The unicorn server will interact with the database server and write/fetch data into it.

==Chef-Solo Recipe Example==
Chef solo has cookbooks and recipes. An example of recipes is as follows:
package "git-core" #apt-get install git-core

user node[:user][:name] do
password node[:user][:password]
gid "admin"
home "/home/#{node[:user][:name]}"
supports :manage_home => true
end

This recipe orchestrates the installation of git-core and creates a new user and sets its privileges and password along with the home directory. Similarly, the plan of action is to write recipes for downloading, installing and configuring various components(nginx, unicorn, RMV, Ruby, MYSQL etc.) which will contribute towards building the infrastructure of expertiza.

==Expertiza Deployment==

1. We first created a droplet( virtual private server) using digital ocean<ref>https://www.digitalocean.com/</ref>.
[[File:Drop.png]]

2. We recorded the IP address of the newly created droplet and created the associated <ipaddress>.json file.

'''<ipaddress>.json''' : This file holds all the node specific values required to install services and config node.
We will set node_user , user_hash_password , ruby version , mysql root & password . The main function apart from holding node variables is to run recipes in a specific code.

[[File:Ipjson.JPG]]

The following recipes(.rb files), scripts and node specific files were created to achieve automatic deployment. Other pre-installed files and folder for Chef cookbook can be found in the git repository mentioned above.

3. Next,

'''setup_vps.sh''' : This will run the knife tool that will setup Chef-solo on the node and will execute the recipes.
This needs to be from the directory where it present. The bash command in following format has to be used.

<code>sh setup_vps.sh <node_username> <node_ip_address> <node_port> </code>

[[File:Setup vps sh.JPG]]

'''default.rb''' : This updates the Ubuntu machine packages, install the list of prerequisite packages and sets the time zone.
[[File:New default.png]]

'''expertiza_clone''' : This recipes creates a directory and clones the Expertiza git source code in that directory.
[[File:Expertiza clone rb.JPG ]]

'''set_java_home''': This recipe sets the Java configuration. It then bundle installs all the gems used by the Expertiza.
[[File:Set java home rb.JPG]]

'''mysql.rb''' : It installs the MySQL server , MySQL client and its associated dependencies. The root password is preloaded and then fetched on installation by setting DEBIAN_FRONTEND environment variable.

[[File:Mysql rb.JPG]]

'''nginx.rb''' : This recipe installs nginx which is web proxy server that will listen on user defined port and redirect the requests for static content (images, css, javascript) to the public folder of Experiza rails app.

[[File:NGINX rb.JPG ]]

'''unicorn.rb''' : It will install and configure Unicorn web server used in production environment to handle high traffic and achieve load balancing . All the requests for dynamic content will go through it.
[[File:Start server rb.JPG]]

==Github link==
https://github.com/amurark/expertiza

==Points for the reviewer==

While reviewing this project, please consider the following points:

*1. There is no scope for testing in our project. This has been discussed and approved by the mentor.
*2. There is no scope for UML diagrams for this project, as there are no classes/interface involved.

==References==
<references></references>

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-12-16T09:38:02Z

Agarg9: /* Steps to Implement the Automated Deployment Process */

==Introduction to Expertiza==

The Expertiza project is a web application to create reusable learning objects through peer review. It supports various features such as team projects and the submission of various documents including URLs and wiki pages. It is being used extensively across various universities for select courses.

==Project Description==

===Problem Statement===

Currently, setting up the infrastructure for expertiza is done manually. The task is to write a Chef-solo<ref>[https://docs.chef.io/chef_solo.html Chef Solo]</ref> recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby<ref>[https://www.ruby-lang.org/en/ Ruby]</ref> code.

===What needs to be done===

We need to provide a single step setup of expertiza for production.

*It should include setting up the basic environment, application dependency, configuration setup and database setup.
*It should also include recipe for regular deployment.

==Some Terminology==
===Chef Solo<ref>https://docs.chef.io/chef_solo.html</ref>===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one(or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client(which is installed on every node) does the actual configuration.

*'''Node:'''
:A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*'''Recipe: '''
:A recipe specifies the resources to use and the order in which they are to be applied. It is mostly a collection of resources, defined using patterns(resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*'''Cookbook:'''
:A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*'''WorkStation:'''
:A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
:The workstation is the location from which most users do most of their work.
:One(or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*'''Chef Server:'''
:The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*'''Chef-client:'''
:The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===Nginx===

Nginx is a free, open-source, high-performance [HTTP] server and reverse proxy<ref>[https://www.nginx.com/resources/glossary/reverse-proxy-server/]</ref>, as well as an IMAP<ref>https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol</ref>/POP3<ref>https://en.wikipedia.org/wiki/Post_Office_Protocol</ref> proxy server. Nginx is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.<ref>[https://www.nginx.com/resources/wiki/ Nginx Sever]</ref>

===Unicorn===

Unicorn is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. Slow clients should only be served by placing a reverse proxy capable of fully buffering both the the request and response in between unicorn and slow clients.
<ref>[https://github.com/defunkt/unicorn Unicorn Web Server]</ref>

==Plan of Action==
===Steps to Implement the Automated Deployment Process===

[[File:Img01ExpInfra.png | frame|none|Expertiza Virtual Infrastructure]]

1. Setup a virtual Vanilla<ref>[https://en.wikipedia.org/wiki/Vanilla_software Vanilla]</ref> Ubuntu<ref>[http://www.ubuntu.com Ubuntu]</ref> Machine.

2. Update the ubuntu to the specified version.

3. Install packages for Ruby and all the ruby dependencies.

4. Install MYSQL<ref>[https://mysql.com Mysql server]</ref> and configure it.

5. Install Unicorn gem. Unicorn is a Rack<ref>[https://en.wikipedia.org/wiki/Rack_%28web_server_interface%29 Rack Server]</ref> HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

6. Bundle install, install gems and migrate databases.

7. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

8. Make changes in the nginx configuration.

9. Configure Unicorn and integrate it to work with nginx.

==Expertiza Stack==

[[File:Exp1.png]]

The above visually describes the expertiza stack on the virtual machine. The stack includes nginx as the front end, web server which will redirect the requests to the unicorn server. The scope of the project includes just 1 unicorn server but the recipe will be written in a way that later modifications can be made to add more than 1 unicorn servers under a load balancer. The unicorn server will interact with the database server and write/fetch data into it.

==Chef-Solo Recipe Example==
Chef solo has cookbooks and recipes. An example of recipes is as follows:
package "git-core" #apt-get install git-core

user node[:user][:name] do
password node[:user][:password]
gid "admin"
home "/home/#{node[:user][:name]}"
supports :manage_home => true
end

This recipe orchestrates the installation of git-core and creates a new user and sets its privileges and password along with the home directory. Similarly, the plan of action is to write recipes for downloading, installing and configuring various components(nginx, unicorn, RMV, Ruby, MYSQL etc.) which will contribute towards building the infrastructure of expertiza.

==Expertiza Deployment==

1. We first created a droplet( virtual private server) using digital ocean<ref>https://www.digitalocean.com/</ref>.
[[File:Drop.png]]

2. We recorded the IP address of the newly created droplet and created the associated <ipaddress>.json file.

'''<ipaddress>.json''' : This file holds all the node specific values required to install services and config node.
We will set node_user , user_hash_password , ruby version , mysql root & password . The main function apart from holding node variables is to run recipes in a specific code.

[[File:Ipjson.JPG]]

The following recipes(.rb files), scripts and node specific files were created to achieve automatic deployment. Other pre-installed files and folder for Chef cookbook can be found in the git repository mentioned above.

3. Next,

'''setup_vps.sh''' : This will run the knife tool that will setup Chef-solo on the node and will execute the recipes.
This needs to be from the directory where it present. The bash command in following format has to be used.

<code>sh setup_vps.sh <node_username> <node_ip_address> <node_port> </code>

[[File:Setup vps sh.JPG]]

'''default.rb''' : This updates the Ubuntu machine packages, install the list of prerequisite packages and sets the time zone.
[[File:Default rb.JPG]]

'''expertiza_clone''' : This recipes creates a directory and clones the Expertiza git source code in that directory.
[[File:Expertiza clone rb.JPG ]]

'''set_java_home''': This recipe sets the Java configuration. It then bundle installs all the gems used by the Expertiza.
[[File:Set java home rb.JPG]]

'''mysql.rb''' : It installs the MySQL server , MySQL client and its associated dependencies. The root password is preloaded and then fetched on installation by setting DEBIAN_FRONTEND environment variable.

[[File:Mysql rb.JPG]]

'''nginx.rb''' : This recipe installs nginx which is web proxy server that will listen on user defined port and redirect the requests for static content (images, css, javascript) to the public folder of Experiza rails app.

[[File:NGINX rb.JPG ]]

'''unicorn.rb''' : It will install and configure Unicorn web server used in production environment to handle high traffic and achieve load balancing . All the requests for dynamic content will go through it.
[[File:Start server rb.JPG]]

==Github link==
https://github.com/amurark/expertiza

==Points for the reviewer==

While reviewing this project, please consider the following points:

*1. There is no scope for testing in our project. This has been discussed and approved by the mentor.
*2. There is no scope for UML diagrams for this project, as there are no classes/interface involved.

==References==
<references></references>

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-12-16T09:18:54Z

Agarg9: /* Steps to Implement the Automated Deployment Process */

==Introduction to Expertiza==

The Expertiza project is a web application to create reusable learning objects through peer review. It supports various features such as team projects and the submission of various documents including URLs and wiki pages. It is being used extensively across various universities for select courses.

==Project Description==

===Problem Statement===

Currently, setting up the infrastructure for expertiza is done manually. The task is to write a Chef-solo<ref>[https://docs.chef.io/chef_solo.html Chef Solo]</ref> recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby<ref>[https://www.ruby-lang.org/en/ Ruby]</ref> code.

===What needs to be done===

We need to provide a single step setup of expertiza for production.

*It should include setting up the basic environment, application dependency, configuration setup and database setup.
*It should also include recipe for regular deployment.

==Some Terminology==
===Chef Solo<ref>https://docs.chef.io/chef_solo.html</ref>===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one(or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client(which is installed on every node) does the actual configuration.

*'''Node:'''
:A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*'''Recipe: '''
:A recipe specifies the resources to use and the order in which they are to be applied. It is mostly a collection of resources, defined using patterns(resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*'''Cookbook:'''
:A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*'''WorkStation:'''
:A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
:The workstation is the location from which most users do most of their work.
:One(or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*'''Chef Server:'''
:The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*'''Chef-client:'''
:The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===Nginx===

Nginx is a free, open-source, high-performance [HTTP] server and reverse proxy<ref>[https://www.nginx.com/resources/glossary/reverse-proxy-server/]</ref>, as well as an IMAP<ref>https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol</ref>/POP3<ref>https://en.wikipedia.org/wiki/Post_Office_Protocol</ref> proxy server. Nginx is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.<ref>[https://www.nginx.com/resources/wiki/ Nginx Sever]</ref>

===Unicorn===

Unicorn is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. Slow clients should only be served by placing a reverse proxy capable of fully buffering both the the request and response in between unicorn and slow clients.
<ref>[https://github.com/defunkt/unicorn Unicorn Web Server]</ref>

==Plan of Action==
===Steps to Implement the Automated Deployment Process===

[[File:Img01ExpInfra.png | frame|none|Expertiza Virtual Infrastructure]]

1. Setup a virtual Vanilla<ref>[https://en.wikipedia.org/wiki/Vanilla_software Vanilla]</ref> Ubuntu<ref>[http://www.ubuntu.com Ubuntu]</ref> Machine.

2. Update the ubuntu to the specified version.

3. Install packages for Ruby and all the ruby dependencies.

4. Install MYSQL<ref>[https://mysql.com Mysql server]</ref> and configure it.

5. Install Unicorn gem. Unicorn is a Rack<ref>[https://en.wikipedia.org/wiki/Rack_%28web_server_interface%29 Rack Server]</ref> HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

6. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

7. Make changes in the nginx configuration.

8. Configure Unicorn and integrate it to work with nginx.

9. Bundle install, install gems and migrate databases.

==Expertiza Stack==

[[File:Exp1.png]]

The above visually describes the expertiza stack on the virtual machine. The stack includes nginx as the front end, web server which will redirect the requests to the unicorn server. The scope of the project includes just 1 unicorn server but the recipe will be written in a way that later modifications can be made to add more than 1 unicorn servers under a load balancer. The unicorn server will interact with the database server and write/fetch data into it.

==Chef-Solo Recipe Example==
Chef solo has cookbooks and recipes. An example of recipes is as follows:
package "git-core" #apt-get install git-core

user node[:user][:name] do
password node[:user][:password]
gid "admin"
home "/home/#{node[:user][:name]}"
supports :manage_home => true
end

This recipe orchestrates the installation of git-core and creates a new user and sets its privileges and password along with the home directory. Similarly, the plan of action is to write recipes for downloading, installing and configuring various components(nginx, unicorn, RMV, Ruby, MYSQL etc.) which will contribute towards building the infrastructure of expertiza.

==Expertiza Deployment==

1. We first created a droplet( virtual private server) using digital ocean<ref>https://www.digitalocean.com/</ref>.
[[File:Drop.png]]

2. We recorded the IP address of the newly created droplet and created the associated <ipaddress>.json file.

'''<ipaddress>.json''' : This file holds all the node specific values required to install services and config node.
We will set node_user , user_hash_password , ruby version , mysql root & password . The main function apart from holding node variables is to run recipes in a specific code.

[[File:Ipjson.JPG]]

The following recipes(.rb files), scripts and node specific files were created to achieve automatic deployment. Other pre-installed files and folder for Chef cookbook can be found in the git repository mentioned above.

3. Next,

'''setup_vps.sh''' : This will run the knife tool that will setup Chef-solo on the node and will execute the recipes.
This needs to be from the directory where it present. The bash command in following format has to be used.

<code>sh setup_vps.sh <node_username> <node_ip_address> <node_port> </code>

[[File:Setup vps sh.JPG]]

'''default.rb''' : This updates the Ubuntu machine packages, install the list of prerequisite packages and sets the time zone.
[[File:Default rb.JPG]]

'''expertiza_clone''' : This recipes creates a directory and clones the Expertiza git source code in that directory.
[[File:Expertiza clone rb.JPG ]]

'''set_java_home''': This recipe sets the Java configuration. It then bundle installs all the gems used by the Expertiza.
[[File:Set java home rb.JPG]]

'''mysql.rb''' : It installs the MySQL server , MySQL client and its associated dependencies. The root password is preloaded and then fetched on installation by setting DEBIAN_FRONTEND environment variable.

[[File:Mysql rb.JPG]]

'''nginx.rb''' : This recipe installs nginx which is web proxy server that will listen on user defined port and redirect the requests for static content (images, css, javascript) to the public folder of Experiza rails app.

[[File:NGINX rb.JPG ]]

'''unicorn.rb''' : It will install and configure Unicorn web server used in production environment to handle high traffic and achieve load balancing . All the requests for dynamic content will go through it.
[[File:Start server rb.JPG]]

==Github link==
https://github.com/amurark/expertiza

==Points for the reviewer==

While reviewing this project, please consider the following points:

*1. There is no scope for testing in our project. This has been discussed and approved by the mentor.
*2. There is no scope for UML diagrams for this project, as there are no classes/interface involved.

==References==
<references></references>

File:Drop.png

2015-12-16T08:36:33Z

Agarg9:

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:20:58Z

Agarg9: /* Classes involved */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questionnaires_controller.rb
*questionnaires_quiz_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.
*Controller was very big than what the name describes. Appropriate functionality has been moved to different controller to make this controller slim.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There was a valid_quiz in this controller which is moved to questionnaires_quiz_controller now, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:19:30Z

Agarg9: /* Future Consideration */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.
*Controller was very big than what the name describes. Appropriate functionality has been moved to different controller to make this controller slim.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There was a valid_quiz in this controller which is moved to questionnaires_quiz_controller now, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:17:14Z

Agarg9: /* Changes made */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.
*Controller was very big than what the name describes. Appropriate functionality has been moved to different controller to make this controller slim.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:16:05Z

Agarg9: /* Future Consideration */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:12:35Z

Agarg9: /* Changes made */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Controller was very big than what the name describes. Appropriate functionality needs to be moved to different controllers to make them slim.
*The Quiz methods are to be treated as any different kind of questionnaire, and the functionality be implemented in the model class of quiz_questionnaire.
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-17T02:11:48Z

Agarg9: /* Changes made */

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|-
| 9 || view_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 10 || new_quiz || Moved this method to Questionnaires_quiz_controller || Questionnaire method should not contain quiz related methods, thus moved it out to a new controller
|-
| 11 || update_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 12 || edit_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 13 || create_quiz_questionnaire || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller
|-
| 14 || valid_quiz || Moved this method to Questionnaires_quiz_controller and updated routes.rb and views accordingly || Quiz related methods was needed to move out of this Questionnaire controller

|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Controller was very big than what the name describes. Appropriate functionality needs to be moved to different controllers to make them slim.
*The Quiz methods are to be treated as any different kind of questionnaire, and the functionality be implemented in the model class of quiz_questionnaire.
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-16T20:19:30Z

Agarg9:

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Controller was very big than what the name describes. Appropriate functionality needs to be moved to different controllers to make them slim.
*The Quiz methods are to be treated as any different kind of questionnaire, and the functionality be implemented in the model class of quiz_questionnaire.
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been written for this functionality under spec/models with testcase name questionnaire_spec.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

File:Qc07globalrules.JPG

2015-11-16T20:13:30Z

Agarg9:

File:Qc06valid.JPG

2015-11-16T20:13:15Z

Agarg9:

File:Qc05choose.JPG

2015-11-16T20:12:55Z

Agarg9:

File:Qc04savechoice.JPG

2015-11-16T20:12:44Z

Agarg9:

File:Qc03node.JPG

2015-11-16T20:12:29Z

Agarg9:

File:Qc02copy.JPG

2015-11-16T20:12:08Z

Agarg9:

File:Qc01assign.JPG

2015-11-16T20:11:33Z

Agarg9:

CSC/ECE 517 Fall 2015/oss E1563 ASA

2015-11-16T18:11:25Z

Agarg9: Created page with "=Introduction= Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and ..."

=Introduction=
Questionnaire Controller is responsible for creating, editing and reviewing quizes. The Questionnaire controller is also used for peer-review, teammate-review and creating and managing quizes. The basic functionality of adding, removing, editing questions and or options is handled by this controller. This wikipedia page explains the Open Source Project of refactoring the questionnaire controller on expertiza. 

The need of refactoring
# Maintainability. It is easier to fix bugs because the source code is easy to read and the intent of its author is easy to grasp.<ref name=martin>{{cite book | last = Martin | first = Robert |title = Clean Code | publisher = Prentice Hall | year = 2009}}</ref> This might be achieved by reducing large monolithic routines into a set of individually concise, well-named, single-purpose methods. It might be achieved by moving a method to a more appropriate class, or by removing misleading comments.
# Extensibility. It is easier to extend the capabilities of the application if it uses recognizable [[design patterns]], and it provides some flexibility where none before may have existed.<ref name=kerievsky/>

=Project Overview=
The scope of our project is to refactor the questionnaires controller. The questionnaires controller at this moment is very big and hence, difficult to understand. The aim of the project was to distribute the functionality in different controllers, so that the questionnaires controller will be slim and easy to understand.

==Classes involved==
*questionnaire.rb
*quiz_questionnaire.rb
*questions_controller.rb

==Changes made==

*copy, update_quiz, valid_quiz methods were long and have been broken up. clone_questionnaire_details was also broken up and renamed.
*Changed code to follow the global rules.
*A lot of code duplication has been removed.
*Test cases are written using rspec for the functions in questionnaire_controller.rb.
*Copy method was broken(error page was shown), fixed it partially.

{| class="wikitable"
|-
! S.No. !! Place changes implemented!! Change Made !! Reason
|-
| 1 || Complete controller || Replaced 'and' with '&&' and 'or' with 'II' in all places || Refactored as per global rule 1 to keep Boolean precedence
|-
| 2 || Complete controller || Replaced if (var == true) with if var || Refactored as per global rule 4 as default check for 'if' is for true
|-
| 3 || Complete controller || Replaced :key => ‘value’ with key: ‘value’ for 88 instance in controller|| Refactored as per global rules
|-
| 4 || assign_instructor_id || Removed duplicate code for assigning instructor id from copy and clone_questionnaire_details methods || Removed duplication suggested by code climate.
|-
| 5 || check_create_new_node|| Removed duplicate code for checking creation of new node from copy_questionnaire,save and clone_questionnaire_details methods|| Removed duplication suggested by code climate.
|-
| 6 || update_quiz|| Refactored this method and extracted choose_question_type out of this method || Refactoring was needed for this huge method
|-
| 7 || valid_quiz || Refactored this method and extracted valid_quiz_option out of this method to check validity of options|| Refactoring was needed as method was performing 2 actions
|-
| 8 || save_choices || Refactored this method and created 3 new methods namely save_truefalse_choice,save_single_choice and save_multiple_choice|| Refactoring was needed for this huge method
|}

==Project Resources==
[https://github.com/agarg9/expertiza GitHub Project Repository]

[http://152.1.13.70:3000/ VCL IP Address]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki]

=Code Snippets=
1. This code was duplicated in Copy and clone_questionnaire_details method. So new method with name assign_instructor_id is created and that duplication is removed.
[[Image:Qc01assign.JPG]]

2. Copy method was very big,so created new method copy_questionnaire method out of it, which helps while debugging.
[[Image:Qc02copy.JPG]]

3. This code was also duplicated in save,copy and clone_questionnaire_details method. New method with name check_create_new_node is created to remove this duplication.
[[Image:Qc03node.JPG]]

4. Save_choices method was very big too,thus created new methods namely,save_truefalse_choice,save_single_choice and save_multiple_choice for different choice types.
[[Image:Qc04savechoice.JPG]]

5. Update quiz method was also huge, so created save_question_type out of it and called it in quiz_method.
[[Image:Qc05choose.JPG]]

6. Valid quiz method was checking quiz validity and options validity too. So extracted valid_quiz_options to check validity of quiz options.
[[Image:Qc06valid.JPG]]

7. Refactored whole controller as per global rules.

[[Image:Qc07globalrules.JPG]]

==Future Consideration==
*Controller was very big than what the name describes. Appropriate functionality needs to be moved to different controllers to make them slim.
*The Quiz methods are to be treated as any different kind of questionnaire, and the functionality be implemented in the model class of quiz_questionnaire.
*Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
*There is a valid_quiz in this controller, but it only check if the quiz is valid when new quiz is created, but not when the existing quiz is updated. The reason is that, the format for params is not the same. Please fix this issue and make the valid _quiz work both for quiz creation and quiz_update.
*Write tests for quiz creation, for both scenario which the input quiz questions are valid and not valid.
*Test (and fix if they are broken) the export and import functionality. Write test for importing and exporting questionnaires (Issue 577).

=Object Oriented Design Principles Followed=

The following object oriented design principles were followed during refactoring: 
*Single Responsibility Principle: The single responsibility principle states that every context (class, function, variable, etc.) should have a single responsibility. It was maintained that each method should be involved with a single responsibility and the code that was not related to that particular functionality was moved to other method. This was also taken care of in terms of classes.
*DRY Principle: Don't Repeat Yourself! The repetitive and redundant code was removed from the associated classes and methods.

=Running Project & Testing Functionality=
*Test Cases have been implemented for the functionality in quiz_controller.rb
*This testing has been done using RSpec, a behavior-driven development framework.
'''
Test from UI'''
*Navigate to [http://152.1.13.70:3000/] login with username: instructor6 and password: password.
*Go to Manage>Questionnaire.
*Click on Questionnaire link and create a new public item in review section.
*Expand Review portion and click on edit action for questionnaire create above.
*Here you can add different questions and its weight.
*Go back to questionnaire list and try copy,edit,delete Questionnaire.

=Conclusion=
*Refactoring was performed as per the requirements in the files questionnaire_controller.rb
*Code duplication has been removed efficiently by extracting them into separate methods.
*Test cases were written to some of the functionality in questionnaire_controller.rb.

=References=
[http://expertiza.ncsu.edu/ Expertiza] 
[http://en.wikipedia.org/wiki/Code_refactoring Code Refactoring Wiki] 
[https://docs.google.com/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules for Refactoring] 
[http://www.agiledeveloper.com/presentations/how_to_approach_refactoring_2up.pdf Why Refactor] 
[http://en.wikipedia.org/wiki/Single_responsibility_principle Single Responsibility Principle]

CSC/ECE 517 Fall 2015

2015-11-16T18:09:53Z

Agarg9:

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE 517 Fall 2015/oss/M1502/AAAASS]]
*[[CSC/ECE 517 Fall 2015/oss/M1503/IntegrateXMLParser]]
*[[CSC/ECE_517_Fall_2015/ossE1568BZHXJS]]
*[[CSC/ECE_517_Fall_2015/ossE1572VGA]]
*[[CSC/ECE_517_Fall_2015/oss_E1573_sap]]
*[[CSC/ECE 517 Fall 2015/oss E1559 rrz]]
*[[CSC/ECE 517 Fall 2015/oss E1570 avr]]
*[[CSC/ECE 517 Fall 2015/oss E1556 CHM]]
*[[CSC/ECE 517 Fall 2015/oss M1504 JJD]]
*[[CSC/ECE 517 Fall 2015/oss E1562 APS]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss E1550 KMM]]
*[[CSC/ECE 517 Fall 2015/oss E1551 RGS]]
*[[CSC/ECE 517 Fall 2015/oss E1555 GMR]]
*[[CSC/ECE 517 Fall 2015/oss E1552 NFR]]
*[[CSC/ECE 517 Fall 2015/oss E1565 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1561 WZL]]
*[[CSC/ECE 517 Fall 2015/oss E1553 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1554 AAR]]
*[[CSC/ECE 517 Fall 2015/oss E1569 JNR]]
*[[CSC/ECE 517 Fall 2015/oss E1560 PSV]]
*[[CSC/ECE 517 Fall 2015/oss M1505 MSV]]
*[[CSC/ECE 517 Fall 2015/oss E1557 GXM]]
*[[CSC/ECE 517 Fall 2015/oss E1566 ARB]]
*[[CSC/ECE 517 Fall 2015/oss E1567 APT]]
*[[CSC/ECE 517 Fall 2015/oss E1574 BKS]]
*[[CSC/ECE 517 Fall 2015/ossA1550RAN]]
*[[CSC/ECE 517 Fall 2015/oss E1571]]
*[[CSC/ECE 517 Fall 2015/oss E1563 ASA]]

==Final Project Design Document==
*[[CSC/ECE 517 Fall 2015 E1577 MayYellowRoverJump]]
*[[CSC/ECE 517 Fall 2015 E1586 AnonymousChatBetweenAuthorAndReviewer]]
*[[CSC/ECE 517 Fall 2015 E1580 Text metrics]]
*[[CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec]]
*[[CSC/ECE 517 Fall 2015 E1576 Refactoring submitted content (hyperlinks and files)]]
*[[CSC/ECE 517 Fall 2015 E1590 Integration testing for Team creation]]
*[[CSC/ECE 517 Fall 2015 E1585 Use Ajax for Add Participants, Add TA ,Edit Questionnaires Screens]]
*[[CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface]]
*[[CSC/ECE 517 Fall 2015 E1583 Fix the CSS used for Menu Item]]
*[[CSC/ECE 517 Fall 2015 E1591 Integration testing for peer review]]
*[[CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment]]
*[[CSC/ECE 517 Fall 2015 M1502 Improve HTTP monitoring devtool support]]
*[[CSC/ECE 517 Fall 2015 M1503 Integrate xml5ever XML parser]]
*[[CSC/ECE 517 Fall 2015 M1504 Implement support for missing XMLHttpRequest APIs]]
*[[CSC/ECE 517 Fall 2015 M1505 Add conformance tests to unicode-bidi and fix conformance bugs]]
*[[CSC/ECE 517 Fall 2015 M1501 Report CSS errors to the devtools, both stored and live]]
*[[CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web]]
*[[CSC/ECE 517 Fall 2015 A1550 Web Socket Implementation in Apache Ambari]]
*[[CSC/ECE 517 Fall 2015 E1584 Send Feedback to Support]]

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T02:17:20Z

Agarg9: /* Automating production setup and deployment */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

[[File:Img01ExpInfra.png]]

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===

NGINX is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. NGINX is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

===unicorn===
==Steps to Implement the Automated Deployment Process==

1. Setup a virtual Vanilla Ubuntu Machine.

2. Update the ubuntu to the specified version.

3. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

4. Make changes in the nginx configuration.

5. Install Ruby, RVM and all the ruby dependencies.

6. Install MYSQL and configure it.

7. Install Unicorn gem. Unicorn is a Rack HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

8. Configure Unicorn and integrate it to work with nginx.

9. Bundle install, install gems and migrate databases.

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T02:15:53Z

Agarg9: /* Steps to Implement the Automated Deployment Process */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===

NGINX is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. NGINX is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

===unicorn===
==Steps to Implement the Automated Deployment Process==

1. Setup a virtual Vanilla Ubuntu Machine.

2. Update the ubuntu to the specified version.

3. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

4. Make changes in the nginx configuration.

5. Install Ruby, RVM and all the ruby dependencies.

6. Install MYSQL and configure it.

7. Install Unicorn gem. Unicorn is a Rack HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

8. Configure Unicorn and integrate it to work with nginx.

9. Bundle install, install gems and migrate databases.

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T02:15:02Z

Agarg9: /* Steps */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===

NGINX is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. NGINX is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

===unicorn===
==Steps to Implement the Automated Deployment Process==
[[File:Img01ExpInfra.png]]

1. Setup a virtual Vanilla Ubuntu Machine.

2. Update the ubuntu to the specified version.

3. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

4. Make changes in the nginx configuration.

5. Install Ruby, RVM and all the ruby dependencies.

6. Install MYSQL and configure it.

7. Install Unicorn gem. Unicorn is a Rack HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

8. Configure Unicorn and integrate it to work with nginx.

9. Bundle install, install gems and migrate databases.

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T02:13:42Z

Agarg9: /* Steps */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===

NGINX is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. NGINX is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

===unicorn===
===Steps===
[[File:Img01ExpInfra.png]]

Steps to Implement the Automated Deployment Process

1. Setup a virtual Vanilla Ubuntu Machine.

2. Update the ubuntu to the specified version.

3. Install nginx. Nginx is a web server. It is being used in the Expertiza architecture as a reverse proxy server. Through nginx, we will also attempt to serve static pages directly.

4. Make changes in the nginx configuration.

5. Install Ruby, RVM and all the ruby dependencies.

6. Install MYSQL and configure it.

7. Install Unicorn gem. Unicorn is a Rack HTTP server that uses forked processes to handle multiple incoming requests concurrently. For expertiza, unicorn is being used as the web server, which will interact with the database servers to fetch the data.

8. Configure Unicorn and integrate it to work with nginx.

9. Bundle install, install gems and migrate databases.

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T01:58:54Z

Agarg9: /* nginx */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===

NGINX is a free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server. NGINX is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

===unicorn===
===Steps===
[[File:Img01ExpInfra.png]]

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T01:53:46Z

Agarg9: /* Steps */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===
===unicorn===
===Steps===
[[File:Img01ExpInfra.png]]

File:Img01ExpInfra.png

2015-11-09T01:52:52Z

Agarg9:

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-09T00:03:32Z

Agarg9: /* Chef Solo */

==Project Description==

===Automating production setup and deployment===

Currently, setting up the infrastructure for expertiza is done manually.
The task is to write a Chef-solo recipe which will create a production ready environment for expertiza. Chef-solo recipes are Ruby code.
*It should include setting up the basic environment, application dependency, configuration setup, database setup. Many open sourced recipes for many individual components are available
*It should also include recipe for regular deployment.
This will provide one step setup of expertiza for production.

==Terminology==
===Chef Solo===
Chef is a systems and cloud infrastructure automation framework that makes it easy to deploy servers and applications to any physical, virtual, or cloud location, no matter the size of the infrastructure. Each organization is comprised of one (or more) workstations, a single server, and every node that will be configured and maintained by the chef-client. Cookbooks (and recipes) are used to tell the chef-client how each node in your organization should be configured. The chef-client (which is installed on every node) does the actual configuration.

*Node:
A node is any machine—physical, virtual, cloud, network device, etc.—that is under management by Chef.

*Recipe:
A recipe specifies the resources to use and the order in which they are to be applied.
It is mostly a collection of resources, defined using patterns (resource names, attribute-value pairs, and actions). A recipe must define everything that is required to configure part of a system.

*Cookbook:
A cookbook is the fundamental unit of configuration and policy distribution. A cookbook defines a scenario and contains everything that is required to support that scenario.

*WorkStation:
A workstation is a computer that is configured to run various Chef command-line tools that synchronize with a chef-repo, author cookbooks, interact with the Chef server, interact with nodes, or applications like Chef Delivery.
The workstation is the location from which most users do most of their work.
One (or more) workstations are configured to allow users to author, test, and maintain cookbooks. Cookbooks are uploaded to the Chef server from the workstation.

*Chef Server:
The Chef server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef server by users from workstations.

*Chef-client:
The chef-client uses Ruby as its reference language for creating cookbooks and defining recipes, with an extended DSL for specific resources

===nginx===
===unicorn===
===Steps===

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-08T23:59:52Z

Agarg9: /* Terminology */

CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment

2015-11-08T23:56:36Z

Agarg9: /* Project Description */