Project(Submission(&(Assignment(System( PROJECT(REPORT(

Transcription

1 Project(Submission(&(Assignment(System( PROJECT(REPORT( Team(Jarvice( CSCE$606:SoftwareEngineering,Spring2015 Team(Members:( Deep Desai Jasmeet Singh Prannay Jain Pawan Kumar Singh Samaksh Kapoor Sai Spandana Kancheti

2 ! ( TABLE!OF!CONTENTS! Abstract(...(3 Introduction(...(3 Motivation(...(3 Important Links(...(3 Stakeholders(...(4 User Stories(...(4 Iteration Iteration Iteration Iteration 3:...5 Iteration Lo-Fi Mockup And Original Screenshot(...(6 Project Timelines and Meetings(...(8 TDD/BDD(...(9 Configuration Management(...(10 Tools / Gems Used(...(11 Algorithm Description(...(12 Project Overview(...(12 References(...(14

3 1.!ABSTRACT TheapplicationwasdevelopedtosolvetheproblemsbasedontheprinciplesofSoftwareasaService usingtheagilemethodologyofsoftwaredevelopment.theprojectrequiredustoimplementaservice towardsthecustomer,clientandstudentintegration.themajorobjectiveofthesoftwarewasto provideanonlineplatformforcustomerstosubmittheirprojectproposals,forstudentstoregisterand formteamsamongthemselvesandforadministratortomanageprojects,teams,usersandperform projectassignmentsinanautomatedmanner.thecompleteplatformwasdevelopedusingrubyon Rails,github,heroku,RSpecandothersuchtools.Thecompleteapplicationwassuccessfullydeveloped andupdatedinversions,whichwasfinallydemonstratedtotheprojectcustomertohissatisfaction. 2.!INTRODUCTION Theproblemofassignmentisafundamentalcombinatorialoptimizationprobleminthebranchof optimizationoroperationresearchinmathematics.theprobleminthisscenarioisalsooftheformofa combinatorialoptimization.theprojectallocationforthestudentteamsneedstobedoneinsuchaway thatmostoftheteamsgetstheprojectaccordingtotheirpriority.theexistingsolutionwasamanual evaluationinspreadsheetwherethecourseorganizersspentconsiderableamountoftimeinpreparing thelistofassignedprojectsandtrytocheckifmostoftheteamsaregettingtheirpreferredprojects throughahitandtrialmethod.itwasalaboriousandtimetakingprocess.thesolutiontothisproblem requiresplatformwhichautomatestheprocessofcollectingtheinformationofprojects,studentteams, teams projectpreferencesandperformingtheassignmentofprojectsasperthepreferences. 3.!MOTIVATION Primarymotivationbehindthisprojectwastosolveaverycommonproblemfacedbytheprofessorsin mostoftheuniversitiestocreateteamsfortheclassprojectsandallocatethemtheprojectsaccording totheirpreferences.theideawiththemotivationcamefromprofessordr.duncanwalkerwhofaced similarissuesfor606course.weasateamtookupthechallengetosolvethisproblembycreatingan automatedsystemwhichcouldbeutilizedbyourprofessorandcanbeadaptedworldwide. 4.!IMPORTANT LINKS ProjectWebsite: CustomerFirstInteractionVideo: CustomerFinalReviewVideo: GitHubRepository:

4 5.!STAKEHOLDERS Customer:* 1)Dr.DuncanWalker Professor,DepartmentofComputerScience&Engineering TexasA&MUniversity 2)MeghnathReddyJunnutula TeachingAssistant,DepartmentofComputerScience&Engineering TexasA&MUniversity Developers:* End*Users:* 1)! PawanKumarSingh ProductOwner 2)! JasmeetSingh ScrumMaster 3)! DeepDesai 4)! PrannayJain 5)! SamakshKapoor 6)! SaiSpandanaKancheti CSCE 606Students,StaffandProjectCustomers 6.!USER STORIES Iteration 0: In this iteration, we collected the user stories needed for the basic setup of the Web application.oneoftheuserstorywasofthecustomerhastoaddtheproject.initialdecisionwasof customerloggingintotheapplicationandsubmittingtheprojectbutinlateriterationitwaschangedtoa feature which will be publicly available i.e. without login. The customer can directly add a project, descriptionandcontactdetailswithoutsigningup.nextuserstoryimplementedinthisiterationwasof studentswhichspecifieslogintothewebapplicationsothattheycanviewthelistofapprovedprojects. Thisuserstorywasimplementedinsuchawaythatfirststudentshavetosignupandcreateanaccount usingtamu id.afterthisthestudentscanviewlistofprojectsapprovedbytheadministrator.

5 Iteration 1:Inthisiteration,studentmodulefeaturewereimplemented.Nextuserstoryisalsothe studentscancreateateamwithuniqueteamnamesothattheycanaddpreferencesfortheproject later.nextuserstorywastojoinateamforstudents.everyteamhasauniquenameandarandomcode allottedwhichisusedtomatchtheteammembers. Iteration 2: Createduserstoriesforthenextiterationwhichareshownbelow.Userregistration,Login,Addproject implementation is completed along with all the testing. Create/Join Team methods are created and integrationpartofitwaslefttobedone.inthisuserstory,theadministratorisgiventherighttoaudit theprojectssubmittedbythecustomers,rephrasetherequirementsclearlyandapprovetheprojectsso thatstudentscanviewtheprojects.inthisuserstory,thestudent(teamlead)cangivepreferencetothe project.thepreferencecanbeeitherpositive,negativeorneutral.inthisuserstory,theadministrator hasbeengiventherighttostorethestudentpreferences. Iteration 3: Inthisiteration,wecreatedtheuserstoriesfornextiteration.Create/JoinTeammethodsareintegrated. Studentdashboardisimplementedcompletely.TestsweregoingonforProjectAuditandphishingand Storageofstudentpreferences.Initeration3,teammanagementbyadministrator,teamselectionand formation features are completely implemented. Project assignment feature and team selection and

6 formation are under development. In this user story, there should be an automated mechanism that assignsprojectstothestudentteamsaccordingtotheirpreferences. Iteration 4: Inthisiteration,theteammanagementbyadministrator,managepreassignedprojects andteamselectionandformationareimplementedcompletelytoitsfullfunctionality.bytheendof iteration4,wehadanappthatcompletelyautomatestheprojectallocationtoteam. 7.!LO-FI MOCKUP AND ORIGINAL SCREENSHOT LO$FIMockups OriginalImplementation

7 TheHomeScreenMockuphasbeenclassifiedintotwoscreensnamelyHomePageandLoginPage. TheHomePagegivelinkstoeitherSignUporLogin. TheScreenforCustomerstoenterProjectProposal

8 ProjectModeration:Approve/Unapprove 8.!PROJECT TIMELINES AND MEETINGS Listofcustomermeetingdates,andtheirdescription: Date:9thMarch2015 Description:OnthismeetingIteration0userstorieswerediscussedandanoverallfunctionalityofthe Projectwasdiscussedandhowitwillhelptoresolvetheproblemofassignment. Date:2ndApril2015 Description:Inthismeeting,Iteration1userstorieswerediscussed(associatedwithStudentmodule). AbriefdemowasshowntoDr.WalkeroftheWebApplicationbasicflow.

9 Date:8thApril2015 Description:InthisMeeting,Iteration2userstorieswerediscussed(associatedwithAdministrator module).ademowasshowntodr.walkerofthepastiterationhavingthefunctionalitiesofteam CreationandTeamJoin. Date17 th April2015 Description:Inthismeeting,Iteration3userstorieswerediscussed.(Studentpreferencescriterion) AbriefdemoofProjectapproval,un$approvalandeditingwasshown.ApartfromthatUserProfile settingsandflowofoperationswerediscussed. Date:4thMay2015 Description:InthisMeeting,finalfunctionalityoftheAssignmentAlgorithmwasshownusingaconsole applicationandcriteriaoveritsmodificationwasdiscussed.thismeetingfinalizedthefeaturesforthis projectanddiscussiononoverfutureenhancementswerealsodiscussed. 9.!TDD/BDD TestDrivenDevelopmentorTDDisanadvancedtechniqueofusingautomatedunitteststodrivethe design of software and force decoupling of dependencies [1]. This technique is highly used in Agile developmentmethodologies.themottooftddis Red,Green andrefractor.weused RSpec fortdd. Red:Createatestandmakeitfail Green:Makethetestpassbyanymeansnecessary Refactor:Changethecodetoremoveduplicationinyour projectandtoimprovethedesignwhileensuringthatalltests stillpass BenefitsofTDD [2] : Thesuiteofunittestsprovidesconstantfeedbackthat eachcomponentisstillworking Theunittestsactasdocumentationthatcannotgoout$of$date,unlikeseparatedocumentation, whichcanandfrequentlydoes Whenthetestpassesandtheproductioncodeisrefactoredtoremoveduplication,itisclear thatthecodeisfinished,andthedevelopercanmoveontoanewtest Test$drivendevelopmentforcescriticalanalysisanddesignbecausethedevelopercannotcreate theproductioncodewithouttrulyunderstandingwhatthedesiredresultshouldbeandhowto testit

10 BDD(BehaviorDrivenDevelopment):WhileTDDcanbeconsidereda low$levelapproach,bddismoreofanagile asauser approach [2]. Basically,thetestsarewrittenasstories.BDDinvolvescreating featuresthatcontainscenariosthataremeanttotestbehaviorsthat yourapplicationshouldhave.thisisalldonecompletelyfromthe viewofauser.allthebddtestsaredoneusingcucumber.bdd doesn treplacetdd,butbuildsonit. Benefits/Problems:5 Themainadvantageisexploitedfromthefactthattestsarewrittenbeforecodingthem.Thiswill helpustowritecodeaccordingtotherequirements.whenthetestpasses,itcanbeassuredthat thefunctionalitywillbeaccordingtotherequirements ThemainproblemthatwefacedwhilewritingtheTDD/BDDisunderstandingcucumberwhichwas timeconsumingprocessinthebeginning. 10.!CONFIGURATION MANAGEMENT Revisioncontrol,alsoknownasversioncontrolandsourcecontrolisthemanagementofchangesto documents,computerprograms,largewebsites,andothercollectionsofinformation [3].Insoftware engineering,revisioncontrolisanytypeofpracticethattracksandprovidescontroloverchangesto sourcecode.softwaredeveloperssometimesusesrevisioncontrolsoftwaretomaintaindocumentation andconfigurationfilesaswellassourcecodes.git,whichisadistributedversioncontrolsystem,is arguablythemostpopularversioncontrol/revisioncontrolsystemtoday.itwasdevelopedbylinus Torvalds [4] toaddresstheissueofspeedwithexistingversioncontrolsystems.awiderangeof organizationsworldwideprefergittomanagetheircode,asgitprovidesahugerangeoffeatures.we havethefollowingmajorbranchesforoursoftwareingitrepository: Student$module:Thisbranchingithasallthefeaturesthatisrelatedtostudents.Themajorstudent featuresaresignup,login,createteam,jointeamandgiveprojectpreferences add_project_new:ithasfeaturesthatarerelatedtocustomers.thecustomerscanaddtheproject, viewtheproject.alongwiththisanadditionalfunctionalityofapprove/unapprovedbyadminispresent inthisbranch cucumberkrspec:thisbranchingithasallthetdd/bddteststhatarerunonthecodewrittenforthe project reset_db:ithascodethatcanresetthedatabase master:thisisthemainbranchofourcode.alltheabovebranchesaremergedintothismainbranchby resolvingalltheconflicts Wehavetworeleasesofoursoftware.Thefirstreleasewasdonebeforethefinaldemooftheproject andthefinalreleaseisdoneon5/10/2015withallthefeaturesaddedandtested.therearenomajor issuesintheproductionreleaseprocesstoheroku.fewoftheteammembersusedcloud9whilerestof themusedvirtualbox.nosignificantissueswerenoticedintheseenvironments.

11 11.!TOOLS / GEMS USED Themainlyusedtoolsfortheimplementationareshownbelow: Ruby2.0.0 Rails4.2.0 Heroku GitHub Bootstrap3.2 Rspec3.2.3 Cucumber Inadditiontothesetools,CodeClimateisalsoused.CodeClimateisahostedplatformtocontinuously measureandmonitorcodequality5.itkeepsaneyeonthequalityofthecodeandalsotrackstest coverage.thecodeclimatestatisticshasbeencheckedaftereveryiterationtokeepcontinuoustrackonthe quality.initially,foriteration1thegpawascomparativelylowbecausemultiplebranchedwereaddedto dividethework.soduplicationofcodeinprojectcontrollerisobserved.bytheendofiteration2and3we achievedagpaof4bymergingallthemajorbranches. Afteriteration4,wenoticedthatmostpartoftheprojectwasassignedgreenexceptassignmentcontroller. Thisisbecauseofitshighcomplexityintermsofasymptoticcomplexitysincewejusthavetheleverageof relativelysmallerdatabasei.e.thenumberofgroupsinasingleclasswillalwaysbelessthan100.butthe numberofprojectsinthepoolareveryless(intheorderof100)soourprojectwillruninrelativelyveryless timeinspiteofhavinglargerasymptoticcomplexity.besidesthis,intermsofsecuritytheprojectis successfulinallthetests.sinceallthesetestscanbedonealongwithtrackingthequalityofcodethisisvery usefultool. Thegemsweusedare: rails,bcrypt,faker,will_paginate,bootstrap$will_paginate bootstrap$sass,sass$rails,uglifier coffee$rails,jquery$rails,jbuilder sdoc,jquery$ui$rails. Fordevelopmentenvironmentwespecificallyused: sqlite3,byebug,web$console,spring. Fortestingthefollowinggemsareused: minitest$reporters,mini_backtrace,guard$minitest, cucumber$rails,database_cleaner,rspec$rails,shoulda$matchers. Andfinallyforproductionthreegemswerespecificallyareusedwhichare: pg,rails_12factor,puma.

12 12.!ALGORITHM DESCRIPTION Thecoreoftheproblemrequiredanalgorithmcapableofassigningthestudentteamswithprojects. AftercarefulexaminationMaximumBipartiteMatchingAlgorithmwaschosen. MaximumBipartiteMatchingwillbeutilizedtoassignprojectsbetweentheteamsandtheirprojectpriorities. Thisalgorithmhasbeensuccessfullyusedforassignmentproblemfromalongtimefordifferentassignment problems.intheabovediagramyoucanseethat,thefirstdiagramdepictstherelationshipbetweenthe Studentteamsandtheirpreferences.Thepreferenceareofthreetypes:Positive(Mostpreferred),Neutral (Second Preferred) and Negative (Least Preferred). The matching algorithm will be run for each set of relationshipsuntilalltheteamsareassignedatleastoneproject. Maximummatchingisdonebetweentheteamsandtheirtoppriorityprojects Ifthereareanyteamswheretheprojectsarenotassigned,thenmaximummatchingisdonebetween theleftoutteamsandneutralprojects Intheworstcasescenario,teamsareassignedtheirbottompriorityprojects. 13.!PROJECT OVERVIEW Thebelowdiagramdepictsaflowoftheapplicationthroughdifferentscreens.TheHomePagewillbe utilizedbycustomers,administrator&students.thecustomerneednottologin.theycannavigateto

13 theprojectproposalformandsubmitprojectdetails.theregisteredusers:administratorandstudents havetoauthenticateusingtheirlogincredentials.thestudentshavetosignupforfirsttime,afterwards studentscanloginintothesystemwithouthassle.oncethestudentloginsintothesystem,he/she loginsintothesystem.afterlogin,thestudenthastochoosehisteam.tofacilitatethisfeaturethereare twooptions.thestudentcanjoinanexistingteamorcreateateamofhisown.wheneverastudent createsateamheisprovidedwithauniquecodewhichwillbesharedtotheteammemberswhowill jointhatparticularstudent steam.oncetheteamhasbeenformed,thestudentiseligibletochoosethe preferencesforprojects.oncethepreferenceshasbeenreceived,theadministratorcanperformthe assignments. Next,theAdministratoruserflow.OncetheAdministratorloginsintothesystem,he/shecanmanage users,teamsandprojects.theadministratorwillexaminetheproposedprojectsandwillapprovethe projectifitissuitableforconsideredascourseproject.theadministratorcaneditthedetailsofthe projectsinordertomakeitmoreclearandunderstandableforthestudents.oncethestudentshave submittedtheirpreferencesthentheadministratorcannavigateforassignprojectspage.uponcalling thispage,theassignmentswillbeperformedinthebackgroundandlistwillbegeneratedwhichwill havetheassignmentsofprojectswiththestudentteam.asmentionedinthealgorithmpart,theaimof thealgorithmistokeepmaximumsatisfactionbyassigningmostteamtotheirtoppriorityprojects.

14 14.!REFERENCES 1)! 2)! 3)! 4)! 5)! 6)!