https://docs.moodle.org/dev/api.php?action=feedcontributions&feedformat=atom&user=Mayank+gupta2005 2026-08-05T18:35:03Z User contributions MediaWiki 1.43.5 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=42246 2013-09-01T19:42:35Z

<p>Mayank gupta2005: updating project state</p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Coding Period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> <br /> This project will add option in SCORM settings to deliver SCORM package through new HTML5 player. If time permits, code will be added to detect HTML5 support in browser and auto switch to the HTML5 player.<br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> <br /> Thus the benefits of the projects are two fold - <br /> <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> <br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> <br /> == Implementation Details==<br /> <br /> The current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview, JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> <br /> '''June 1 - June 9 :''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14:''' Add option in SCORM administration for switching over to HTML5 player and/or detect support for HTML5 in mobile device and switch automatically.<br /> <br /> '''August 15 - 30:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> <br /> '''[Firm Pencils Down]'''<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40775 2013-06-07T16:09:57Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> <br /> This project will add option in SCORM settings to deliver SCORM package through new HTML5 player. If time permits, code will be added to detect HTML5 support in browser and auto switch to the HTML5 player.<br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> <br /> Thus the benefits of the projects are two fold - <br /> <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> <br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> <br /> == Implementation Details==<br /> <br /> The current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview, JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> <br /> '''June 1 - June 9 :''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14:''' Add option in SCORM administration for switching over to HTML5 player and/or detect support for HTML5 in mobile device and switch automatically.<br /> <br /> '''August 15 - 30:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> <br /> '''[Firm Pencils Down]'''<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40774 2013-06-07T16:07:33Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> <br /> This project will add option in SCORM settings to deliver SCORM package through new HTML5 player. If time permits, code will be added to detect HTML5 support in browser and auto switch to the HTML5 player.<br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> <br /> Thus the benefits of the projects are two fold - <br /> <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> <br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview, JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> <br /> '''June 1 - June 9 :''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14:''' Add option in SCORM administration for switching over to HTML5 player and/or detect support for HTML5 in mobile device and switch automatically.<br /> <br /> '''August 15 - 30:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> <br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40773 2013-06-07T15:59:58Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> Thus as a result, the new '''HTML5 player''' addition to SCORM module would extend and give an optional/or auto switch to HTML5 player for those administrators who prefer deliver SCORM content with it; or for Mobile devices and tablets.<br /> <br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> <br /> Thus the benefits of the projects are two fold - <br /> <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> <br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview,JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> <br /> '''June 1 - June 9 :''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14:''' Add option in SCORM administration for switching over to HTML5 player and/or detect mobile device and switch automatically.<br /> <br /> '''August 15 - 30:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40761 2013-06-07T08:33:05Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> Thus as a result, the new '''HTML5 player''' addition to SCORM module would extend and give an optional/or auto switch to HTML5 player for those administrators who prefer deliver SCORM content with it; or for Mobile devices and tablets.<br /> <br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> <br /> Thus the benefits of the projects are two fold - <br /> <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> <br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview,JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> '''[Community Bonding Period]'''<br /> '''May 28:''' Post in the community forums of Moodle about the new SCORM HTML5 player that is to be developed, giving details about the features, TOC and navigation controls and asking for feedback from the community on the same.<br /> <br /> '''May 29 - May 31:''' Create the Wiki page for the project on Moodle Docs.<br /> <br /> '''June 1 - June 9 ~ 2 weeks:''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16 ~ 1 week:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19 ~ 0.5 week:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27 ~ 1 week:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27 ~ 2 weeks:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5 ~ 1 week:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14 ~ 1 week:''' Add option in SCORM administration for switching over to HTML5 player and/or detect mobile device and switch automatically.<br /> <br /> '''August 15 - 30 ~ 2 weeks:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6 ~ 1 week:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14 ~ 1 week:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23 ~ 1 week:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40760 2013-06-07T08:31:44Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses '''''Yahoo! User Interface Librar'''y 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> Thus as a result, the new '''HTML5 player''' addition to SCORM module would extend and give an optional/or auto switch to HTML5 player for those administrators who prefer deliver SCORM content with it; or for Mobile devices and tablets.<br /> <br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> Thus the benefits of the projects are two fold - <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> 2. To add a new HTML5 SCORM player to SCORM module.<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview,JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> '''[Community Bonding Period]'''<br /> '''May 28:''' Post in the community forums of Moodle about the new SCORM HTML5 player that is to be developed, giving details about the features, TOC and navigation controls and asking for feedback from the community on the same.<br /> <br /> '''May 29 - May 31:''' Create the Wiki page for the project on Moodle Docs.<br /> <br /> '''June 1 - June 9 ~ 2 weeks:''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16 ~ 1 week:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19 ~ 0.5 week:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27 ~ 1 week:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27 ~ 2 weeks:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5 ~ 1 week:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14 ~ 1 week:''' Add option in SCORM administration for switching over to HTML5 player and/or detect mobile device and switch automatically.<br /> <br /> '''August 15 - 30 ~ 2 weeks:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6 ~ 1 week:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14 ~ 1 week:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23 ~ 1 week:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40759 2013-06-07T08:30:14Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> <br /> The project aims at rewriting the current implementation of the SCORM player which uses ''Yahoo! User Interface Library 2''. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> Thus as a result, the new '''HTML5 player''' addition to SCORM module would extend and give an optional/or auto switch to HTML5 player for those administrators who prefer deliver SCORM content with it; or for Mobile devices and tablets.<br /> <br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> Thus the benefits of the projects are two fold - <br /> • Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> • To add a new HTML5 SCORM player to SCORM module.<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview,JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> '''[Community Bonding Period]'''<br /> '''May 28:''' Post in the community forums of Moodle about the new SCORM HTML5 player that is to be developed, giving details about the features, TOC and navigation controls and asking for feedback from the community on the same.<br /> <br /> '''May 29 - May 31:''' Create the Wiki page for the project on Moodle Docs.<br /> <br /> '''June 1 - June 9 ~ 2 weeks:''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16 ~ 1 week:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]'''<br /> <br /> '''June 17 - June 19 ~ 0.5 week:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27 ~ 1 week:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27 ~ 2 weeks:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5 ~ 1 week:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14 ~ 1 week:''' Add option in SCORM administration for switching over to HTML5 player and/or detect mobile device and switch automatically.<br /> <br /> '''August 15 - 30 ~ 2 weeks:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6 ~ 1 week:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14 ~ 1 week:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23 ~ 1 week:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_player_rewrite&diff=40757 2013-06-07T08:16:14Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Work_in_progress}}<br /> {{Infobox Project<br /> |name = SCORM player rewrite<br /> |state = Community bonding period<br /> |tracker = MDL-39910<br /> |discussion = XXX<br /> |assignee = [https://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> }}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '13&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> == Introduction ==<br /> Introduction<br /> The project aims at rewriting the current implementation of the SCORM player which uses Yahoo! User Interface Library 2. This will be achieved by updating the YUI2 code of the SCORM player to YUI3. Additionally, this project will also develop a new HTML5 player to deliver SCORM contents. This would inherently help in delivering SCORM content not only on the Desktop/Laptop browser but also on Mobile devices like iPhone, Android devices and tablets like iPad, etc.<br /> Thus as a result, the new HTML5 player addition to SCORM module would extend and give an optional/or auto switch to HTML5 player for those administrators who prefer deliver SCORM content with it; or for Mobile devices and tablets.<br /> <br /> This would also help in providing SCORM support in the HTML5 Moodle Mobile application.<br /> Thus the benefits of the projects are two fold - <br /> 1. Improve the current SCORM player by updating the YUI2 to code to YUI3.<br /> 2. To add a new HTML5 SCORM player to SCORM module<br /> <br /> As already mentioned, the current SCORM player in Moodle makes use of YUI2. Yahoo has released a new version 3 of the Yahoo! User Interface Library. <br /> YUI2 use Connection Manager to make in-page HTTP requests through a simplified interface to the XMLHttpRequest object. This has been replaced by IO Utility in YUI3. The IO family of modules provide a simple API for requesting resources over HTTP and HTTPS.<br /> The current SCORM player also uses the following from the YUI2 library - yui2-resize, yui2-dragdrop, yui2-container, yui2-button, yui2-layout, yui2-treeview, yui2-json, yui2-event.<br /> <br /> Of the above yui2-treeview is used to render the Table of Contents (TOC) of the SCORM content package. The TOC allows the users to navigate within the SCORM content. SCORM 2004 lays down standards for Sequencing Navigation that enables the content developers to control how a student can navigate within the SCORM content. The treeview implementation of YUI library thus also helps to enable/disable the particular nodes /leaves of the tree - the TOC.<br /> The rendering of the SCORM content and TOC object is computed using scorm/player.php. This file generates the HTML unordered list that is parsed by the YUI2 treeview code in scorm/module.js to generate the TOC.<br /> The project will involve rewriting this YUI2 code in module.js to YUI3 using the YUI3 treeview or better known as gallery-yui3 treeview as the major part. <br /> <br /> Along with other parts of the YUI2 codes that need to be re-written are the navigation buttons that are enabled/disabled in accordance with the TOC of the SCORM content. After the YUI2 code has been written, some valuable amount of time in the project needs to be used in detect and fix any regression issues that would have creeped in during the rewrite. These regressions issues would be detected using the SCORM test harness. Also, this should also fix some of the SCORM 2004 Sequencing and Navigation bugs, which are currently not possible to fix because of the current YUI2 code.<br /> The second part of the project involves adding a new HTML5 player for SCORM module. This HTML5 player can be used to deliver SCORM content by users who prefer to use the HTML5 player or where the current players renders to be non-working at times - Mobile devices and tablets.<br /> This would be basically implemented as an optional player that would either be turned-on by the administrator or when Moodle is being accessed on a Mobile device or tablet.<br /> This would help increase the usability playability of SCORM content in Moodle on such devices. Thus, this would be a boon for the users who have complained about Moodle SCORM player unable to render SCORM content on a mobile device or tablet correctly.<br /> <br /> 1. In file mod/scorm/datamodels/aicc.js.php, there is code to make in-page HTTP requests using Connection manager. This has to be replaced by IO utility of YUI 3.<br /> <br /> 2. In mod/scorm/datamodels/module.js, various components of YUI 2 – Resize, Drag and drop, Container, Button, Layout, Treeview,JSON, Event will be replaced by their corresponding code in YUI 3. Container will be replaced by Overlay of YUI 3.<br /> <br /> 3. Similar to aicc.js.php, scorm_13.js.php also makes requests using Connection manager of YUI 2 which will be replaced by IO utility.<br /> <br /> == Schedule ==<br /> '''[Community Bonding Period]'''<br /> '''May 28:''' Post in the community forums of Moodle about the new SCORM HTML5 player that is to be developed, giving details about the features, TOC and navigation controls and asking for feedback from the community on the same.<br /> <br /> '''May 29 - May 31:''' Create the Wiki page for the project on Moodle Docs.<br /> <br /> '''June 1 - June 9 ~ 2 weeks:''' Get more familiar with YUI3 library in particular YUI3 treeview, YUI3 drag drop, YUI3 button, YUI3 layout, YUI3 event and YUI3 JSON<br /> <br /> '''June 10 - June 16 ~ 1 week:''' Discuss with mentor in detail the implementation of the HTML5 player for SCORM content, essentially, the feature list (based on community feedback), implementation<br /> <br /> '''[Coding Period]<br /> <br /> June 17 - June 19 ~ 0.5 week:''' Create mockups for the new HTML5 player(UI). Post on Moodle community forums and ask for feedback.<br /> <br /> '''June 20 - June 27 ~ 1 week:''' Make the required changes in scorm/player.php to facilitate the rewrite of YUI2 to YUI3.?June 21 - July 7 ~ 2 weeks: Rewrite the code for YUI2 treeview to YUI3 treeview and essentially change other components of YUI2 to YUI3<br /> <br /> '''July 16 - July 27 ~ 2 weeks:''' Check for regression issues and fix issues if any.<br /> <br /> '''''[Midterm Evaluation]'''''<br /> This will be the midterm evaluation target - Complete rewrite of SCORM player of YUI2 to YUI3, report regression issues if any.<br /> <br /> '''July 29 - August 5 ~ 1 week:''' Fix regression issues and facilitate improvement for SCORM 2004 sequencing.<br /> <br /> '''August 7 - Aug 14 ~ 1 week:''' Add option in SCORM administration for switching over to HTML5 player and/or detect mobile device and switch automatically.<br /> <br /> '''August 15 - 30 ~ 2 weeks:''' Write code for the new HTML5 player in scorm/player.php which gets executed on the options set by the Administrator, also write/re-use code that would update SCORM progress as in current SCORM player.<br /> <br /> '''August 31 - Sept 6 ~ 1 week:''' Implement navigation controls, TOC and other features for the HTML5 scorm player.<br /> <br /> '''Sept 7 - 14 ~ 1 week:''' Thoroughly test the HTML5 player for SCORM 1.2 content playback and also if possible for SCORM 2004 using SCORM Test Harness.<br /> <br /> '''Sept 15 - Sept 16:''' Write documentation for the new HTML5 player for SCORM.<br /> <br /> '''Sept 17 - Sept 23 ~ 1 week:''' This is the buffer period, it will be used to resolve any unexpected issues, add/edit documentation, scrub code. Code ready for submitting.<br /> <br /> Would be a nice task: If time permits the project can be extended to solve some Sequencing Navigation bugs for SCORM 2004 using the new YUI3 implementation.<br /> '''[Firm Pencils Down]'''<br /> == Design ==<br /> <br /> == See also ==<br /> * [[GSOC/2013|Moodle GSoC projects for 2013]]<br /> * [[GSOC|Moodle GSoC Overview page]]<br /> <br /> [[Category:GSOC]]<br /> [[Category:Project]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=Improve_SCORM_2004_Support&diff=33809 2012-05-14T12:26:39Z

<p>Mayank gupta2005: Removing extra line break</p> <hr /> <div>{{Infobox Project<br /> |name = Improve SCORM 2004 Support<br /> |state = Community Bonding<br /> |tracker = MDL-7068<br /> |discussion = <br /> |assignee = Mayank Gupta<br /> }}<br /> {{Moodle 2.3}}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '12&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for Improving SCORM 2004 Support in Moodle, a Google Summer Of Code ''(GSoC)'' 2012 project.<br /> The ''goal'' of this project is to work towards achieving full SCORM 2004 4th Edition compliance in Moodle without the need of any external plugins, that is, improving the support for SCORM 2004 content packages in Moodle.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/view.php?id=381842 Michael de Raadt].<br /> <br /> ==Context==<br /> The project will improve the SCORM 2004 support in Moodle by using the [https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]. The automated test framework will help by automating the execution of SCORM 2004 tests in Moodle and thus, will help in identify the issues with SCORM 2004 support in Moodle.<br /> This project will also indirectly help in improving the SCORM Test Harness itself, as by getting the Test Harness into action bugs would be identified and fixed in the Test Harness.<br /> <br /> In order for Moodle to be SCORM 2004 4th Edition compliant and pass all the 189 ADL SCORM 2004 conformance test packages, it needs to adhere to the specifications laid down by [http://www.adlnet.gov/wp-content/uploads/2011/07/SCORM_2004_4ED_v1_1_Doc_Suite.zip ADL SCORM 2004 ''4th Edition'']. <br /> The specification can be divided into three sub-specifications as - <br /> * Content Aggregation Model '''(CAM)'''<br /> * The Run-Time Environment '''(RTE)'''<br /> * Sequencing and Navigation specification '''(SN)'''<br /> <br /> ===Content Aggregation Model===<br /> The Content Aggregation Model sub-specification of SCORM 2004 4th Edition specifies how SCORM 2004 content developers should package their content so that the packages can be imported into the LMS. According to SCORM 2004 specification the content developers should package the content in a self-contained directory or a ZIP file which is also called a '''Package Interchange File (PIF)'''. <br /> <br /> SCORM 2004 specifies that the packaged ZIP file should always contain an XML file with the name - ''' 'imsmanifest.xml' '''. This imsmanifest.xml file also called the manifest file should be located in the root of the ZIP file. The content developers have to make sure that this manifest file contains all the information the LMS would need to successfully deliver the SCORM 2004 content to the content viewers.<br /> <br /> The manifest file divides the course into one or more parts called SCOs, which in other words represents the activity tree for the course content. The manifest file contains an XML representation of the activity tree of the package, information about how to launch each SCO, and optional metadata that would describe the course and its part.<br /> As a LMS it is the responsibility of Moodle's &quot;SCORM module's code&quot; to correctly parse the manifest file, store all the required information of the package in the database. <br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scormlib.php''' has the code that parses the manifest file. <br /> Currently this file is not able to parse all the CAM definitions according to SCORM 2004 4th Edition Specifications. <br /> For instance, the current code of '''scormlib.php''' is not able to parse correctly the '''ADLCP:DATA''', and '''ADLCP:MAP''' sections of the manifest file. These sections define the '''Inter-SCO Storage Data Model Extension'''; that was introduced in ADL SCORM 2004 4th Edition specification. <br /> Other sections of the manifest file that scormlib.php fails to parse successfully will be identified and resolved during the course of the project by running the SCORM Test Harness for individual SCORM 2004 conformance packages.<br /> <br /> ===Run-Time Environment===<br /> The Run-Time Environment (RTE) sub-specification of SCORM 2004 specification specifies how the LMS should launch the content package within itself. The RTE states that the SCORM 2004 content package should be launched within Moodle in a web browser as a new window or within a '''frameset''' in the same window. The RTE specification specifies that all the content in the SCORM 2004 package should be web deliverable and is always launched in a web browser. It also specifies that the LMS should launch one SCO at a time.<br /> <br /> In order to allow communication between the SCORM 2004 content package more specifically the launched SCO of the content package and the LMS; the LMS should provide an '''ECMAScript''' (JavaScript) API through which the SCO can communicate with it. All communication between the SCO and the LMS can take place through this JavaScript API only, that is, the content package can by no means communicate with the LMS through form posts, database access (read/write), web services or any other mechanism.<br /> As a SCO can communicate only through the JavaScript API, the LMS provides the JavaScript object of the API at a specific location within the browsers' DOM. This API object has the special name of ''' 'API_1484_11' ''' for SCORM 2004.<br /> It is the responsibility of the content/SCO to locate this API object and then use it for all the communications it needs to do with the LMS. RTE specifies that only the SCO can initiate the communication as the LMS acts as a passive entity which is simply responding to the API calls made by the SCO. <br /> <br /> The API provides a set of eight functions that permit the exchange of data with the LMS. These functions are -<br /> <br /> {| class=&quot;nicetable&quot; border=&quot;1&quot; cellpadding=&quot;5&quot; cellspacing=&quot;0&quot; align=&quot;center&quot;<br /> |-<br /> ! Function<br /> ! Return Type<br /> ! Remarks<br /> |-<br /> | Initialize( “” )<br /> | bool<br /> | it indicates to the LMS that the content would like to begin a communication session.<br /> |-<br /> | Terminate( “” )<br /> | bool<br /> | it indicates to the LMS that the content has finished communicating<br /> |-<br /> | GetValue( element : CMIElement )<br /> | string<br /> | it allows the SCO/content to data from the LMS<br /> |-<br /> | SetValue( element : CMIElement, value : string)<br /> | string<br /> | it allows the SCO/content to persist data to the LMS.<br /> |-<br /> | Commit( “” )<br /> | bool<br /> | it is used by the SCO/content to signal the LMS that a significant chuck of data has been saved and that the LMS should ensure the data is properly persisted<br /> |-<br /> | GetLastError()<br /> | CMIErrorCode<br /> | it allows to determing if the last SCORM API call caused an error<br /> |-<br /> | GetErrorString( errorCode : CMIErrorCode )<br /> | string<br /> | it return a textual description of what the passed error code means<br /> |-<br /> | GetDiagnostic( errocCode : CMIErrorCode )<br /> | string<br /> | it returns detailed information about the prior error that can be useful in detecting the problem.<br /> |}<br /> <br /> The Computer Managed Instruction or '''CMI''' data model provides a list of data elements which can be read and written using the API. Each data model element has its own meaning.<br /> <br /> Every SCO in a content package has its own set of run-time data. These data model elements have different values for different SCOs within a content package.<br /> Before SCORM 2004 4th edition the RTE data model definitions came into existence these data model elements could not be shared across SCOs of the same or different content package.<br /> When the content user or learner starts a new attempt on a SCO, the data model element's values are reset to the default values at the start of the new attempt. These data models have different default values and can be of either '''read-only''' or both read and '''write''' type.<br /> <br /> Some examples SCORM 2004 RTE data model elements include the '''cmi.completion_status''' element - that saves the status of the SCO (completed or incomplete), '''cmi.success_status''' (passed or failed), the score of the learner, a bookmark to track the learner’s location, and the total amount of time the learner spent in the SCO.<br /> <br /> However, apart from the non-sharable data model elements defined before, the SCORM 2004 4th Edition RTE Data Model definitions define the <br /> '''adl.data''' data model elements that provide the unique ability to share sets of data across the SCOs.<br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scorm_13.js.php''' has the code to deal with the data model elements that a SCO would require.<br /> This code needs to be extended to support the data models defined by the SCORM 2004 4th Edition Run-Time Envirnoment Data Model definition. These data model elements mainly include adl.data elements - Inter-SCO Storage Data Model Extension.<br /> Some progress has already been made on the tracker issue MDL-28805 - ADL TEST: Data Model Implementation (DMI).<br /> While trying to fix the mentioned bug, a number of related issues that needed to be resolved before the bug MDL-28805 could be closed were identified. These bugs were - MDL-30666, MDL-30576, MDL-30577, MDL-30578, MDL-30579, MDL-30645.<br /> As mentioned above, during the course of the project the data model code would be extended to support SCORM 2004 4th Edition Run-Time Environment Data Model definitions and other '' 'buggy areas' '' would be identified by running the SCORM Test Harness for SCORM 2004 Conformance packages issues would be reported and patches will be provided.<br /> <br /> ===Sequencing And Navigation===<br /> <br /> The Sequencing and Navigation sub-specification of SCORM 2004 4th Edition specification allows content developers to '''override''' the default navigation of SCOs and enable them to govern how the content user/learner is allowed to navigate between various SCOs in the content package and also how the progress data is '''rolled up''' to the course level of the content package.<br /> <br /> The content developers lay down the sequencing rules in the imsmanifest.xml file or the manifest file, in the root directory of the PIF. These rules in-turn determine which '''navigational controls''' should the LMS provide to the content user/learner, that is, whether or not a navigable table of contents '''(TOC)''' should be provided to the learner or just the previous/next buttons should be provided to the learner to navigate from one SCO to another in a linear sequence of SCOs.<br /> By specifying sequencing and navigation rules in the manifest file the content developer can also specify that certain conditions like some SCOs/activities must be completed before the learner can navigate to the some other SCO/activity. <br /> The content developer by adhering to the SCORM 2004 Sequence and Navigation specification can also apply a gradient weight to some parts or activities of the content package, that is, if some higher weighted activities when completed by the learner would add more to his total score than when he completes a relatively lower weighted activity. Not only this, the Sequencing and Navigation specifications can allow the content developer to randomly select a different subset of SCOs each time a new attempt is made. <br /> The SN specification also powers the content developer to forcibly take the learner to initial SCO (that would generally have some instructions).<br /> <br /> Every activity of a SCORM 2004 content package has a '''tracking data''' and a '''sequencing definition''' associated with it. The tracking data has the information about the current state of the activity that is, the score of the learner, the status, etc. The sequencing definition is the set of rules that defines which activity should follow next, that is, which activity should be presented to the learner after he completes the activity depending upon the tracking data of the activity.<br /> <br /> The sequencing definition model rules can be subdivided as -<br /> <br /> :'''''Sequencing Control Modes''''' – these define the type of navigation allowed to the learner, that is navigation through the TOC or linear navigation via previous/next buttons.<br /> :'''''Constrain Choice Controls''''' – Restrict the activities that the user may select from the table of contents.<br /> :'''''Sequencing Rules''''' – Specify if-then conditions that determine which activities are available for delivery and which activity should be delivered next.<br /> :'''''Limit Conditions''''' – Provide limits on the number of times activities can be attempted.<br /> :'''''Rollup Rules''''' – Specify if-then conditions that determine how status is rolled up to clusters throughout the activity tree.<br /> :'''''Rollup Controls''''' – Determine which activities participate in status rollup and how their status is weighted in relation to other activities.<br /> :'''''Rollup Consideration Controls''''' – Provide more precise control over status rollup than do the rollup controls.<br /> :'''''Objectives''''' – Provide a way to track the status of individual learning objectives and share this status across activities. Objectives are often overloaded and used as variables to control sequencing actions.<br /> :'''''Selection Controls''''' – Provide a way to specify that only a random subset of the available activities should be delivered.<br /> :'''''Randomization Controls''''' - Shuffle the order of the activities to be delivered.<br /> :'''''Delivery Controls''''' – Allow for non-communicative content to be delivered and sequenced.<br /> :'''''Completion Threshold Controls''''' – Allow the tracking of completion percentage. This was introduced in the SCORM 2004 4th Edition specification.<br /> :'''''Navigation Controls''''' - Control which navigational UI elements should be presented by the LMS.<br /> <br /> ====Current State====<br /> The code that currently implements Sequencing and Navigation specification of ADL SCORM 2004 specification is in the file '''/mod/scorm/datamodels/sequencinglib.php'''.<br /> <br /> The SCORM module currently supports '''activity restriction''', that is, if the content developer has restricted some activities to not to be navigable directly by selecting from the table of contents, the TOC does not allow the learner to do so. Though, the TOC is correctly rendered, there are issues like when the initial SCO/activity is complete and it triggers the continue event, the next SCO is not launched, rather the same initial SCO is launched again.<br /> In some cases the SCO uses '''adl.nav.request''' to navigate to a different location, this also causes the same issue of the SCO being launched again.<br /> These are just a couple of the many issues that are currently there in the SCORM module to support SCORM 2004 Sequencing and Navigation specification specification.<br /> <br /> The bug that holds the next SCO from being launched will be the first issue that would be fixed as the part of the project to improve SCORM 2004 support in Moodle, because, this bug will prevent other SCORM 2004 test packages to load successfuly and thus, would not allow the SCORM 2004 conformance packages to run and test successfully.<br /> A probable fix for the issue would be to store the structure so that code can continue but learner cannot use continue, TOC, links, etc.<br /> The above can be implemented by shifting the URLs of the SCO to the id attribute of the spans HTML tags and then making JavaScript to fetch the ids and use them as URLs.<br /> <br /> Work is already being done to rewrite the function '''scorm_get_toc''' - MDL-32835.<br /> <br /> The SCORM Test Harness will help in identifying other Sequencing and Navigation issues in the SCORM module by helping to run the SCORM 2004 conformance test packages automatically.<br /> <br /> = Schedule of Deliverables =<br /> '''May 31st - 5th June''': Fix SN bug that prevents SCOs from loading, and potentially- [http://tracker.moodle.org/browse/MDL-28741 ADL Test: CM-02], [http://tracker.moodle.org/browse/MDL-28743 ADL Test: CM-03], and [http://tracker.moodle.org/browse/MDL-28802 ADL Test: DDM].<br /> <br /> '''6th - 17th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28805 ADL Test: DMI], [http://tracker.moodle.org/browse/MDL-28804 ADL Test: DMB], [http://tracker.moodle.org/browse/MDL-28745 ADL Test: CM-04], [http://tracker.moodle.org/browse/MDL-28926 ADL Test: T-01]<br /> <br /> '''18th - 27th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28772 ADL Test: CO-01], [http://tracker.moodle.org/browse/MDL-28773 ADL Test: CO-02], [http://tracker.moodle.org/browse/MDL-28775 ADL Test: CO-03], [http://tracker.moodle.org/browse/MDL-28795 ADL Test: CT-01]<br /> <br /> '''27th June - 8th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28806 ADL Test: MS-01], [http://tracker.moodle.org/browse/MDL-28807 MS-02], [http://tracker.moodle.org/browse/MDL-28808 MS-03], [http://tracker.moodle.org/browse/MDL-28814 OB-01], [http://tracker.moodle.org/browse/MDL-28796 CT-02]<br /> <br /> '''9th - 15th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28854 ADL Test: RU-01], [http://tracker.moodle.org/browse/MDL-28858 ADL Test: RU-02], [http://tracker.moodle.org/browse/MDL-28860 ADL Test: RU-03], [http://tracker.moodle.org/browse/MDL-28862 ADL Test: RU-04]<br /> <br /> ''This will be the midterm evaluation target - A detailed report on the then status of SCORM 2004 support in Moodle, mentioning all improvements and results of the closed issues to the Moodle Community.''<br /> <br /> '''16th July - 22nd July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28902 ADL Test: SX-02], [http://tracker.moodle.org/browse/MDL-28903 ADL Test: SX-03], [http://tracker.moodle.org/browse/MDL-28904 ADL Test: SX-04], [http://tracker.moodle.org/browse/MDL-28749 CM-05]<br /> <br /> '''23rd July - 1st August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28750 ADL Test: CM-06], [http://tracker.moodle.org/browse/MDL-28751 ADL Test: CM-07], [http://tracker.moodle.org/browse/MDL-28779 ADL Test: CO-05], [http://tracker.moodle.org/browse/MDL-28781 ADL Test: CO-06], [http://tracker.moodle.org/browse/MDL-28782 ADL Test: CO-07]<br /> <br /> '''2nd - 12th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28797 ADL Test: CT-03], [http://tracker.moodle.org/browse/MDL-28798 ADL Test: CT-04], [http://tracker.moodle.org/browse/MDL-28799 ADL Test: CT-05], [http://tracker.moodle.org/browse/MDL-28757 CM-08], [http://tracker.moodle.org/browse/MDL-28758 ADL Test: CM-09]<br /> <br /> '''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]<br /> <br /> = Relevant Links =<br /> *[https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]<br /> *[https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> *[http://www.adlnet.gov/capabilities/scorm/scorm-2004-4th ADL SCORM 2004 4th Edition]<br /> *[https://docs.moodle.org/dev/GSOC/2012 GSoC 2012 - Moodle]<br /> <br /> == Tracker ==<br /> * [http://tracker.moodle.org/browse/MDL-7608 META: SCORM 2004 compliance + issues]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=GSOC/2012&diff=33808 2012-05-14T12:08:39Z

<p>Mayank gupta2005: /*Improving SCORM 2004 Support */ Updating Specification and Blog Link</p> <hr /> <div>[[Image:banner-gsoc2012.png|right|400px]]This page provides an overview of the [http://www.google-melange.com/gsoc/program/home/google/gsoc2012 Google Summer of Code 2012] projects for Moodle.<br /> <br /> ==Improving SCORM 2004 Support==<br /> <br /> :'''Student''': [http://moodle.org/user/view.php?id=1277285&amp;course=5 Mayank Gupta]<br /> :'''Mentor''': [http://moodle.org/user/view.php?id=21591&amp;course=5 Dan Marsden]<br /> :'''Specification''': [[Improve_SCORM_2004_Support]]<br /> <br /> See also:<br /> * MDL-7068<br /> * Developer blog [http://www.guptamayank.com/ # Mayank Gupta]<br /> <br /> ==Improving Plagiarism API==<br /> <br /> :'''Student''': [http://moodle.org/user/profile.php?id=1411986 Kanika Goyal]<br /> :'''Mentor''': [http://moodle.org/user/view.php?id=21591&amp;course=5 Dan Marsden]<br /> :'''Specification''': [[Plagiarism_API_improvements]]<br /> <br /> See also:<br /> * MDL-32225<br /> <br /> ==Email reminders for calendar events==<br /> :'''Student''': [http://moodle.org/user/view.php?id=1240428&amp;course=5 Isuru Madushanka Weerarathna]<br /> :'''Mentor''': [http://moodle.org/user/view.php?id=381842&amp;course=5 Michael de Raadt]<br /> :'''Specification''': [[Email reminders for calendar events]]<br /> <br /> ==Video/audio capture repository plugin==<br /> :'''Student''': [http://moodle.org/user/profile.php?id=1439658 Ankit Gupta]<br /> :'''Mentor''': [http://moodle.org/user/profile.php?id=1328988 Rajesh Taneja]<br /> :'''Specification''': [[ Audio/Video Capture repository plugin ]]<br /> [[Category:GSOC]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=Improve_SCORM_2004_Support&diff=33807 2012-05-14T12:05:18Z

<p>Mayank gupta2005: /* Relevant Links */ Updating GSoC 2012 Link</p> <hr /> <div>{{Infobox Project<br /> |name = Improve SCORM 2004 Support<br /> |state = Community Bonding<br /> |tracker = MDL-7068<br /> |discussion = <br /> |assignee = Mayank Gupta<br /> }}<br /> {{Moodle 2.3}}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '12&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for Improving SCORM 2004 Support in Moodle, a Google Summer Of Code ''(GSoC)'' 2012 project.<br /> The ''goal'' of this project is to work towards achieving full SCORM 2004 4th Edition compliance in Moodle without the need of any external plugins, that is, improving the support for SCORM 2004 content packages in Moodle.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/view.php?id=381842 Michael de Raadt].<br /> <br /> ==Context==<br /> The project will improve the SCORM 2004 support in Moodle by using the [https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]. The automated test framework will help by automating the execution of SCORM 2004 tests in Moodle and thus, will help in identify the issues with SCORM 2004 support in Moodle.<br /> This project will also indirectly help in improving the SCORM Test Harness itself, as by getting the Test Harness into action bugs would be identified and fixed in the Test Harness.<br /> <br /> In order for Moodle to be SCORM 2004 4th Edition compliant and pass all the 189 ADL SCORM 2004 conformance test packages, it needs to adhere to the specifications laid down by [http://www.adlnet.gov/wp-content/uploads/2011/07/SCORM_2004_4ED_v1_1_Doc_Suite.zip ADL SCORM 2004 ''4th Edition'']. <br /> The specification can be divided into three sub-specifications as - <br /> * Content Aggregation Model '''(CAM)'''<br /> * The Run-Time Environment '''(RTE)'''<br /> * Sequencing and Navigation specification '''(SN)'''<br /> <br /> ===Content Aggregation Model===<br /> The Content Aggregation Model sub-specification of SCORM 2004 4th Edition specifies how SCORM 2004 content developers should package their content so that the packages can be imported into the LMS. According to SCORM 2004 specification the content developers should package the content in a self-contained directory or a ZIP file which is also called a '''Package Interchange File (PIF)'''. <br /> <br /> SCORM 2004 specifies that the packaged ZIP file should always contain an XML file with the name - ''' 'imsmanifest.xml' '''. This imsmanifest.xml file also called the manifest file should be located in the root of the ZIP file. The content developers have to make sure that this manifest file contains all the information the LMS would need to successfully deliver the SCORM 2004 content to the content viewers.<br /> <br /> The manifest file divides the course into one or more parts called SCOs, which in other words represents the activity tree for the course content. The manifest file contains an XML representation of the activity tree of the package, information about how to launch each SCO, and optional metadata that would describe the course and its part.<br /> As a LMS it is the responsibility of Moodle's &quot;SCORM module's code&quot; to correctly parse the manifest file, store all the required information of the package in the database. <br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scormlib.php''' has the code that parses the manifest file. <br /> Currently this file is not able to parse all the CAM definitions according to SCORM 2004 4th Edition Specifications. <br /> For instance, the current code of '''scormlib.php''' is not able to parse correctly the '''ADLCP:DATA''', and '''ADLCP:MAP''' sections of the manifest file. These sections define the '''Inter-SCO Storage Data Model Extension'''; that was introduced in ADL SCORM 2004 4th Edition specification. <br /> Other sections of the manifest file that scormlib.php fails to parse successfully will be identified and resolved during the course of the project by running the SCORM Test Harness for individual SCORM 2004 conformance packages.<br /> <br /> ===Run-Time Environment===<br /> The Run-Time Environment (RTE) sub-specification of SCORM 2004 specification specifies how the LMS should launch the content package within itself. The RTE states that the SCORM 2004 content package should be launched within Moodle in a web browser as a new window or within a '''frameset''' in the same window. The RTE specification specifies that all the content in the SCORM 2004 package should be web deliverable and is always launched in a web browser. It also specifies that the LMS should launch one SCO at a time.<br /> <br /> In order to allow communication between the SCORM 2004 content package more specifically the launched SCO of the content package and the LMS; the LMS should provide an '''ECMAScript''' (JavaScript) API through which the SCO can communicate with it. All communication between the SCO and the LMS can take place through this JavaScript API only, that is, the content package can by no means communicate with the LMS through form posts, database access (read/write), web services or any other mechanism.<br /> As a SCO can communicate only through the JavaScript API, the LMS provides the JavaScript object of the API at a specific location within the browsers' DOM. This API object has the special name of ''' 'API_1484_11' ''' for SCORM 2004.<br /> It is the responsibility of the content/SCO to locate this API object and then use it for all the communications it needs to do with the LMS. RTE specifies that only the SCO can initiate the communication as the LMS acts as a passive entity which is simply responding to the API calls made by the SCO. <br /> <br /> The API provides a set of eight functions that permit the exchange of data with the LMS. These functions are -<br /> <br /> {| class=&quot;nicetable&quot; border=&quot;1&quot; cellpadding=&quot;5&quot; cellspacing=&quot;0&quot; align=&quot;center&quot;<br /> |-<br /> ! Function<br /> ! Return Type<br /> ! Remarks<br /> |-<br /> | Initialize( “” )<br /> | bool<br /> | it indicates to the LMS that the content would like to begin a communication session.<br /> |-<br /> | Terminate( “” )<br /> | bool<br /> | it indicates to the LMS that the content has finished communicating<br /> |-<br /> | GetValue( element : CMIElement )<br /> | string<br /> | it allows the SCO/content to data from the LMS<br /> |-<br /> | SetValue( element : CMIElement, value : string)<br /> | string<br /> | it allows the SCO/content to persist data to the LMS.<br /> |-<br /> | Commit( “” )<br /> | bool<br /> | it is used by the SCO/content to signal the LMS that a significant chuck of data has been saved and that the LMS should ensure the data is properly persisted<br /> |-<br /> | GetLastError()<br /> | CMIErrorCode<br /> | it allows to determing if the last SCORM API call caused an error<br /> |-<br /> | GetErrorString( errorCode : CMIErrorCode )<br /> | string<br /> | it return a textual description of what the passed error code means<br /> |-<br /> | GetDiagnostic( errocCode : CMIErrorCode )<br /> | string<br /> | it returns detailed information about the prior error that can be useful in detecting the problem.<br /> |}<br /> <br /> The Computer Managed Instruction or '''CMI''' data model provides a list of data elements which can be read and written using the API. Each data model element has its own meaning.<br /> <br /> Every SCO in a content package has its own set of run-time data. These data model elements have different values for different SCOs within a content package.<br /> Before SCORM 2004 4th edition the RTE data model definitions came into existence these data model elements could not be shared across SCOs of the same or different content package.<br /> When the content user or learner starts a new attempt on a SCO, the data model element's values are reset to the default values at the start of the new attempt. These data models have different default values and can be of either '''read-only''' or both read and '''write''' type.<br /> <br /> Some examples SCORM 2004 RTE data model elements include the '''cmi.completion_status''' element - that saves the status of the SCO (completed or incomplete), '''cmi.success_status''' (passed or failed), the score of the learner, a bookmark to track the learner’s location, and the total amount of time the learner spent in the SCO.<br /> <br /> However, apart from the non-sharable data model elements defined before, the SCORM 2004 4th Edition RTE Data Model definitions define the <br /> '''adl.data''' data model elements that provide the unique ability to share sets of data across the SCOs.<br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scorm_13.js.php''' has the code to deal with the data model elements that a SCO would require.<br /> This code needs to be extended to support the data models defined by the SCORM 2004 4th Edition Run-Time Envirnoment Data Model definition. These data model elements mainly include adl.data elements - Inter-SCO Storage Data Model Extension.<br /> Some progress has already been made on the tracker issue MDL-28805 - ADL TEST: Data Model Implementation (DMI).<br /> While trying to fix the mentioned bug, a number of related issues that needed to be resolved before the bug MDL-28805 could be closed were identified. These bugs were - MDL-30666, MDL-30576, MDL-30577, MDL-30578, MDL-30579, MDL-30645.<br /> As mentioned above, during the course of the project the data model code would be extended to support SCORM 2004 4th Edition Run-Time Environment Data Model definitions and other '' 'buggy areas' '' would be identified by running the SCORM Test Harness for SCORM 2004 Conformance packages issues would be reported and patches will be provided.<br /> <br /> ===Sequencing And Navigation===<br /> <br /> The Sequencing and Navigation sub-specification of SCORM 2004 4th Edition specification allows content developers to '''override''' the default navigation of SCOs and enable them to govern how the content user/learner is allowed to navigate between various SCOs in the content package and also how the progress data is '''rolled up''' to the course level of the content package.<br /> <br /> The content developers lay down the sequencing rules in the imsmanifest.xml file or the manifest file, in the root directory of the PIF. These rules in-turn determine which '''navigational controls''' should the LMS provide to the content user/learner, that is, whether or not a navigable table of contents '''(TOC)''' should be provided to the learner or just the previous/next buttons should be provided to the learner to navigate from one SCO to another in a linear sequence of SCOs.<br /> By specifying sequencing and navigation rules in the manifest file the content developer can also specify that certain conditions like some SCOs/activities must be completed before the learner can navigate to the some other SCO/activity. <br /> The content developer by adhering to the SCORM 2004 Sequence and Navigation specification can also apply a gradient weight to some parts or activities of the content package, that is, if some higher weighted activities when completed by the learner would add more to his total score than when he completes a relatively lower weighted activity. Not only this, the Sequencing and Navigation specifications can allow the content developer to randomly select a different subset of SCOs each time a new attempt is made. <br /> The SN specification also powers the content developer to forcibly take the learner to initial SCO (that would generally have some instructions).<br /> <br /> Every activity of a SCORM 2004 content package has a '''tracking data''' and a '''sequencing definition''' associated with it. The tracking data has the information about the current state of the activity that is, the score of the learner, the status, etc. The sequencing definition is the set of rules that defines which activity should follow next, that is, which activity should be presented to the learner after he completes the activity depending upon the tracking data of the activity.<br /> <br /> The sequencing definition model rules can be subdivided as -<br /> <br /> :'''''Sequencing Control Modes''''' – these define the type of navigation allowed to the learner, that is navigation through the TOC or linear navigation via previous/next buttons.<br /> :'''''Constrain Choice Controls''''' – Restrict the activities that the user may select from the table of contents.<br /> :'''''Sequencing Rules''''' – Specify if-then conditions that determine which activities are available for delivery and which activity should be delivered next.<br /> :'''''Limit Conditions''''' – Provide limits on the number of times activities can be attempted.<br /> :'''''Rollup Rules''''' – Specify if-then conditions that determine how status is rolled up to clusters throughout the activity tree.<br /> :'''''Rollup Controls''''' – Determine which activities participate in status rollup and how their status is weighted in relation to other activities.<br /> :'''''Rollup Consideration Controls''''' – Provide more precise control over status rollup than do the rollup controls.<br /> :'''''Objectives''''' – Provide a way to track the status of individual learning objectives and share this status across activities. Objectives are often overloaded and used as variables to control sequencing actions.<br /> :'''''Selection Controls''''' – Provide a way to specify that only a random subset of the available activities should be delivered.<br /> :'''''Randomization Controls''''' - Shuffle the order of the activities to be delivered.<br /> :'''''Delivery Controls''''' – Allow for non-communicative content to be delivered and sequenced.<br /> :'''''Completion Threshold Controls''''' – Allow the tracking of completion percentage. This was introduced in the SCORM 2004 4th Edition specification.<br /> :'''''Navigation Controls''''' - Control which navigational UI elements should be presented by the LMS.<br /> <br /> ====Current State====<br /> The code that currently implements Sequencing and Navigation specification of ADL SCORM 2004 specification is in the file '''/mod/scorm/datamodels/sequencinglib.php'''.<br /> <br /> The SCORM module currently supports '''activity restriction''', that is, if the content developer has restricted some activities to not to be navigable directly by selecting from the table of contents, the TOC does not allow the learner to do so. Though, the TOC is correctly rendered, there are issues like when the initial SCO/activity is complete and it triggers the continue event, the next SCO is not launched, rather the same initial SCO is launched again.<br /> In some cases the SCO uses '''adl.nav.request''' to navigate to a different location, this also causes the same issue of the SCO being launched again.<br /> These are just a couple of the many issues that are currently there in the SCORM module to support SCORM 2004 Sequencing and Navigation specification specification.<br /> <br /> The bug that holds the next SCO from being launched will be the first issue that would be fixed as the part of the project to improve SCORM 2004 support in Moodle, because, this bug will prevent other SCORM 2004 test packages to load successfuly and thus, would not allow the SCORM 2004 conformance packages to run and test successfully.<br /> A probable fix for the issue would be to store the structure so that code can continue but learner cannot use continue, TOC, links, etc.<br /> The above can be implemented by shifting the URLs of the SCO to the id attribute of the spans HTML tags and then making JavaScript to fetch the ids and use them as URLs.<br /> <br /> Work is already being done to rewrite the function '''scorm_get_toc''' - MDL-32835.<br /> <br /> The SCORM Test Harness will help in identifying other Sequencing and Navigation issues in the SCORM module by helping to run the SCORM 2004 conformance test packages automatically.<br /> <br /> = Schedule of Deliverables =<br /> '''May 31st - 5th June''': Fix SN bug that prevents SCOs from loading, and potentially- [http://tracker.moodle.org/browse/MDL-28741 ADL Test: CM-02], [http://tracker.moodle.org/browse/MDL-28743 ADL Test: CM-03], and [http://tracker.moodle.org/browse/MDL-28802 ADL Test: DDM].<br /> <br /> '''6th - 17th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28805 ADL Test: DMI], [http://tracker.moodle.org/browse/MDL-28804 ADL Test: DMB], [http://tracker.moodle.org/browse/MDL-28745 ADL Test: CM-04], [http://tracker.moodle.org/browse/MDL-28926 ADL Test: T-01]<br /> <br /> '''18th - 27th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28772 ADL Test: CO-01], [http://tracker.moodle.org/browse/MDL-28773 ADL Test: CO-02], [http://tracker.moodle.org/browse/MDL-28775 ADL Test: CO-03], [http://tracker.moodle.org/browse/MDL-28795 ADL Test: CT-01]<br /> <br /> '''27th June - 8th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28806 ADL Test: MS-01], [http://tracker.moodle.org/browse/MDL-28807 MS-02], [http://tracker.moodle.org/browse/MDL-28808 MS-03], [http://tracker.moodle.org/browse/MDL-28814 OB-01], [http://tracker.moodle.org/browse/MDL-28796 CT-02]<br /> <br /> '''9th - 15th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28854 ADL Test: RU-01], [http://tracker.moodle.org/browse/MDL-28858 ADL Test: RU-02], [http://tracker.moodle.org/browse/MDL-28860 ADL Test: RU-03], [http://tracker.moodle.org/browse/MDL-28862 ADL Test: RU-04]<br /> <br /> ''This will be the midterm evaluation target - A detailed report on the then status of SCORM 2004 support in Moodle, mentioning all improvements and results of the closed issues to the Moodle Community.''<br /> <br /> '''16th July - 22nd July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28902 ADL Test: SX-02], [http://tracker.moodle.org/browse/MDL-28903 ADL Test: SX-03], [http://tracker.moodle.org/browse/MDL-28904 ADL Test: SX-04], [http://tracker.moodle.org/browse/MDL-28749 CM-05]<br /> <br /> '''23rd July - 1st August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28750 ADL Test: CM-06], [http://tracker.moodle.org/browse/MDL-28751 ADL Test: CM-07], [http://tracker.moodle.org/browse/MDL-28779 ADL Test: CO-05], [http://tracker.moodle.org/browse/MDL-28781 ADL Test: CO-06], [http://tracker.moodle.org/browse/MDL-28782 ADL Test: CO-07]<br /> <br /> '''2nd - 12th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28797 ADL Test: CT-03], [http://tracker.moodle.org/browse/MDL-28798 ADL Test: CT-04], [http://tracker.moodle.org/browse/MDL-28799 ADL Test: CT-05], [http://tracker.moodle.org/browse/MDL-28757 CM-08], [http://tracker.moodle.org/browse/MDL-28758 ADL Test: CM-09]<br /> <br /> '''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]<br /> <br /> <br /> = Relevant Links =<br /> *[https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]<br /> *[https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> *[http://www.adlnet.gov/capabilities/scorm/scorm-2004-4th ADL SCORM 2004 4th Edition]<br /> *[https://docs.moodle.org/dev/GSOC/2012 GSoC 2012 - Moodle]<br /> <br /> == Tracker ==<br /> * [http://tracker.moodle.org/browse/MDL-7608 META: SCORM 2004 compliance + issues]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=Improve_SCORM_2004_Support&diff=33806 2012-05-14T12:03:12Z

<p>Mayank gupta2005: Created page with &quot;{{Infobox Project |name = Improve SCORM 2004 Support |state = Community Bonding |tracker = MDL-7068 |discussion = |assignee = Mayank Gupta }} {{Moodle 2.3}} &lt;span class=&quot;small-i...&quot;</p> <hr /> <div>{{Infobox Project<br /> |name = Improve SCORM 2004 Support<br /> |state = Community Bonding<br /> |tracker = MDL-7068<br /> |discussion = <br /> |assignee = Mayank Gupta<br /> }}<br /> {{Moodle 2.3}}<br /> &lt;span class=&quot;small-info-right&quot;&gt;<br /> &lt;b&gt;GSOC&lt;/b&gt;<br /> &lt;span class=&quot;text-big new&quot;&gt; '12&lt;/span&gt;<br /> &lt;/span&gt;<br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for Improving SCORM 2004 Support in Moodle, a Google Summer Of Code ''(GSoC)'' 2012 project.<br /> The ''goal'' of this project is to work towards achieving full SCORM 2004 4th Edition compliance in Moodle without the need of any external plugins, that is, improving the support for SCORM 2004 content packages in Moodle.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/view.php?id=381842 Michael de Raadt].<br /> <br /> ==Context==<br /> The project will improve the SCORM 2004 support in Moodle by using the [https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]. The automated test framework will help by automating the execution of SCORM 2004 tests in Moodle and thus, will help in identify the issues with SCORM 2004 support in Moodle.<br /> This project will also indirectly help in improving the SCORM Test Harness itself, as by getting the Test Harness into action bugs would be identified and fixed in the Test Harness.<br /> <br /> In order for Moodle to be SCORM 2004 4th Edition compliant and pass all the 189 ADL SCORM 2004 conformance test packages, it needs to adhere to the specifications laid down by [http://www.adlnet.gov/wp-content/uploads/2011/07/SCORM_2004_4ED_v1_1_Doc_Suite.zip ADL SCORM 2004 ''4th Edition'']. <br /> The specification can be divided into three sub-specifications as - <br /> * Content Aggregation Model '''(CAM)'''<br /> * The Run-Time Environment '''(RTE)'''<br /> * Sequencing and Navigation specification '''(SN)'''<br /> <br /> ===Content Aggregation Model===<br /> The Content Aggregation Model sub-specification of SCORM 2004 4th Edition specifies how SCORM 2004 content developers should package their content so that the packages can be imported into the LMS. According to SCORM 2004 specification the content developers should package the content in a self-contained directory or a ZIP file which is also called a '''Package Interchange File (PIF)'''. <br /> <br /> SCORM 2004 specifies that the packaged ZIP file should always contain an XML file with the name - ''' 'imsmanifest.xml' '''. This imsmanifest.xml file also called the manifest file should be located in the root of the ZIP file. The content developers have to make sure that this manifest file contains all the information the LMS would need to successfully deliver the SCORM 2004 content to the content viewers.<br /> <br /> The manifest file divides the course into one or more parts called SCOs, which in other words represents the activity tree for the course content. The manifest file contains an XML representation of the activity tree of the package, information about how to launch each SCO, and optional metadata that would describe the course and its part.<br /> As a LMS it is the responsibility of Moodle's &quot;SCORM module's code&quot; to correctly parse the manifest file, store all the required information of the package in the database. <br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scormlib.php''' has the code that parses the manifest file. <br /> Currently this file is not able to parse all the CAM definitions according to SCORM 2004 4th Edition Specifications. <br /> For instance, the current code of '''scormlib.php''' is not able to parse correctly the '''ADLCP:DATA''', and '''ADLCP:MAP''' sections of the manifest file. These sections define the '''Inter-SCO Storage Data Model Extension'''; that was introduced in ADL SCORM 2004 4th Edition specification. <br /> Other sections of the manifest file that scormlib.php fails to parse successfully will be identified and resolved during the course of the project by running the SCORM Test Harness for individual SCORM 2004 conformance packages.<br /> <br /> ===Run-Time Environment===<br /> The Run-Time Environment (RTE) sub-specification of SCORM 2004 specification specifies how the LMS should launch the content package within itself. The RTE states that the SCORM 2004 content package should be launched within Moodle in a web browser as a new window or within a '''frameset''' in the same window. The RTE specification specifies that all the content in the SCORM 2004 package should be web deliverable and is always launched in a web browser. It also specifies that the LMS should launch one SCO at a time.<br /> <br /> In order to allow communication between the SCORM 2004 content package more specifically the launched SCO of the content package and the LMS; the LMS should provide an '''ECMAScript''' (JavaScript) API through which the SCO can communicate with it. All communication between the SCO and the LMS can take place through this JavaScript API only, that is, the content package can by no means communicate with the LMS through form posts, database access (read/write), web services or any other mechanism.<br /> As a SCO can communicate only through the JavaScript API, the LMS provides the JavaScript object of the API at a specific location within the browsers' DOM. This API object has the special name of ''' 'API_1484_11' ''' for SCORM 2004.<br /> It is the responsibility of the content/SCO to locate this API object and then use it for all the communications it needs to do with the LMS. RTE specifies that only the SCO can initiate the communication as the LMS acts as a passive entity which is simply responding to the API calls made by the SCO. <br /> <br /> The API provides a set of eight functions that permit the exchange of data with the LMS. These functions are -<br /> <br /> {| class=&quot;nicetable&quot; border=&quot;1&quot; cellpadding=&quot;5&quot; cellspacing=&quot;0&quot; align=&quot;center&quot;<br /> |-<br /> ! Function<br /> ! Return Type<br /> ! Remarks<br /> |-<br /> | Initialize( “” )<br /> | bool<br /> | it indicates to the LMS that the content would like to begin a communication session.<br /> |-<br /> | Terminate( “” )<br /> | bool<br /> | it indicates to the LMS that the content has finished communicating<br /> |-<br /> | GetValue( element : CMIElement )<br /> | string<br /> | it allows the SCO/content to data from the LMS<br /> |-<br /> | SetValue( element : CMIElement, value : string)<br /> | string<br /> | it allows the SCO/content to persist data to the LMS.<br /> |-<br /> | Commit( “” )<br /> | bool<br /> | it is used by the SCO/content to signal the LMS that a significant chuck of data has been saved and that the LMS should ensure the data is properly persisted<br /> |-<br /> | GetLastError()<br /> | CMIErrorCode<br /> | it allows to determing if the last SCORM API call caused an error<br /> |-<br /> | GetErrorString( errorCode : CMIErrorCode )<br /> | string<br /> | it return a textual description of what the passed error code means<br /> |-<br /> | GetDiagnostic( errocCode : CMIErrorCode )<br /> | string<br /> | it returns detailed information about the prior error that can be useful in detecting the problem.<br /> |}<br /> <br /> The Computer Managed Instruction or '''CMI''' data model provides a list of data elements which can be read and written using the API. Each data model element has its own meaning.<br /> <br /> Every SCO in a content package has its own set of run-time data. These data model elements have different values for different SCOs within a content package.<br /> Before SCORM 2004 4th edition the RTE data model definitions came into existence these data model elements could not be shared across SCOs of the same or different content package.<br /> When the content user or learner starts a new attempt on a SCO, the data model element's values are reset to the default values at the start of the new attempt. These data models have different default values and can be of either '''read-only''' or both read and '''write''' type.<br /> <br /> Some examples SCORM 2004 RTE data model elements include the '''cmi.completion_status''' element - that saves the status of the SCO (completed or incomplete), '''cmi.success_status''' (passed or failed), the score of the learner, a bookmark to track the learner’s location, and the total amount of time the learner spent in the SCO.<br /> <br /> However, apart from the non-sharable data model elements defined before, the SCORM 2004 4th Edition RTE Data Model definitions define the <br /> '''adl.data''' data model elements that provide the unique ability to share sets of data across the SCOs.<br /> <br /> ====Current State====<br /> The file '''/mod/scorm/datamodels/scorm_13.js.php''' has the code to deal with the data model elements that a SCO would require.<br /> This code needs to be extended to support the data models defined by the SCORM 2004 4th Edition Run-Time Envirnoment Data Model definition. These data model elements mainly include adl.data elements - Inter-SCO Storage Data Model Extension.<br /> Some progress has already been made on the tracker issue MDL-28805 - ADL TEST: Data Model Implementation (DMI).<br /> While trying to fix the mentioned bug, a number of related issues that needed to be resolved before the bug MDL-28805 could be closed were identified. These bugs were - MDL-30666, MDL-30576, MDL-30577, MDL-30578, MDL-30579, MDL-30645.<br /> As mentioned above, during the course of the project the data model code would be extended to support SCORM 2004 4th Edition Run-Time Environment Data Model definitions and other '' 'buggy areas' '' would be identified by running the SCORM Test Harness for SCORM 2004 Conformance packages issues would be reported and patches will be provided.<br /> <br /> ===Sequencing And Navigation===<br /> <br /> The Sequencing and Navigation sub-specification of SCORM 2004 4th Edition specification allows content developers to '''override''' the default navigation of SCOs and enable them to govern how the content user/learner is allowed to navigate between various SCOs in the content package and also how the progress data is '''rolled up''' to the course level of the content package.<br /> <br /> The content developers lay down the sequencing rules in the imsmanifest.xml file or the manifest file, in the root directory of the PIF. These rules in-turn determine which '''navigational controls''' should the LMS provide to the content user/learner, that is, whether or not a navigable table of contents '''(TOC)''' should be provided to the learner or just the previous/next buttons should be provided to the learner to navigate from one SCO to another in a linear sequence of SCOs.<br /> By specifying sequencing and navigation rules in the manifest file the content developer can also specify that certain conditions like some SCOs/activities must be completed before the learner can navigate to the some other SCO/activity. <br /> The content developer by adhering to the SCORM 2004 Sequence and Navigation specification can also apply a gradient weight to some parts or activities of the content package, that is, if some higher weighted activities when completed by the learner would add more to his total score than when he completes a relatively lower weighted activity. Not only this, the Sequencing and Navigation specifications can allow the content developer to randomly select a different subset of SCOs each time a new attempt is made. <br /> The SN specification also powers the content developer to forcibly take the learner to initial SCO (that would generally have some instructions).<br /> <br /> Every activity of a SCORM 2004 content package has a '''tracking data''' and a '''sequencing definition''' associated with it. The tracking data has the information about the current state of the activity that is, the score of the learner, the status, etc. The sequencing definition is the set of rules that defines which activity should follow next, that is, which activity should be presented to the learner after he completes the activity depending upon the tracking data of the activity.<br /> <br /> The sequencing definition model rules can be subdivided as -<br /> <br /> :'''''Sequencing Control Modes''''' – these define the type of navigation allowed to the learner, that is navigation through the TOC or linear navigation via previous/next buttons.<br /> :'''''Constrain Choice Controls''''' – Restrict the activities that the user may select from the table of contents.<br /> :'''''Sequencing Rules''''' – Specify if-then conditions that determine which activities are available for delivery and which activity should be delivered next.<br /> :'''''Limit Conditions''''' – Provide limits on the number of times activities can be attempted.<br /> :'''''Rollup Rules''''' – Specify if-then conditions that determine how status is rolled up to clusters throughout the activity tree.<br /> :'''''Rollup Controls''''' – Determine which activities participate in status rollup and how their status is weighted in relation to other activities.<br /> :'''''Rollup Consideration Controls''''' – Provide more precise control over status rollup than do the rollup controls.<br /> :'''''Objectives''''' – Provide a way to track the status of individual learning objectives and share this status across activities. Objectives are often overloaded and used as variables to control sequencing actions.<br /> :'''''Selection Controls''''' – Provide a way to specify that only a random subset of the available activities should be delivered.<br /> :'''''Randomization Controls''''' - Shuffle the order of the activities to be delivered.<br /> :'''''Delivery Controls''''' – Allow for non-communicative content to be delivered and sequenced.<br /> :'''''Completion Threshold Controls''''' – Allow the tracking of completion percentage. This was introduced in the SCORM 2004 4th Edition specification.<br /> :'''''Navigation Controls''''' - Control which navigational UI elements should be presented by the LMS.<br /> <br /> ====Current State====<br /> The code that currently implements Sequencing and Navigation specification of ADL SCORM 2004 specification is in the file '''/mod/scorm/datamodels/sequencinglib.php'''.<br /> <br /> The SCORM module currently supports '''activity restriction''', that is, if the content developer has restricted some activities to not to be navigable directly by selecting from the table of contents, the TOC does not allow the learner to do so. Though, the TOC is correctly rendered, there are issues like when the initial SCO/activity is complete and it triggers the continue event, the next SCO is not launched, rather the same initial SCO is launched again.<br /> In some cases the SCO uses '''adl.nav.request''' to navigate to a different location, this also causes the same issue of the SCO being launched again.<br /> These are just a couple of the many issues that are currently there in the SCORM module to support SCORM 2004 Sequencing and Navigation specification specification.<br /> <br /> The bug that holds the next SCO from being launched will be the first issue that would be fixed as the part of the project to improve SCORM 2004 support in Moodle, because, this bug will prevent other SCORM 2004 test packages to load successfuly and thus, would not allow the SCORM 2004 conformance packages to run and test successfully.<br /> A probable fix for the issue would be to store the structure so that code can continue but learner cannot use continue, TOC, links, etc.<br /> The above can be implemented by shifting the URLs of the SCO to the id attribute of the spans HTML tags and then making JavaScript to fetch the ids and use them as URLs.<br /> <br /> Work is already being done to rewrite the function '''scorm_get_toc''' - MDL-32835.<br /> <br /> The SCORM Test Harness will help in identifying other Sequencing and Navigation issues in the SCORM module by helping to run the SCORM 2004 conformance test packages automatically.<br /> <br /> = Schedule of Deliverables =<br /> '''May 31st - 5th June''': Fix SN bug that prevents SCOs from loading, and potentially- [http://tracker.moodle.org/browse/MDL-28741 ADL Test: CM-02], [http://tracker.moodle.org/browse/MDL-28743 ADL Test: CM-03], and [http://tracker.moodle.org/browse/MDL-28802 ADL Test: DDM].<br /> <br /> '''6th - 17th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28805 ADL Test: DMI], [http://tracker.moodle.org/browse/MDL-28804 ADL Test: DMB], [http://tracker.moodle.org/browse/MDL-28745 ADL Test: CM-04], [http://tracker.moodle.org/browse/MDL-28926 ADL Test: T-01]<br /> <br /> '''18th - 27th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28772 ADL Test: CO-01], [http://tracker.moodle.org/browse/MDL-28773 ADL Test: CO-02], [http://tracker.moodle.org/browse/MDL-28775 ADL Test: CO-03], [http://tracker.moodle.org/browse/MDL-28795 ADL Test: CT-01]<br /> <br /> '''27th June - 8th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28806 ADL Test: MS-01], [http://tracker.moodle.org/browse/MDL-28807 MS-02], [http://tracker.moodle.org/browse/MDL-28808 MS-03], [http://tracker.moodle.org/browse/MDL-28814 OB-01], [http://tracker.moodle.org/browse/MDL-28796 CT-02]<br /> <br /> '''9th - 15th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28854 ADL Test: RU-01], [http://tracker.moodle.org/browse/MDL-28858 ADL Test: RU-02], [http://tracker.moodle.org/browse/MDL-28860 ADL Test: RU-03], [http://tracker.moodle.org/browse/MDL-28862 ADL Test: RU-04]<br /> <br /> ''This will be the midterm evaluation target - A detailed report on the then status of SCORM 2004 support in Moodle, mentioning all improvements and results of the closed issues to the Moodle Community.''<br /> <br /> '''16th July - 22nd July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28902 ADL Test: SX-02], [http://tracker.moodle.org/browse/MDL-28903 ADL Test: SX-03], [http://tracker.moodle.org/browse/MDL-28904 ADL Test: SX-04], [http://tracker.moodle.org/browse/MDL-28749 CM-05]<br /> <br /> '''23rd July - 1st August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28750 ADL Test: CM-06], [http://tracker.moodle.org/browse/MDL-28751 ADL Test: CM-07], [http://tracker.moodle.org/browse/MDL-28779 ADL Test: CO-05], [http://tracker.moodle.org/browse/MDL-28781 ADL Test: CO-06], [http://tracker.moodle.org/browse/MDL-28782 ADL Test: CO-07]<br /> <br /> '''2nd - 12th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28797 ADL Test: CT-03], [http://tracker.moodle.org/browse/MDL-28798 ADL Test: CT-04], [http://tracker.moodle.org/browse/MDL-28799 ADL Test: CT-05], [http://tracker.moodle.org/browse/MDL-28757 CM-08], [http://tracker.moodle.org/browse/MDL-28758 ADL Test: CM-09]<br /> <br /> '''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]<br /> <br /> <br /> = Relevant Links =<br /> *[https://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]<br /> *[https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> *[http://www.adlnet.gov/capabilities/scorm/scorm-2004-4th ADL SCORM 2004 4th Edition]<br /> *[https://docs.moodle.org/en/GSOC/2012 GSoC 2012 - Moodle]<br /> <br /> == Tracker ==<br /> * [http://tracker.moodle.org/browse/MDL-7608 META: SCORM 2004 compliance + issues]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=32730 2012-03-10T12:23:32Z

<p>Mayank gupta2005: /*Removing Schedule*/</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Completed<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=30986 2011-12-17T09:59:35Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Completed<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=30848 2011-12-04T22:48:36Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=29109 2011-08-09T03:16:39Z

<p>Mayank gupta2005: Correcting versions</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b3.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=29108 2011-08-09T03:15:42Z

<p>Mayank gupta2005: Correcting versions</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b2.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b3\junit-4.9b2.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.3.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=29107 2011-08-09T03:14:28Z

<p>Mayank gupta2005: Added note for versions.</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory C:\ADLTests will be considered as the [working-directory] for the tests.''<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> ''Note - The SCORM Test Harness has been tested with Selenium 2.3.0 and Junit 4.9b3 (the latest versions available while writing this documentation).<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> <br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28781 2011-07-27T08:42:23Z

<p>Mayank gupta2005: Adding steps to specify username, password combination ADL 2004</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site URL, Moodle site student username and password, '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URL as system property and invoke the Junit runner.<br /> If you do not provide username, password combination the test script will use default username - ''joestudent'' and password - ''password''<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -Dusername=&quot;studentUsername&quot; -Dpassword=&quot;password&quot; <br /> -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ==Compile from Source==<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ===ADL 1.2 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ===ADL 2004 Tests===<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28759 2011-07-27T05:20:37Z

<p>Mayank gupta2005: Documentation to execute ADL 2004 Tests</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - You also need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> *'''SCORM Test Harness Repository' - Finally, you need to download the Moodle SCORM Test Harness Repository from GitHub and save it in [working_directory]. You can download the repository from here - [https://github.com/mayankgupta/moodle_scorm_test_harness Moodle SCORM Test Harness Repository].<br /> ''Note - If you do not wish to download/clone the complete repository, you can download the individual files required and create necessary folders as indicated in the steps below.<br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> ====ADL 1.2 Tests====<br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/TestSuite/SCORM1_2_TestSuite1_2_7ST.zip?raw=true Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse01.zip?raw=true LMSTestCourse01.zip] , [https://github.com/mayankgupta/moodle_scorm_test_harness/blob/master/ADL1.2/LMSTestCourseZipPackages/LMSTestCourse02.zip?raw=true LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL1.2/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL1.2\classFiles\ ADL 1.2 classFiles]. <br /> ====ADL 2004 Tests====<br /> * '''Install ADL SCORM 2004 Test Suite''' - Download and install the ADL SCORM 2004 Conformance Test Suite. Download the ADL 2004 Test Suite from here - [<br /> * '''Setup course''' - To test Moodle for ADL SCORM 2004 compliance you need to setup a course in the following manner - <br /> ** '''Course Name''' - Setup a course named as - '''ADL SCORM Test 2004'''. The student, whose login details you will provide later on should be able to enter this course and should be able to access all SCORM activity within this course.<br /> ** '''SCORM Package''' - Turn editing on and add SCORM Test packages as activity inside the course. You may add all the SCORM Test packages available in the Moodle SCORM Test Harness repository here - [https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/LMSTestCourseZipPackages ADL SCORM 2004 Test Packages]. You must ensure that you have uploaded all the Test Packages for all the ADL 2004 tests that you want to execute. While '''''Adding a new SCORM package''''' the name field should contain the test package name at the end of the package name that you enter. For instance - ''LMSTestPackage_API.zip'' when uploaded should have '''API''' at the end of the name, like - '''''ADL SCORM 2004 API''''' will be a valid name for API Test Package.<br /> * '''ADL 1.2 Test Script''' - If you have not downloaded/cloned the full repository then, you need to download/copy the ADL 1.2 Test Script ''class files'' from [http://https://github.com/mayankgupta/moodle_scorm_test_harness/tree/master/ADL2004/classFiles ADL 1.2 class files] and save them in the folder [working_directory]\ADL2004\classFiles\ ADL 2004 classFiles]<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> ===Set CLASSPATH===<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL1.2;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> ====ADL 1.2 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL___x\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ====ADL 2004 Tests====<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL2004\classFiles;<br /> C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ===Invoke Runner===<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner and specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 or SCORM 2004 Test Suite. For ADL 2004 Test you can also specify which tests to execute. <br /> ====ADL 1.2 Tests====<br /> To execute the ADL 1.2 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner. Execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite should be of LMSRTEMain.htm page, eg - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ====ADL 2004 Tests====<br /> To execute the ADL 2004 tests you need to specify the Moode Test Site and '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 URLs as system property and invoke the Junit runner.<br /> * '''Execute all tests''' - To execute all the tests you simply need to execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL2004<br /> * '''Specify Tests''' - To execute specific ADL SCORM 2004 tests you can use the following two ways to specify which tests to execute - <br /> ** '''test system property''' - You can specify the tests you want to execute by using ''-Dtest=&quot;testName1,testName2,..&quot; ''<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -Dtest=&quot;API, CM-01,CM-02a,CO-01&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ''Note - you can specify as many tests as you wish to run with -Dtest, but it is recommended to enter the test names in a file and use -DfilePath instead.<br /> ** '''Specify filePath''' - You can specify the tests you want to execute in a in a file and feed the test script with the file path with ''-Dfilepath=&quot;path\to\file&quot; ''. This file should contain each test name in a new line.<br /> To execute the test script with the filePath execute the following command - <br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; -DfilePath=&quot;path\to\file&quot; org.junit.runner.JUnitCore scormADL2004 <br /> ----<br /> ===Compile from Source===<br /> Optionally, you can compile the test scripts to generate the class files ''(if you do not wish to use the supplied class files)''<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL1.2''' or '''[working_directory]\ADL2004''' ''(you can also specify the full path to the scormADL12.java or scormADL2004.java file from your current directory)'' and execute the following command - <br /> ====ADL 1.2 Tests====<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> ====ADL 2004 Tests====<br /> javac [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; [working_directory]\ADL1.2\src\scormADL12.java<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28719 2011-07-24T21:46:46Z

<p>Mayank gupta2005: /* Executing the Tests */</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - Finally, you need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> <br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> <br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 Compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse01.zip LMSTestCourse01.zip] , [http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse02.zip LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - Download and the save the ADL 1.2 Test script as '''scormADL12.java''' in [working_directory]\ADL12\ . You can download the ADL 1.2 Test script from here - [https://gist.github.com/058a6f6273ce0767ed1f#file_scorm_adl12.java ADL 1.2 Test Script] ''(Please note - this is a temporary URL for the test script.)''<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL12;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL12;C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL12''' ''(you can also specify the full path to the scormADL12.java file from your current directory)'' and run the following command - <br /> javac path\to\scormADL12.java<br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; path\to\scormADL12.java<br /> <br /> ----<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to specify the Moodle Test Site URL along with the full URL of the '' &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; '' of SCORM ADL 1.2 Test Suite as a system property and invoke the Junit runner ''with the command'' -<br /> java -DmoodleURL=&quot;http://moodletestsite.org&quot; -DtestSuiteURL=&quot;http://fulltestsuiteurl&quot; org.junit.runner.JUnitCore scormADL12 <br /> ''The full URL to &quot;Learning Management System (LMS) Run-Time Environment Conformance Test&quot; of SCORM ADL 1.2 test suite will be like - http://localhost/Web/ADL/TestSuite1_2_7/TestSuite/lmsrte/LMSRTEMain.htm''<br /> ----<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28711 2011-07-20T20:11:51Z

<p>Mayank gupta2005: /* Executing the Tests */ steps order sequence corrected</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - Finally, you need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> <br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> <br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 Compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse01.zip LMSTestCourse01.zip] , [http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse02.zip LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - Download and the save the ADL 1.2 Test script as '''scormADL12.java''' in [working_directory]\ADL12\ . You can download the ADL 1.2 Test script from here - [https://gist.github.com/058a6f6273ce0767ed1f#file_scorm_adl12.java ADL 1.2 Test Script] ''(Please note - this is a temporary URL for the test script.)''<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> * '''Modify Test Script''' - The current version of the test script does not have support for command line arguments. Thus you need to specify the path to the ADL SCORM test suite and Moodle test site at line numbers - 26 and 27.<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL12;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL12;C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL12''' ''(you can also specify the full path to the scormADL12.java file from your current directory)'' and run the following command - <br /> javac path\to\scormADL12.java<br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; path\to\scormADL12.java<br /> <br /> ----<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner with the command -<br /> java org.junit.runner.JUnitCore scormADL12<br /> <br /> ----<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28607 2011-07-12T16:13:01Z

<p>Mayank gupta2005: /* Executing the Tests */</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - Finally, you need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> <br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> <br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 Compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse01.zip LMSTestCourse01.zip] , [http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse02.zip LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - Download and the save the ADL 1.2 Test script as '''scormADL12.java''' in [working_directory]\ADL12\ . You can download the ADL 1.2 Test script from here - [https://gist.github.com/058a6f6273ce0767ed1f#file_scorm_adl12.java ADL 1.2 Test Script] ''(Please note - this is a temporary URL for the test script.)''<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> * '''Modify Test Script''' - The current version of the test script does not have support for command line arguments. Thus you need to specify the path to the ADL SCORM test suite and Moodle test site at line numbers - 26 and 27.<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL12''' ''(you can also specify the full path to the scormADL12.java file from your current directory)'' and run the following command - <br /> javac path\to\scormADL12.java<br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; path\to\scormADL12.java<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL12;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])'' command to set CLASSPATH will be like -<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL12;C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ----<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner with the command -<br /> java org.junit.runner.JUnitCore scormADL12<br /> <br /> ----<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=28606 2011-07-12T16:09:44Z

<p>Mayank gupta2005: Added documentation to run ADL 1.2 Tests</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Running ADL SCORM Test=<br /> <br /> The ADL SCORM tests can be executed in the following two ways - <br /> * Running from the '''Command Prompt''' or,<br /> * Running directly from '''Eclipse''' IDE (''for Java Developers'').<br /> <br /> ==Environmental Setup==<br /> * '''Install Java''' - If you do not have Java installed on your machine you need to download and install it. You can download it from here - [http://www.java.com/en/download/ Download Java].<br /> * '''Download Selenium''' - After ensuring that you have Java installed on your machine, you next need to download Selenium RC ''(or Remote WebDriver)''. To download Selenium RC ''(or Remote WebDriver)'' you can simply download the '''selenium-server-standalone''' jar file (''selenium-server-standalone-x.x.x.jar'') from here - [http://code.google.com/p/selenium/downloads/list Download Selenium]. Save the jar file in the working directory.<br /> ''In this documentation directory ''C:\ADLTests'' will be considered as the [working-directory] for the tests.<br /> *'''Install Junit''' - Finally, you need to download and install Junit on your machine. To install Junit download the zip file from here - [https://github.com/KentBeck/junit/downloads Download Junit] and extract the zip file in a directory say - ''C:\ADLTests\junit''.<br /> <br /> ----<br /> * ''Eclipse IDE'' - To run the ADL SCORM tests using Eclipse IDE, you need to download Eclipse IDE for Java Developers from here - [http://www.eclipse.org/downloads/ Download Eclipse].<br /> ----<br /> <br /> * '''Install ADL SCORM 1.2 Test Suite''' - Download and install the ADL SCORM 1.2 Conformance Test Suite. You can download the ADL Test suite from here - [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} Download ADL 1.2 Test Suite].<br /> * '''Setup course''' - To test Moodle for ADL SCORM 1.2 Compliance you need to setup a course by following the instructions here - [https://docs.moodle.org/dev/SCORM_1.2_compliance_test_instructions SCORM 1.2 compliance test instructions]. The SCORM 1.2 ''LMSTestCourse'' packages that you need are available here -[http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse01.zip LMSTestCourse01.zip] , [http://www.mayankgupta.beakkon.com/files/downloads/moodle/LMSTestCourse02.zip LMSTestCourse02.zip]. <br /> * '''ADL 1.2 Test Script''' - Download and the save the ADL 1.2 Test script as '''scormADL12.java''' in [working_directory]\ADL12\ . You can download the ADL 1.2 Test script from here - [https://gist.github.com/058a6f6273ce0767ed1f#file_scorm_adl12.java ADL 1.2 Test Script] ''(Please note - this is a temporary URL for the test script.)''<br /> ==Executing the Tests==<br /> To execute the tests from the Command prompt follow the steps below -<br /> * '''Modify Test Script''' - The current version of the test script does not have support for command line arguments. Thus you need to specify the path to the ADL SCORM test suite and Moodle test site at line numbers - 26 and 27.<br /> * '''Compile Test Script''' - To compile the test script open the Command Prompt, change the directory to '''[working_directory]\ADL12''' ''(you can also specify the full path to the scormADL12.java file from your current directory)'' and run the following command - <br /> javac path\to\scormADL12.java<br /> If you get the error - '' 'javac' is not recognized as an internal or external command, operable program or batch file.'' Then you need to specify the full path to the javac.exe executable inside the '''bin''' directory of the Java installation on your machine.<br /> Thus the above compilation command needs to be executed on the command prompt window by specifying the full path to ''javac'' like - <br /> &quot;C:\Program Files\Java\jdk1.6.0_24\bin\javac.exe&quot; path\to\scormADL12.java<br /> * '''Set CLASSPATH''' - In order to execute the Selenium RC and Junit Tests you need to set the class path on the command prompt.<br /> The elements that need to be added in classpath are - Junit class files, scormADL12 class files and Selenium jar class files.<br /> To set the CLASSPATH before executing the tests use the following command - <br /> set CLASSPATH=[working_directory]\junit\junit.jar;[working_directory]\ADL12;[working-directory]\selenium-server-standalone.jar<br /> For instance the actual ''(after replacing [working_directory])' command to set CLASSPATH will be like -<br /> set CLASSPATH=C:\ADLTests\junit\junit4.9b2\junit-4.9b2.jar;C:\ADLTests\ADL12;C:\ADLTests\selenium-server-standalone-2.0.0.jar<br /> ----<br /> * '''Invoke the Runner''' - Finally, to run the tests you need to invoke the Junit runner with the command -<br /> java org.junit.runner.JUnitCore scormADL12<br /> <br /> ----<br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19215 2011-05-05T14:01:42Z

<p>Mayank gupta2005: fixed broken link</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/en/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19214 2011-05-03T23:53:53Z

<p>Mayank gupta2005: Deliverables, Implementation, Schedule, Further reading</p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. The Moodle install need not be on the same Microsoft Windows machine and could be on a remote Linux machine too. <br /> The framework would also provide the ability to schedule or run the SCORM ADL tests automatically between the desired time intervals. On the completion of the tests an HTML page, containing the test's report will be displayed to the user. <br /> <br /> The later part of the project itself involves identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and writing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> ==Project Deliverables==<br /> * Script that downloads the latest Moodle Code from [https://github.com/moodle/moodle GitHub], ugrades the Moodle install ''(if necessary)'' and ''prepares'' it for executing the SCORM ADL tests.<br /> * Script that automates the ADL SCORM 1.2 tests and produces an HTML file with the results of the tests ''(pass/fail)''.<br /> * Script that automates some of the ADL SCORM 2004 tests on Moodle ''(it may not be possible to script all of the 2004 ADL tests due to existing failures)''.<br /> * Documentation for how to install the scripts on a Microsoft Windows machine and have them run on an automated cycle.<br /> * Identifying the issues with SCORM 2004 support in Moodle, reporting them to the Tracker and writing patches for the same.<br /> <br /> =Implementation Details=<br /> The following are the implementation details in breif:<br /> * '''Download and Update''' - The ADL SCORM tests should run on the latest Moodle code. The script using [https://docs.moodle.org/en/CLI CLI] will download the latest Moodle code from GitHub and upgrade the Moodle install ''(if necessary)''.<br /> * '''Add Test Course''' - Set up the users/course/activities required for the tests. This will be done by restoring the Moodle backup file into a ''new''. This will again be implemented using CLI at the time of upgrading the install.<br /> * '''Execute Tests''' - Run the browser based test script. [http://seleniumhq.org/projects/remote-control/ Selenium RC] will be used to write the automated web tests.<br /> * '''Test Completion Report''' - At the end of the tests, the user will be displayed an HTML file with the results of the test ''(pass/fail)''.<br /> * '''Delete Test Course''' - After the tests have been executed, the new course that was added before the execution of test will be deleted.<br /> <br /> =Schedule=<br /> * April 26th - May 29th: Get familiar with the Selenium RC, discuss functionality with mentor.<br /> * 30th May - 5th June: Write script to Download lates code, Upgrade Moodle, Restore and Delete test course.<br /> * 6th - 15th June: Write the automated web tests.<br /> * 16th - 26th June: Reproduce ADL SCORM 1.2 Tests.<br /> * 27th June - 6th July: Reproduce ADL SCORM 2004 Tests.<br /> * 7th - 11 July: Check for regressions and fix issues related with it, if any.<br /> <br /> ''This will be the midterm evaluation target - Script to Download, Upgrade, Restore / Delete Backup, code for Test harness, script for ADL SCORM 1.2 and 2004 tests and preliminary report on regressions issues''. <br /> <br /> * 12th July - 17th July: Check for regressions and fix issues related with it, if any.<br /> * 18th July - 13th August: Test SCORM 2004 packages report bugs in the Tracker and write patches.<br /> * 14th - 19th August: Documentation for installation and configuration of scripts on Windows machine. <br /> ''would be a nice task:'' A developer documentation, to explain the the test harness.<br /> <br /> =Further Reading=<br /> For more information please visit the following links:<br /> * [https://docs.moodle.org/en/Administration_via_command_line Administration via command line]<br /> * [https://docs.moodle.org/en/Development:SCORM_1.2_compliance_test_instructions How to manually run the 1.2 ADL tests]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2&amp;FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&amp;View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} SCORM 1.2 documentation test suite]<br /> * [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/2004%204th%20Edition/Test%20Suite.aspx SCORM 2004 documentation test suite]<br /> * [https://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]<br /> * [https://docs.moodle.org/eb/GSOC/2011 GSoC 2011 - Moodle]<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19213 2011-05-03T05:51:11Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification to be updated soon...''<br /> <br /> <br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. On the completion of the tests a HTML page, containing the test's report will be displayed to the user.<br /> <br /> The later part of the project itself involves adding and identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and providing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19212 2011-05-03T05:50:32Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification page to be updated soon...''<br /> <br /> <br /> <br /> <br /> <br /> =Overview=<br /> ==Abstract==<br /> This document is the specification for SCORM Test Harness, a Google Summer Of Code ''(GSoC)'' 2011 project. The SCORM test harness will allow automatically running the SCORM ADL test on the latest Moodle Code.<br /> <br /> The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/profile.php?id=24152 Helen Foster].<br /> <br /> ==Context==<br /> Currently running the SCORM ADL tests is a ''time consuming'' task and requires a specific environment to be set up. The tests can only run in Internet Explorer. This project aims at setting up an automated testing framework that will allow to automatically run the tests on a Microsoft Windows machine running Internet Explorer 8 or higher. On the completion of the tests a HTML page, containing the test's report will be displayed to the user.<br /> <br /> The later part of the project itself involves adding and identifying the issues with SCORM 2004 support, reporting them to the [http://tracker.moodle.org Tracker] and providing patches for the same. This will help in the ongoing development of providing SCORM 2004 support in Moodle, without breaking compatibility with previous tests.<br /> <br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19211 2011-04-29T02:58:25Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness- GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification coming soon...''<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19210 2011-04-29T02:54:43Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [http://moodle.org/mod/forum/discuss.php?d=174286 Using Moodle: SCORM Test Harness -GSoC]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification coming soon...''<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005 https://docs.moodle.org/dev/index.php?title=SCORM_Test_Harness&diff=19209 2011-04-29T02:50:04Z

<p>Mayank gupta2005: </p> <hr /> <div>{{Infobox Project<br /> |name = SCORM Test Harness<br /> |state = Planning<br /> |tracker = MDL-26912<br /> |discussion = [Using Moodle: SCORM Test Harness - GSoC|http://moodle.org/mod/forum/discuss.php?d=174286]<br /> |assignee = Mayank Gupta<br /> }}<br /> <br /> ''Project specification coming soon...''<br /> <br /> [[Category:SCORM]]</div>

Mayank gupta2005