commit 5a71a12c6ba7c1ba30af945529f30d0ad4429c66 Author: Pedro Verdugo Date: Fri Feb 1 10:48:15 2019 +0100 Updated mod5_quiz_cmd diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbe355 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bfae6f --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Entrega 5: Quiz_Cmd + +Puede descargar este programa al ordenador local, como un fichero ZIP. +El programa puede clonarse también con `git clone ..` (si git está instalado). + +Una vez descargado, se debe entrar en el directorio `PRACTICA_TMPL` (descargado) y completar el programa pedido en el fichero `PRACTICA_TMPL.js` (este fichero esta ya vacío en dicho directorio). +El fichero `PRACTICA_TMPL.js` debe editarse o sustituirse por otro con la solución. +La ejecución del programa-de-test indica que partes del código del fichero `PRACTICA_TMPL.js` se han realizado correctamente y cuales no. + +El programa-de-test se copia, instala y ejecuta con los siguientes comandos: + +```bash +$ ## El .zip del programa-de-test puede descargarse y descomprimirse, o copiarse con: +$ git clone https://github.com/practicas-ging/PRACTICA_TMPL +$ +$ cd PRACTICA_TMPL ## Entrar en el directorio de trabajo de la entrega +$ +$ npm install ## Instala el programa-de-test, que es un paquete npm +$ +$ npm run checks ## Pasa los tests indicando que partes de PRACTICA_TMPL.js +............................. ## están correctamente implementadas y cuales no. +...(realimentación).... +$ +``` + +Los tests pueden pasarse tantas veces como sea necesario. +Incluso con el ejercicio incompleto. +El programa-de-test incluye además un comando para generar el fichero ZIP + +```bash +$ +$ npm run zip ## Este comando comprime los ficheros a entregar como un fichero xx.zip +$ ## El directorio de trabajo contiene ahora el fichero: PRACTICA_TMPL.zip +``` + +El fichero `PRACTICA_TMPL.zip` contiene los ficheros de la practica comprimidos y puede subirse +a la plataforma para su evaluación. \ No newline at end of file diff --git a/cmds.js b/cmds.js new file mode 100644 index 0000000..480f94b --- /dev/null +++ b/cmds.js @@ -0,0 +1,192 @@ + + +const {log, biglog, errorlog, colorize} = require("./out"); + +const model = require('./model'); + + +/** + * Muestra la ayuda. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.helpCmd = rl => { + log("Commandos:"); + log(" h|help - Muestra esta ayuda."); + log(" list - Listar los quizzes existentes."); + log(" show - Muestra la pregunta y la respuesta el quiz indicado."); + log(" add - Añadir un nuevo quiz interactivamente."); + log(" delete - Borrar el quiz indicado."); + log(" edit - Editar el quiz indicado."); + log(" test - Probar el quiz indicado."); + log(" p|play - Jugar a preguntar aleatoriamente todos los quizzes."); + log(" credits - Créditos."); + log(" q|quit - Salir del programa."); + rl.prompt(); +}; + + +/** + * Lista todos los quizzes existentes en el modelo. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.listCmd = rl => { + model.getAll().forEach((quiz, id) => { + log(` [${colorize(id, 'magenta')}]: ${quiz.question}`); + }); + rl.prompt(); +}; + + +/** + * Muestra el quiz indicado en el parámetro: la pregunta y la respuesta. + * + * @param rl Objeto readline usado para implementar el CLI. + * @param id Clave del quiz a mostrar. + */ +exports.showCmd = (rl, id) => { + if (typeof id === "undefined") { + errorlog(`Falta el parámetro id.`); + } else { + try { + const quiz = model.getByIndex(id); + log(` [${colorize(id, 'magenta')}]: ${quiz.question} ${colorize('=>', 'magenta')} ${quiz.answer}`); + } catch(error) { + errorlog(error.message); + } + } + rl.prompt(); +}; + + +/** + * Añade un nuevo quiz al módelo. + * Pregunta interactivamente por la pregunta y por la respuesta. + * + * Hay que recordar que el funcionamiento de la funcion rl.question es asíncrono. + * El prompt hay que sacarlo cuando ya se ha terminado la interacción con el usuario, + * es decir, la llamada a rl.prompt() se debe hacer en la callback de la segunda + * llamada a rl.question. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.addCmd = rl => { + + rl.question(colorize(' Introduzca una pregunta: ', 'red'), question => { + + rl.question(colorize(' Introduzca la respuesta ', 'red'), answer => { + + model.add(question, answer); + log(` ${colorize('Se ha añadido', 'magenta')}: ${question} ${colorize('=>', 'magenta')} ${answer}`); + rl.prompt(); + }); + }); +}; + + +/** + * Borra un quiz del modelo. + * + * @param rl Objeto readline usado para implementar el CLI. + * @param id Clave del quiz a borrar en el modelo. + */ +exports.deleteCmd = (rl, id) => { + if (typeof id === "undefined") { + errorlog(`Falta el parámetro id.`); + } else { + try { + model.deleteByIndex(id); + } catch(error) { + errorlog(error.message); + } + } + rl.prompt(); +}; + + +/** + * Edita un quiz del modelo. + * + * Hay que recordar que el funcionamiento de la funcion rl.question es asíncrono. + * El prompt hay que sacarlo cuando ya se ha terminado la interacción con el usuario, + * es decir, la llamada a rl.prompt() se debe hacer en la callback de la segunda + * llamada a rl.question. + * + * @param rl Objeto readline usado para implementar el CLI. + * @param id Clave del quiz a editar en el modelo. + */ +exports.editCmd = (rl, id) => { + if (typeof id === "undefined") { + errorlog(`Falta el parámetro id.`); + rl.prompt(); + } else { + try { + const quiz = model.getByIndex(id); + + process.stdout.isTTY && setTimeout(() => {rl.write(quiz.question)},0); + + rl.question(colorize(' Introduzca una pregunta: ', 'red'), question => { + + process.stdout.isTTY && setTimeout(() => {rl.write(quiz.answer)},0); + + rl.question(colorize(' Introduzca la respuesta ', 'red'), answer => { + model.update(id, question, answer); + log(` Se ha cambiado el quiz ${colorize(id, 'magenta')} por: ${question} ${colorize('=>', 'magenta')} ${answer}`); + rl.prompt(); + }); + }); + } catch (error) { + errorlog(error.message); + rl.prompt(); + } + } +}; + + +/** + * Prueba un quiz, es decir, hace una pregunta del modelo a la que debemos contestar. + * + * @param rl Objeto readline usado para implementar el CLI. + * @param id Clave del quiz a probar. + */ +exports.testCmd = (rl, id) => { + log('Probar el quiz indicado.', 'red'); + rl.prompt(); +}; + + +/** + * Pregunta todos los quizzes existentes en el modelo en orden aleatorio. + * Se gana si se contesta a todos satisfactoriamente. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.playCmd = rl => { + log('Jugar.', 'red'); + rl.prompt(); +}; + + +/** + * Muestra los nombres de los autores de la práctica. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.creditsCmd = rl => { + log('Autores de la práctica:'); + log('Nombre 1', 'green'); + log('Nombre 2', 'green'); + rl.prompt(); +}; + + +/** + * Terminar el programa. + * + * @param rl Objeto readline usado para implementar el CLI. + */ +exports.quitCmd = rl => { + rl.close(); +}; + diff --git a/main.js b/main.js new file mode 100644 index 0000000..52f0087 --- /dev/null +++ b/main.js @@ -0,0 +1,92 @@ +const readline = require('readline'); + +const {log, biglog, errorlog, colorize} = require("./out"); + +const cmds = require("./cmds"); + + +// Mensaje inicial +biglog('CORE Quiz', 'green'); + + +const rl = readline.createInterface({ + input: process.stdin, + output: process.stdout, + prompt: colorize("quiz > ", 'blue'), + completer: (line) => { + const completions = 'h help add delete edit list test p play credits q quit'.split(' '); + const hits = completions.filter((c) => c.startsWith(line)); + // show all completions if none found + return [hits.length ? hits : completions, line]; + } +}); + +rl.prompt(); + +rl +.on('line', (line) => { + + let args = line.split(" "); + let cmd = args[0].toLowerCase().trim(); + + switch (cmd) { + case '': + rl.prompt(); + break; + + case 'help': + case 'h': + cmds.helpCmd(rl); + break; + + case 'quit': + case 'q': + cmds.quitCmd(rl); + break; + + case 'add': + cmds.addCmd(rl); + break; + + case 'list': + cmds.listCmd(rl); + break; + + case 'show': + cmds.showCmd(rl, args[1]); + break; + + case 'test': + cmds.testCmd(rl, args[1]); + break; + + case 'play': + case 'p': + cmds.playCmd(rl); + break; + + case 'delete': + cmds.deleteCmd(rl, args[1]); + break; + + case 'edit': + cmds.editCmd(rl, args[1]); + break; + + case 'credits': + cmds.creditsCmd(rl); + break; + + default: + log(`Comando desconocido: '${colorize(cmd, 'red')}'`); + log(`Use ${colorize('help', 'green')} para ver todos los comandos disponibles.`); + rl.prompt(); + break; + } +}) +.on('close', () => { + log('Adios!'); + process.exit(0); +}); + + diff --git a/model.js b/model.js new file mode 100644 index 0000000..ffea7c4 --- /dev/null +++ b/model.js @@ -0,0 +1,184 @@ + +const fs = require("fs"); + +// Nombre del fichero donde se guardan las preguntas. +// Es un fichero de texto con el JSON de quizzes. +const DB_FILENAME = "quizzes.json"; + + +// Modelo de datos. +// +// En esta variable se mantienen todos los quizzes existentes. +// Es un array de objetos, donde cada objeto tiene los atributos question +// y answer para guardar el texto de la pregunta y el de la respuesta. +// +// Al arrancar la aplicación, esta variable contiene estas cuatro preguntas, +// pero al final del módulo se llama a load() para la cargar las preguntas +// guardadas en el fichero DB_FILENAME. +let quizzes = [ + { + question: "Capital de Italia", + answer: "Roma" + }, + { + question: "Capital de Francia", + answer: "París" + }, + { + question: "Capital de España", + answer: "Madrid" + }, + { + question: "Capital de Portugal", + answer: "Lisboa" + } +]; + + +/** + * Carga las preguntas guardadas en el fichero. + * + * Este método carga el contenido del fichero DB_FILENAME en la variable + * quizzes. El contenido de ese fichero está en formato JSON. + * La primera vez que se ejecute este método, el fichero DB_FILENAME no + * existe, y se producirá el errro ENOENT. En este caso se salva el + * contenido inicial almacenado en quizzes. + * Si se produce otro tipo de error, se lanza una excepción que abortará + * la ejecución del programa. + */ +const load = () => { + + fs.readFile(DB_FILENAME, (err, data) => { + if (err) { + + // La primera vez no existe el fichero + if (err.code === "ENOENT") { + save(); // valores iniciales + return; + } + throw err; + } + + let json = JSON.parse(data); + + if (json) { + quizzes = json; + } + }); +}; + + +/** + * Guarda las preguntas en el fichero. + * + * Guarda en formatro JSON el valor de quizzes en el fichero DB_FILENAME. + * Si se produce algún tipo de error, se lanza una excepción que abortará + * la ejecución del programa. + */ +const save = () => { + + fs.writeFile(DB_FILENAME, + JSON.stringify(quizzes), + err => { + if (err) throw err; + }); +}; + + +// +/** + * Devuelve el número total de preguntas existentes. + * + * @returns {number} número total de preguntas existentes. + */ +exports.count = () => quizzes.length; + + +/** + * Añade un nuevo quiz. + * + * @param question String con la pregunta. + * @param answer String con la respuesta. + */ +exports.add = (question, answer) => { + + quizzes.push({ + question: (question || "").trim(), + answer: (answer || "").trim() + }); + save(); +}; + + + +/** + * Actualiza el quiz situado en la posicion index. + * + * @param id Clave que identifica el quiz a actualizar. + * @param question String con la pregunta. + * @param answer String con la respuesta. + */ +exports.update = (id, question, answer) => { + + const quiz = quizzes[id]; + if (typeof quiz === "undefined") { + throw new Error(`El valor del parámetro id no es válido.`); + } + quizzes.splice(id, 1, { + question: (question || "").trim(), + answer: (answer || "").trim() + }); + save(); +}; + +/** + * Devuelve todos los quizzes existentes. + * + * Devuelve un clon del valor guardado en la variable quizzes, es decir devuelve un + * objeto nuevo con todas las preguntas existentes. + * Para clonar quizzes se usa stringify + parse. + * + * @returns {any} + */ +exports.getAll = () => JSON.parse(JSON.stringify(quizzes)); + + +/** + * Devuelve un clon del quiz almacenado en la posición dada. + * + * Para clonar el quiz se usa stringify + parse. + * + * @param id Clave que identifica el quiz a devolver. + * + * @returns {question, answer} Devuelve el objeto quiz de la posición dada + */ +exports.getByIndex = id => { + + const quiz = quizzes[id]; + if (typeof quiz === "undefined") { + throw new Error(`El valor del parámetro id no es válido.`); + } + return JSON.parse(JSON.stringify(quiz)); +}; + +// +/** + * Elimina el quiz situado en la posición dada. + * + * @param id Clave que identifica el quiz a borrar. + */ +exports.deleteByIndex = id => { + + const quiz = quizzes[id]; + if (typeof quiz === "undefined") { + throw new Error(`El valor del parámetro id no es válido.`); + } + quizzes.splice(id, 1); + save(); +}; + + +// Carga los quizzes almacenados en el fichero. +load(); + + diff --git a/out.js b/out.js new file mode 100644 index 0000000..84dc590 --- /dev/null +++ b/out.js @@ -0,0 +1,61 @@ +const figlet = require('figlet'); +const chalk = require('chalk'); + + +/** + * Dar color a un string. + * + * @param msg Es string al que hay que dar color. + * @param color El color con el que pintar msg. + * @returns {string} Devuelve el string msg con el color indicado. + */ +const colorize = (msg, color) => { + + if (typeof color !== "undefined") { + msg = chalk[color].bold(msg); + } + return msg; +}; + + +/** + * Escribe un mensaje de log. + * + * @param msg El String a escribir + * @param color Color del texto. + */ +const log = (msg, color) => { + + console.log(colorize(msg, color)); +}; + + +/** + * Escribe un mensaje de log grande. + * + * @param msg Texto a escribir. + * @param color Color del texto. + */ +const biglog = (msg, color) => { + + log(figlet.textSync(msg, { horizontalLayout: 'full' }), color); +}; + + +/** + * Escribe el mensaje de error emsg. + * + * @param emsg Texto del mensaje de error. + */ +const errorlog = (emsg) => { + + console.log(`${colorize("Error", "red")}: ${colorize(colorize(emsg, "red"), "bgYellowBright")}`); +}; + + +exports = module.exports = { + colorize, + log, + biglog, + errorlog +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..cb27fdf --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "quiz", + "version": "1.0.0", + "description": "Practica Quiz", + "main": "main.js", + "scripts": { + "start": "node main.js", + "checks": "node tests/launcher.js", + "zip": "node tests/compress.js mooc_node-mod5_quiz_cmd" + }, + "private": true, + "keywords": [ + "CORE", + "QUIT" + ], + "author": "ging", + "license": "Unlicense", + "dependencies": { + "underscore": "^1.8.3", + "fs-extra": "^6.0.1", + "archiver": "^3.0.0", + "mocha": "^5.2.0", + "chai": "^4.1.2", + "chalk": "^2.3.0", + "figlet": "^1.2.0", + "sequelize": "^4.32.7", + "sqlite3": "^4.0.4" + } +} diff --git a/tests/checks.test.js b/tests/checks.test.js new file mode 100644 index 0000000..21bb17d --- /dev/null +++ b/tests/checks.test.js @@ -0,0 +1,414 @@ +/** + * Corrector para la práctica de cmd + */ + +// IMPORTS +const should = require('chai').should(); +const path = require('path'); +const fs = require('fs-extra'); +const Utils = require('./utils'); +const to = require('./to'); +const child_process = require("child_process"); +const spawn = require("child_process").spawn; + +const path_assignment = path.resolve(path.join(__dirname, "../")); + +// CRITICAL ERRORS +let error_critical = null; + +// CONSTANTS +const T_WAIT = 2; // Time between commands +const T_TEST = 2 * 60; // Time between tests (seconds) + +// HELPERS +const timeout = ms => new Promise(res => setTimeout(res, ms)); + +//TESTS +describe("mooc_node-mod5_quiz_cmd", function () { + + this.timeout(T_TEST * 1000); + + it(`1: Checking that the assignment directory exists...`, async function () { + this.score = 0.34; + this.msg_ok = `Found the directory '${path_assignment}'`; + this.msg_err = `Couldn't find the directory '${path_assignment}'`; + const [error_path, path_ok] = await to(fs.pathExists(path_assignment)); + if (error_path) { + error_critical = this.msg_err; + } + path_ok.should.be.equal(true); + }); + + it(`2: Installing dependencies...`, async function () { + this.score = 0.33; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + this.msg_ok = "Dependencies installed successfully"; + this.msg_err = "Error installing dependencies"; + + // check that package.json exists + const path_json = path.join(path_assignment, 'package.json'); + const [json_nok, json_ok] = await to(fs.pathExists(path_json)); + if (json_nok || !json_ok) { + this.msg_err = `The file '${path_json}' has not been found`; + error_critical = this.msg_err; + } + json_ok.should.be.equal(true); + + // check package.json format + const [error_json, contenido] = await to(fs.readFile(path_json, 'utf8')); + if (error_json) { + this.msg_err = `The file '${path_json}' doesn't have the right format`; + error_critical = this.msg_err; + } + should.not.exist(error_json); + const es_json = Utils.isJSON(contenido); + if (!es_json) { + error_critical = this.msg_err; + } + es_json.should.be.equal(true); + + // run npm install + let error_deps; + try { + child_process.execSync("npm install", {cwd: path_assignment}).toString(); + } catch (error_deps) { + this.msg_err = "Error running 'npm install': " + error_deps; + error_critical = this.msg_err; + console.log(error_deps); + } + should.not.exist(error_deps); + + // inject local figlet + try { + const figdata = "module.exports.textSync = function(text){return text};"; + fs.removeSync(path.join(path_assignment, 'node_modules', 'figlet')); + fs.mkdirSync(path.join(path_assignment, 'node_modules', 'figlet')); + fs.writeFileSync(path.join(path_assignment, 'node_modules', 'figlet', 'index.js'), figdata, { + encoding: 'utf8', + flag: 'w' + }); + } catch (error) { + debug("Error wrapping figlet"); + } + + // replace answers file + [_, path_ok] = await to(fs.move(path.join(path_assignment, 'quizzes.json'), path.join(path_assignment, 'quizzes.original.json'), {"overwrite": true})); + [error_deps, path_ok] = await to(fs.move(path.join(path_assignment, 'tests', 'quizzes.json'), path.join(path_assignment, 'quizzes.json'), {"overwrite": true})); + if (error_deps) { + this.msg_err = "Error copying the answers file: " + error_deps; + error_critical = this.msg_err; + } + should.not.exist(error_deps); + } + }); + + + it(`3: Checking that the file 'quizzes.json' is read. Running 'list'...`, async function () { + this.score = 0.33; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["list"]; + const expected = "Answer Number 1"; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + if (client) { + client.stdin.write(input[0] + "\n"); + } + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`4: Checking that invalid input parameters are detected. Running 'test'...`, async function () { + this.score = 1; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["test"]; + const expected = /error/img; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`5: Checking that right answers are detected. Running 'test 1'...`, async function () { + this.score = 1; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["test 1", "OK"]; + const expected = /\bcorrect/img; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`6: Checking that wrong answers are detected. Running 'test 1'...`, async function () { + this.score = 1; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["test 1", "NOK"]; + const expected = /incorrect/img; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`7: Checking that right answers are detected. Running 'play'...`, async function () { + this.score = 1; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["play", "OK"]; + const expected = /correct/img; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`8: Checking that answers are correctly scored. Running 'play'...`, async function () { + this.score = 1; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["play", "OK"]; + const expected = "/1/"; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`9: Checking that wrong answers are detected. Running 'play'...`, async function () { + this.score = 2; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["play", "NOK"]; + const expected = /incorrect/img; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + it(`10: Checking that the wrong answer ends the game. Running 'play'...`, async function () { + this.score = 2; + if (error_critical) { + this.msg_err = error_critical; + should.not.exist(error_critical); + } else { + const input = ["play", "NOK"]; + const expected = "fin"; + let output = ""; + let error_std = ""; + const client = spawn("node", ["main.js"], {cwd: path_assignment}); + client.on('error', function (data) { + error_std += data + }); + client.stdin.on('data', function (data) { + output += data + }); + client.stdout.on('data', function (data) { + output += data + }); + client.stderr.on('data', function (data) { + error_std += data + }); + await timeout(T_WAIT * 1000); + client.stdin.write(input[0] + "\n"); + await timeout(T_WAIT * 1000); + client.stdin.write(input[1] + "\n"); + await timeout(T_WAIT * 1000); + if (client) { + client.kill(); + } + this.msg_ok = `Found '${expected}' in ${path_assignment}`; + this.msg_err = `Couldn't find '${expected}' in ${path_assignment}\nError:${error_std}\nReceived:${output}`; + error_std.should.be.equal(""); + Utils.search(expected, output).should.be.equal(true); + } + }); + + after("Restoring the original file", async function () { + [error_copy, path_ok] = await to(fs.move(path.join(path_assignment, 'quizzes.original.json'), path.join(path_assignment, 'quizzes.json'), {"overwrite": true})); + }); +}); \ No newline at end of file diff --git a/tests/compress.js b/tests/compress.js new file mode 100644 index 0000000..96fed79 --- /dev/null +++ b/tests/compress.js @@ -0,0 +1,10 @@ +const fs = require('fs'); +const archiver = require('archiver'); + +const output = fs.createWriteStream(__dirname + "/../mooc_node-mod5_quiz_cmd.zip"); +const archive = archiver('zip', { + zlib: { level: 9 } // Sets the compression level. +}); +archive.pipe(output); +archive.glob('*', {"ignore": ['node_modules', 'tests', 'README.md']}); +archive.finalize(); \ No newline at end of file diff --git a/tests/launcher.js b/tests/launcher.js new file mode 100644 index 0000000..417a9e2 --- /dev/null +++ b/tests/launcher.js @@ -0,0 +1,40 @@ +/* + Checker launcher + */ + +const Mocha = require("mocha"); +const assignment_path = "./tests/checks.test.js"; + +let score = 0; +let score_total = 0; + +new Mocha({ + timeout: 60 * 1000, + reporter: function () { + } +}) + .addFile(assignment_path) + .run() + .on('pass', function (test) { + score += test.ctx.score; + score_total += test.ctx.score; + process.stdout.write( + `\nTest: ${test.title} + Score: ${test.ctx.score}/${test.ctx.score} + Remarks: ${test.ctx.msg_ok}\n` + ); + }) + .on('fail', function (test, err) { + if ((test.title.indexOf('"after all" hook')<0) && (test.title.indexOf('"before all" hook')<0)) { + score_total += test.ctx.score; + process.stdout.write( + `\nTest: ${test.title} + Score: 0/${test.ctx.score} + Remarks: ${test.ctx.msg_err}\n`); + } else { + console.error("Launcher Error: " + err); + } + }) + .on('end', function (test) { + process.stdout.write(`Final Result: ${score}/${score_total}`); + }); \ No newline at end of file diff --git a/tests/quizzes.json b/tests/quizzes.json new file mode 100644 index 0000000..66bc1c2 --- /dev/null +++ b/tests/quizzes.json @@ -0,0 +1 @@ +[{"question": "Answer Number 1","answer": "OK"},{"question": "Answer Number 2","answer": "OK"}] \ No newline at end of file diff --git a/tests/to.js b/tests/to.js new file mode 100644 index 0000000..20fb506 --- /dev/null +++ b/tests/to.js @@ -0,0 +1,8 @@ +// to.js + +module.exports = function to(promise) { + return promise.then(data => { + return [null, data]; + }) + .catch(err => [err]); +}; \ No newline at end of file diff --git a/tests/utils.js b/tests/utils.js new file mode 100644 index 0000000..68ecb57 --- /dev/null +++ b/tests/utils.js @@ -0,0 +1,86 @@ +/* + Common utilities for all assignments + */ + +const _ = require("underscore"); +const Utils = {}; + +const REG_URL = /(\b(http|ftp|https|ftps):\/\/[-A-ZáéíóúÁÉÍÓÚ0-9+&@#\/%?=~_|!:,.;]*[-A-ZáéíóúÁÉÍÓÚ0-9+&@#\/%=~_|])/ig; + +Utils.getURL = (string) => { + const urls = string.match(REG_URL); + let url = null; + if (urls instanceof Array) { + url = urls[0]; + } + return url; +}; + +Utils.exists = (thing) => { + return !_.isUndefined(thing) && !_.isNull(thing); +}; + +Utils.isString = (thing) => { + return _.isString(thing); +}; + +Utils.isObject = (thing) => { + return _.isObject(thing); +}; + +Utils.isNumber = (thing) => { + let number = false; + if (Utils.exists(thing)) { + number = typeof parseInt(thing) === "number"; + } + return number +}; + +Utils.isArray = (thing) => { + return _.isArray(thing); +}; + +Utils.isURL = (thing) => { + if (Utils.isString(thing)) { + return REG_URL.test(thing); + } +}; + +Utils.isRegExp = (thing) => { + return (thing instanceof RegExp); +}; + +Utils.isJSON = (thing) => { + try { + JSON.parse(thing); + return true; + } catch (e) { + return false; + } +}; + +Utils.search = (b, a) => { + if (Utils.isRegExp(b)) { + if (Utils.isString(a) && a.length > 0) { + return b.test(a); + } else { + return false; + } + } else { + if (Utils.isArray(a)) { + let result = false; + for (let item in a) { + if (Utils.search(b, a[item])) { + result = true; + } + } + return result; + } else { + if (Utils.isString(a.toString())) { + return (a.toLowerCase().indexOf(b.toLowerCase()) > -1); + } + } + } +} + +module.exports = Utils; \ No newline at end of file