diff --git a/.gitignore b/.gitignore index 5ddd5cba48d9a98a06a1f957a7bcdadee296cce6..d30fcd4b531e90eeb63a8246bfd7d4261ac3f697 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ # Build files +build cmake-build-debug docs @@ -63,3 +64,4 @@ docs .idea/**/dynamic.xml .idea/**/uiDesigner.xml .idea/**/dbnavigator.xml +.idea/**/markdown-* diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 43a618b00b7c767591edd5a8adefea26f455289a..e1d4353524db193088abb502e90d4887ecffd6c1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,4 +1,4 @@ -image: rikorose/gcc-cmake +image: lycantropos/cmake stages: - build @@ -6,16 +6,19 @@ stages: before_script: - g++ --version + - cat /etc/*-release build: stage: build variables: GIT_SUBMODULE_STRATEGY: normal + GCC_COLORS: "error=31;1:warning=35;1:note=36;1:range1=32:range2=34:locus=39;1:quote=39;1:fixit-insert=32:fixit-delete=31:diff-filename=39;1:diff-hunk=32:diff-delete=31:diff-insert=32:type-diff=32;1" + CLICOLOR_FORCE: 1 # Necessary for cmake to output colours script: - - cmake . -DCMAKE_CXX_FLAGS="-Werror" + - cmake . -DCMAKE_CXX_FLAGS="-Werror -fdiagnostics-color=always" - make -j4 - make clean - - cmake . -DCMAKE_CXX_FLAGS="-Wall -Wextra" # Build again, but with more warnings + - cmake . -DCMAKE_CXX_FLAGS="-Wall -Wextra -fdiagnostics-color=always" # Build again, but with more warnings - make -j4 tests: @@ -38,7 +41,7 @@ cppcheck: - apt-get update -qq && apt-get install -y -qq cppcheck - cppcheck --version script: - - bash -x ci/cppcheck.sh + - ci/cppcheck.sh vera: stage: build @@ -47,12 +50,18 @@ vera: - vera++ --version - cp ci/vera.profile /usr/lib/vera++/profiles/custom script: - - bash -x ci/vera.sh + - ci/vera.sh clang-tidy: stage: build + variables: + GIT_SUBMODULE_STRATEGY: normal + TERM: xterm-color before_script: - - apt-get update -qq && apt-get install -y -qq clang-tidy-4.0 - - clang-tidy-4.0 --version + # Installing the `sid` repository to get the latest version of clang + - echo deb http://deb.debian.org/debian sid main > /etc/apt/sources.list + - apt-get update -qq && apt-get -t sid install -y -qq clang-tidy-7 + - clang-tidy-7 --version script: - - bash -x ci/clang-tidy.sh + # Running with `script` to give clang a tty so that it outputs colours + - script -c "bash -x ci/clang-tidy.sh" diff --git a/CMakeLists.txt b/CMakeLists.txt index d9e456e694733af386d637fdc9dda03397959904..2bed5291f564a84555fd204b4101274dd17a03b6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -17,7 +17,8 @@ add_custom_target(check add_library(common OBJECT src/ErrorHandler.cpp src/Message.cpp - src/MessageParser.cpp + src/MessageParser.cpp + src/ServicePool.cpp src/Helpers/CRCHelper.cpp src/Helpers/TimeHelper.cpp src/Services/EventReportService.cpp @@ -26,13 +27,15 @@ add_library(common OBJECT src/Services/RequestVerificationService.cpp src/Services/TestService.cpp src/Services/TimeManagementService.cpp + src/Services/EventActionService.cpp ) # Specify the .cpp files for the executables +file(GLOB x86_main_SRC "src/Platform/x86/*.cpp") add_executable(ecss_services src/main.cpp $<TARGET_OBJECTS:common> - src/Platform/x86/Service.cpp + ${x86_main_SRC} ) IF (EXISTS "${PROJECT_SOURCE_DIR}/lib/Catch2/CMakeLists.txt") @@ -44,6 +47,7 @@ IF (EXISTS "${PROJECT_SOURCE_DIR}/lib/Catch2/CMakeLists.txt") add_executable(tests $<TARGET_OBJECTS:common> ${test_main_SRC} - ${test_SRC}) + ${test_SRC} + ) target_link_libraries(tests Catch2::Catch2) ENDIF () diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..f288702d2fa16d3cdf0035b15a9fcbc552cd88e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md index bf33de470d3c50fca511a0c9f3db9ecabf0c55bf..aab7c0ca428d51dcb3da71ce72b472023af475a1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # ECSS-E-ST-40-71C Services +In this repository you can find the implementation of the ECSS services, based on the ECSS-E-ST-40-71C standard. + +## Directories +- **ci**: GitLab CI configuration files +- **inc**: All headers and libraries used in the code +- **lib**: External libraries used in the code +- **src**: All source files are included here +- **test**: Unit test implementation + +## Documentation +Full documentation about this project based on code comments is available at https://helit.org/ecss-docs/docs/html/. \ No newline at end of file diff --git a/ci/.clang-tidy b/ci/.clang-tidy index 6114218612a520f187515cdc7631f09629fa8b84..d6611e01ed1e46f65632ddbbfa2814514c8367c8 100644 --- a/ci/.clang-tidy +++ b/ci/.clang-tidy @@ -1,9 +1,10 @@ --- Checks: > - clang-diagnostic-*, + -clang-diagnostic-error, clang-analyzer-*, bugprone-*, - cppcoreguidelines-*,-cppcoreguidelines-no-malloc,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-bounds-constant-array-index, + cert-*, + cppcoreguidelines-*,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-bounds-constant-array-index, misc-*,-misc-non-private-member-variables-in-classes, fuchsia-multiple-inheritance, google-*,-google-readability-todo, @@ -17,8 +18,9 @@ Checks: > -misc-non-private-member-variables-in-classes, performance-*, readability-*, -WarningsAsErrors: '*,-misc-unused-parameters,-llvm-header-guard,-cppcoreguidelines-pro-type-member-init,-google-runtime-references,-clang-diagnostic-tautological-constant-out-of-range-compare,-readability-redundant-declaration' -HeaderFilterRegex: '.*' + zircon-* +WarningsAsErrors: '*,-misc-unused-parameters,-llvm-header-guard,-cppcoreguidelines-pro-type-member-init,-google-runtime-references,-clang-diagnostic-tautological-constant-out-of-range-compare,-readability-redundant-declaration',-modernize-use-equals-default,-fuchsia-statically-constructed-objects,-hicpp-signed-bitwise,-cert-err58-cpp',-clang-diagnostic-error,-misc-noexcept-move-constructor' +HeaderFilterRegex: 'ecss-services\/((?!lib\/).)*$' AnalyzeTemporaryDtors: false ... diff --git a/ci/clang-tidy.sh b/ci/clang-tidy.sh index 1e676ce2d6926d700576c3a0fe69bad656c16389..bdff8166981a4312ab0a2c28423a5359af80ad59 100755 --- a/ci/clang-tidy.sh +++ b/ci/clang-tidy.sh @@ -10,5 +10,6 @@ echo -e "\033[0;34mRunning clang-tidy...\033[0m" cd "$(dirname "$0")" -clang-tidy-4.0 `find ../src/ -type f -regextype posix-egrep -regex '.*\.(cpp|hpp|c|h)'` \ - -extra-arg=-fcolor-diagnostics -- -std=c++14 -I../inc +clang-tidy-7 `find ../src/ -type f -regextype posix-egrep -regex '.*\.(cpp|hpp|c|h)'` \ + -extra-arg=-fcolor-diagnostics -- -std=c++17 -I../inc \ + -I/usr/include/c++/7/ -I/usr/include/x86_64-linux-gnu/c++/7 -I../lib/etl/include diff --git a/ci/vera.profile b/ci/vera.profile index 4da7dae75b571530a062c8453ffa0f3c6a89781e..2382359f944d16804f95c08abf35c78c0d758ae8 100644 --- a/ci/vera.profile +++ b/ci/vera.profile @@ -9,7 +9,6 @@ set rules { L006 T001 T002 - T003 T004 T005 T006 diff --git a/doxygen.conf b/doxygen.conf index 0898937f9a1208405c1f6dbdb1148d1c3a795906..4dc3effc360ce57b2ee5b120aa7a03c25188f54e 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -187,7 +187,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If @@ -435,7 +435,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -515,7 +515,7 @@ HIDE_IN_BODY_DOCS = NO # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. -INTERNAL_DOCS = NO +INTERNAL_DOCS = YES # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also @@ -873,7 +873,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = lib # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -1478,7 +1478,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. @@ -2331,7 +2331,7 @@ INCLUDED_BY_GRAPH = YES # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -CALL_GRAPH = NO +CALL_GRAPH = YES # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller # dependency graph for every global function or class method. @@ -2376,7 +2376,7 @@ DIRECTORY_GRAPH = YES # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_IMAGE_FORMAT = png +DOT_IMAGE_FORMAT = svg # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. @@ -2388,7 +2388,7 @@ DOT_IMAGE_FORMAT = png # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = NO +INTERACTIVE_SVG = YES # The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. diff --git a/inc/ErrorHandler.hpp b/inc/ErrorHandler.hpp index 1395c0b6d3750ea072ccb75f16be1d94d8cea343..e8622616c6245a924edacc4df2bc71a5a52c1254 100644 --- a/inc/ErrorHandler.hpp +++ b/inc/ErrorHandler.hpp @@ -4,6 +4,8 @@ // Forward declaration of the class, since its header file depends on the ErrorHandler class Message; +#include <stdint.h> // for the uint_8t stepID + /** * A class that handles unexpected software errors, including internal errors or errors due to * invalid & incorrect input data. @@ -13,20 +15,13 @@ class Message; class ErrorHandler { private: /** - * Log the error to a logging facility. Currently, this just displays the error on the screen. - * - * @todo This function MUST be moved as platform-dependent code. Currently, it uses g++ specific - * functions for desktop. + * Log the error to a logging facility. Platform-dependent. */ template<typename ErrorType> static void logError(const Message &message, ErrorType errorType); /** - * Log an error without a Message to a logging facility. Currently, this just displays the error - * on the screen. - * - * @todo This function MUST be moved as platform-dependent code. Currently, it uses g++ specific - * functions for desktop. + * Log an error without a Message to a logging facility. Platform-dependent. */ template<typename ErrorType> static void logError(ErrorType errorType); @@ -51,7 +46,6 @@ public: * A string is larger than the largest allowed string */ StringTooLarge = 4, - /** * An error in the header of a packet makes it unable to be parsed */ @@ -62,7 +56,11 @@ public: * TimeHelper */ InvalidDate = 6, -}; + /** + * Asked a Message type that doesn't exist + */ + UnknownMessageType = 6, + }; /** * The error code for failed acceptance reports, as specified in ECSS 6.1.4.3d @@ -87,7 +85,27 @@ public: /** * Cannot parse a Message, because there is an error in its secondary header */ - UnacceptableMessage = 5, + UnacceptableMessage = 5, + }; + + /** + * The error code for failed start of execution reports, as specified in ECSS 5.3.5.2.3g + * + * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something + * changes. + */ + enum ExecutionStartErrorType { + UnknownExecutionStartError = 0, + }; + + /** + * The error code for failed progress of execution reports, as specified in ECSS 5.3.5.2.3g + * + * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something + * changes. + */ + enum ExecutionProgressErrorType { + UnknownExecutionProgressError = 0, }; /** @@ -96,8 +114,8 @@ public: * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something * changes. */ - enum ExecutionErrorType { - UnknownExecutionError = 0, + enum ExecutionCompletionErrorType { + UnknownExecutionCompletionError = 0, /** * Checksum comparison failed */ @@ -109,7 +127,7 @@ public: }; /** - * The error code for failed completion of execution reports, as specified in ECSS 6.1.3.3d + * The error code for failed routing reports, as specified in ECSS 6.1.3.3d * * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something * changes. @@ -134,7 +152,7 @@ public: * Report a failure and, if applicable, store a failure report message * * @tparam ErrorType The Type struct of the error; can be AcceptanceErrorType, - * ExecutionErrorType, or RoutingErrorType. + * StartExecutionErrorType,CompletionExecutionErrorType, or RoutingErrorType. * @param message The incoming message that prompted the failure * @param errorCode The error's code, as defined in ErrorHandler * @todo See if this needs to include InternalErrorType @@ -142,11 +160,28 @@ public: template<typename ErrorType> static void reportError(const Message &message, ErrorType errorCode); + /** + * Report a failure about the progress of the execution of a request + * + * @note This function is different from reportError, because we need one more \p stepID + * to call the proper function for reporting the progress of the execution of a request + * + * @param message The incoming message that prompted the failure + * @param errorCode The error's code, when a failed progress of the execution of a request + * occurs + * @param stepID If the execution of a request is a long process, then we can divide + * the process into steps. Each step goes with its own definition, the stepID. Each value + * ,that the stepID is assigned, should be documented. + */ + static void reportProgressError(const Message &message, ExecutionProgressErrorType errorCode, + uint8_t stepID); + /** * Report a failure that occurred internally, not due to a failure of a received packet. * * Note that these errors correspond to bugs or faults in the software, and should be treated * differently. Such an error may prompt a task or software reset. + * */ static void reportInternalError(InternalErrorType errorCode); @@ -176,6 +211,35 @@ public: reportError(message, errorCode); } } + + /** + * Convert a parameter given in C++ to an ErrorSource that can be easily used in comparisons. + * @tparam ErrorType One of the enums specified in ErrorHandler. + * @param error An error code of a specific type + * @return The corresponding ErrorSource + */ + template<typename ErrorType> + inline static ErrorSource findErrorSource(ErrorType error) { + // While this may seem like a "hacky" way to convert enums to ErrorSource, it should be + // optimised by the compiler to constant time. + + if (typeid(ErrorType) == typeid(AcceptanceErrorType)) { + return Acceptance; + } + if (typeid(ErrorType) == typeid(ExecutionStartErrorType)) { + return ExecutionStart; + } + if (typeid(ErrorType) == typeid(ExecutionProgressErrorType)) { + return ExecutionProgress; + } + if (typeid(ErrorType) == typeid(ExecutionCompletionErrorType)) { + return ExecutionCompletion; + } + if (typeid(ErrorType) == typeid(RoutingErrorType)) { + return Routing; + } + return Internal; + } }; #endif //PROJECT_ERRORHANDLER_HPP diff --git a/inc/Message.hpp b/inc/Message.hpp index 0d4aa67d8e47cd6ee6045a48015991f93d78bf3d..1b1cca380acb2186f35c7d8525a116e1c9c77dc4 100644 --- a/inc/Message.hpp +++ b/inc/Message.hpp @@ -1,6 +1,7 @@ #ifndef ECSS_SERVICES_PACKET_H #define ECSS_SERVICES_PACKET_H + // Forward declaration of the Message class, needed for the ErrorHandler class Message; @@ -20,6 +21,8 @@ class Message; */ class Message { public: + Message () = default; + enum PacketType { TM = 0, // Telemetry TC = 1 // Telecommand diff --git a/inc/MessageParser.hpp b/inc/MessageParser.hpp index 922ac97d6d284a8b9d433cd85a7c66e77d6d571e..c8c162f0720d1a1e1036eabbd9c038704dce0c58 100644 --- a/inc/MessageParser.hpp +++ b/inc/MessageParser.hpp @@ -1,16 +1,20 @@ #ifndef ECSS_SERVICES_MESSAGEPARSER_HPP #define ECSS_SERVICES_MESSAGEPARSER_HPP +#include <Services/EventActionService.hpp> #include "Message.hpp" /** * A generic class responsible for the execution of the incoming telemetry and telecommand * packets. * + * @todo Make the connection between the ST[01]-request verification service and the services + * that initiate it * @todo Implement the execute function in the upcoming services or generally in the upcoming * activities * */ + class MessageParser { public: @@ -20,6 +24,8 @@ public: * * @todo The implementation of the execute function should correspond to the numbers of the * services/activities that have been created + * @todo execute() needs to be redefined. The /p message isn't enough to call some + * subservices. More arguments are needed. */ void execute(Message &message); @@ -34,6 +40,16 @@ public: */ Message parse(uint8_t *data, uint32_t length); + /** + * @todo: elaborate on this comment + * Create a message so that a string can be parsed + * + * Note: conversion of char* to unsigned char* should flow without any problems according to + * this great analysis: + * stackoverflow.com/questions/15078638/can-i-turn-unsigned-char-into-char-and-vice-versa + */ + Message parseRequestTC(String<ECSS_EVENT_SERVICE_STRING_SIZE> data); + private: /** * Parse the ECSS Telecommand packet secondary header @@ -48,6 +64,17 @@ private: * @param message The Message to modify based on the header */ void parseTC(uint8_t *data, uint16_t length, Message &message); + + /** + * Parse the ECSS Telemetry packet secondary header + * + * As specified in section 7.4.3.1 of the standard + * + * @param data The data of the header (not null-terminated) + * @param length The size of the header + * @param message The Message to modify based on the header + */ + void parseTM(uint8_t *data, uint16_t length, Message &message); }; diff --git a/inc/Service.hpp b/inc/Service.hpp index 0aab624de64f9196d2ddae82ce97d3cb0c738156..09937508303e6a1b19dffca76e68db0266299802 100644 --- a/inc/Service.hpp +++ b/inc/Service.hpp @@ -5,6 +5,8 @@ #include "Message.hpp" #include <iostream> // This file should be removed +class ServicePool; + /** * A spacecraft service, as defined in ECSS-E-ST-70-41C * @@ -17,6 +19,10 @@ class Service { private: uint16_t messageTypeCounter = 0; protected: + /** + * The service type of this Service. For example, ST[12]'s serviceType is `12`. + * Specify this value in the constructor of your service. + */ uint8_t serviceType{}; /** @@ -45,6 +51,40 @@ protected: * this, but this particular function does actually nothing. */ void execute(Message &message); + + /** + * Default protected constructor for this Service + */ + Service() = default; +public: + /** + * @brief Unimplemented copy constructor + * + * Does not allow Services should be copied. There should be only one instance for each Service. + */ + Service (Service const&) = delete; + + /** + * Unimplemented assignment operation + * + * Does not allow changing the instances of Services, as Services are singletons. + */ + void operator=(Service const&) = delete; + + /** + * Default destructor + */ + ~Service() = default; + + /** + * Default move constructor + */ + Service(Service && service) noexcept = default; + + /** + * Default move assignment operator + */ + Service & operator=(Service && service) noexcept = default; }; diff --git a/inc/ServicePool.hpp b/inc/ServicePool.hpp new file mode 100644 index 0000000000000000000000000000000000000000..8a1e6035855eea8b35003ff37047ac4bb1b01f06 --- /dev/null +++ b/inc/ServicePool.hpp @@ -0,0 +1,49 @@ +#ifndef ECSS_SERVICES_SERVICEPOOL_HPP +#define ECSS_SERVICES_SERVICEPOOL_HPP + +#include "Services/RequestVerificationService.hpp" +#include "Services/TimeManagementService.hpp" +#include "Services/EventReportService.hpp" +#include "Services/EventActionService.hpp" +#include "Services/ParameterService.hpp" +#include "Services/TestService.hpp" +#include "Services/MemoryManagementService.hpp" + +/** + * Defines a class that contains instances of all Services. + * + * All Services should be stored here and should not be instantiated in a different way. + * + * @todo Find a way to disable services which are not used + */ +class ServicePool { +public: + RequestVerificationService requestVerification; + EventReportService eventReport; + MemoryManagementService memoryManagement; + TimeManagementService timeManagement; + EventActionService eventAction; + TestService testService; + ParameterService parameterManagement; + + /** + * The default ServicePool constructor + */ + ServicePool() = default; + + /** + * Reset all the services and their contents/properties to the original values + * + * @note This performs the reset in-place, i.e. no new memory is allocated. As such, all + * Services already stored as values will point to the "new" Services after a reset. + */ + void reset(); +}; + +/** + * A global variable that defines the basic pool where services can be fetched from + */ +extern ServicePool Services; + + +#endif //ECSS_SERVICES_SERVICEPOOL_HPP diff --git a/inc/Services/EventActionService.hpp b/inc/Services/EventActionService.hpp new file mode 100644 index 0000000000000000000000000000000000000000..338a67345c0163bb8df8708f784c0b7aae868edc --- /dev/null +++ b/inc/Services/EventActionService.hpp @@ -0,0 +1,126 @@ +#ifndef ECSS_SERVICES_EVENTACTIONSERVICE_HPP +#define ECSS_SERVICES_EVENTACTIONSERVICE_HPP + +#define ECSS_EVENT_SERVICE_STRING_SIZE 64 + +#define ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE 256 + +#include "Service.hpp" +#include "MessageParser.hpp" +#include "etl/String.hpp" +#include <Services/EventReportService.hpp> + +/** + * Implementation of ST[19] event-action Service + * + * ECSS 8.19 && 6.19 + * + * @todo: Use an etl::list instead of eventActionDefinitionArray + * @todo: (Possible) Use a etl::map for eventActionDefinitionArray + * @todo: check if executeAction should accept applicationID too + * @todo: Since there are multiple actions per event and in delete/enable/disable functions are + * multiple instances are accessed, should I find a more efficient way to access them? + * @todo: check if eventActionFunctionStatus should be private or not + * @todo: check if eventAction array of definitions should be private or not + * @todo: check size of eventActionDefinitionArray + */ +class EventActionService : public Service { +private: + + /** + * Event-action function status + */ + bool eventActionFunctionStatus; + + /** + * Custom function that is called right after an event takes place, to initiate + * the execution of the action + */ + void executeAction(uint16_t eventID); + +public: + struct EventActionDefinition { + bool empty = true; + // TODO: APID = 0 is the Ground Station APID. This should be changed + uint16_t applicationId = 0; + uint16_t eventDefinitionID = 65535; + String<64> request = ""; + bool enabled = false; + }; + + friend EventReportService; + + EventActionDefinition eventActionDefinitionArray[ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE]; + + EventActionService() { + serviceType = 19; + eventActionFunctionStatus = true; + } + + /** + * TC[19,1] add event-action definitions + * + * Note: We have abolished multiple additions in one Telecommand packet. Only one + * event-action definition will be added per TC packet. That means there will be just an + * application ID, an event definition ID and the TC request. + */ + void addEventActionDefinitions(Message message); + + /** + * TC[19,2] delete event-action definitions + */ + void deleteEventActionDefinitions(Message message); + + /** + * TC[19,3] delete all event-action definitions + */ + void deleteAllEventActionDefinitions(Message message); + + /** + * TC[19,4] enable event-action definitions + */ + void enableEventActionDefinitions(Message message); + + /** + * TC[19,5] disable event-action definitions + */ + void disableEventActionDefinitions(Message message); + + /** + * TC[19,6] report the status of each event-action definition + */ + void requestEventActionDefinitionStatus(Message message); + + /** + * TM[19,7] event-action status report + */ + void eventActionStatusReport(); + + /** + * TC[19,8] enable the event-action function + */ + void enableEventActionFunction(Message message); + + /** + * TC[19,9] disable the event-actioni function + */ + void disableEventActionFunction(Message message); + + /** + * Setter for event-action function status + */ + void setEventActionFunctionStatus(bool status) { + eventActionFunctionStatus = status; + } + + /** + * Getter for event-action function status + * @return eventActionFunctionStatus + */ + bool getEventActionFunctionStatus(){ + return eventActionFunctionStatus; + } + +}; + +#endif //ECSS_SERVICES_EVENTACTIONSERVICE_HPP diff --git a/inc/Services/EventReportService.hpp b/inc/Services/EventReportService.hpp index 5d17779bf78e0bfa7a59437688e3de938db81ed3..0ecaf179e3468712fe49984cc3287fc643e32ee9 100644 --- a/inc/Services/EventReportService.hpp +++ b/inc/Services/EventReportService.hpp @@ -5,10 +5,9 @@ #include <bitset> /** * Implementation of ST[05] event reporting service - * @todo add enum event definition id (and maybe some appending?) - * - * @todo add more enums event IDs * + * @todo: add more enums event IDs + * @todo: Make sure there isn't an event ID == 0, because there's a confliction with another service * Note: enum IDs are these just for test purposes * */ @@ -102,7 +101,7 @@ public: * @param data the data of the report * @param length the length of the data */ - void informativeEventReport(Event eventID, String<64> data); + void informativeEventReport(Event eventID, const String<64> & data); /** * TM[5,2] low severiity anomaly report @@ -114,7 +113,7 @@ public: * @param data the data of the report * @param length the length of the data */ - void lowSeverityAnomalyReport(Event eventID, String<64> data); + void lowSeverityAnomalyReport(Event eventID, const String<64> & data); /** * TM[5,3] medium severity anomaly report @@ -126,7 +125,7 @@ public: * @param data the data of the report * @param length the length of the data */ - void mediumSeverityAnomalyReport(Event eventID, String<64> data); + void mediumSeverityAnomalyReport(Event eventID, const String<64> & data); /** * TM[5,4] high severity anomaly report @@ -138,7 +137,7 @@ public: * @param data the data of the report * @param length the length of the data */ - void highSeverityAnomalyReport(Event eventID, String<64> data); + void highSeverityAnomalyReport(Event eventID, const String<64> & data); /** * TC[5,5] request to enable report generation diff --git a/inc/Services/RequestVerificationService.hpp b/inc/Services/RequestVerificationService.hpp index a664e1147414260a3ca07118670f58d0869dc28b..683b74d2b0ebe64e5c14021685e13a830b119fa2 100644 --- a/inc/Services/RequestVerificationService.hpp +++ b/inc/Services/RequestVerificationService.hpp @@ -2,6 +2,9 @@ #define ECSS_SERVICES_REQUESTVERIFICATIONSERVICE_HPP #include "Service.hpp" +#include "Message.hpp" +#include "ErrorHandler.hpp" +#include "ECSS_Definitions.hpp" /** * Implementation of the ST[01] request verification service @@ -10,7 +13,6 @@ * should be called, hasn't been implemented yet. In main.cpp there are some random calls with * dummy values. * - * @todo All telemetry packets shall have a telemetry packet secondary header * @todo See if the deduced data defined from the standard should still be ignored. This deduced * data exists only in reports that send failure signs(for example the TM[1,2]) */ @@ -26,7 +28,6 @@ public: * @param request Contains the necessary data to send the report. * The data is actually some data members of Message that contain the basic info * of the telecommand packet that accepted successfully - * */ void successAcceptanceVerification(const Message &request); @@ -36,29 +37,79 @@ public: * @param request Contains the necessary data to send the report. * The data is actually some data members of Message that contain the basic * info of the telecommand packet that failed to be accepted + * @param errorCode The cause of creating this type of report + */ + void failAcceptanceVerification(const Message &request, ErrorHandler::AcceptanceErrorType + errorCode); + + /** + * TM[1,3] successful start of execution verification report + * + * @param request Contains the necessary data to send the report. + * The data is actually some data members of Message that contain the basic info + * of the telecommand packet that its start of execution is successful + */ + void successStartExecutionVerification(const Message &request); + + /** + * TM[1,4] failed start of execution verification report + * + * @param request Contains the necessary data to send the report. + * The data is actually some data members of Message that contain the basic info + * of the telecommand packet that its start of execution has failed + * @param errorCode The cause of creating this type of report + */ + void failStartExecutionVerification(const Message &request, + ErrorHandler::ExecutionStartErrorType + errorCode); + + /** + * TM[1,5] successful progress of execution verification report + * + * @param request Contains the necessary data to send the report. + * The data is actually some data members of Message that contain the basic info + * of the telecommand packet that its progress of execution is successful + * @param stepID If the execution of a request is a long process, then we can divide + * the process into steps. Each step goes with its own definition, the stepID. + * @todo Each value,that the stepID is assigned, should be documented. + * @todo error handling for undocumented assigned values to stepID */ - void failAcceptanceVerification(const Message &request); + void successProgressExecutionVerification(const Message &request, uint8_t stepID); + /** + * TM[1,6] failed progress of execution verification report + * + * @param request Contains the necessary data to send the report. + * The data is actually some data members of Message that contain the basic info + * of the telecommand packet that its progress of execution has failed + * @param errorCode The cause of creating this type of report + * @param stepID If the execution of a request is a long process, then we can divide + * the process into steps. Each step goes with its own definition, the stepID. + * @todo Each value,that the stepID is assigned, should be documented. + * @todo error handling for undocumented assigned values to stepID + */ + void failProgressExecutionVerification(const Message &request, + ErrorHandler::ExecutionProgressErrorType errorCode, uint8_t stepID); /** * TM[1,7] successful completion of execution verification report * * @param request Contains the necessary data to send the report. * The data is actually data members of Message that contain the basic info of the - * telecommand packet that executed successfully - * + * telecommand packet that executed completely and successfully */ - void successExecutionVerification(const Message &request); + void successCompletionExecutionVerification(const Message &request); /** * TM[1,8] failed completion of execution verification report * * @param request Contains the necessary data to send the report. * The data is actually some data members of Message that contain the basic info of the - * telecommand packet that failed to be executed - * + * telecommand packet that failed to be executed completely + * @param errorCode The cause of creating this type of report */ - void failExecutionVerification(const Message &request); + void failCompletionExecutionVerification(const Message &request, + ErrorHandler::ExecutionCompletionErrorType errorCode); /** * TM[1,10] failed routing verification report @@ -66,9 +117,9 @@ public: * @param request Contains the necessary data to send the report. * The data is actually some data members of Message that contain the basic info of the * telecommand packet that failed the routing - * + * @param errorCode The cause of creating this type of report */ - void failRoutingVerification(const Message &request); + void failRoutingVerification(const Message &request, ErrorHandler::RoutingErrorType errorCode); /** * It is responsible to call the suitable function that execute the proper subservice. The @@ -77,15 +128,10 @@ public: * * Note:The functions of this service takes dummy values as arguments for the time being * - * @todo Error handling for the switch() in the implementation of this execute function + * @todo execute() needs to be redefined. The /p message isn't enough to call some + * subservices. More arguments are needed. */ void execute(const Message &message); - - /** - * The purpose of this instance is to access the execute function of this service when a - * MessageParser object is created - */ - static RequestVerificationService instance; }; diff --git a/inc/Services/TestService.hpp b/inc/Services/TestService.hpp index f06be9693ff82a88faa69ae2b4c1f86a5760a2cf..937c1b97888e3ce1eb84f643b0dc34bd110329bc 100644 --- a/inc/Services/TestService.hpp +++ b/inc/Services/TestService.hpp @@ -32,12 +32,6 @@ public: * @todo Error handling for the switch() in the implementation of this execute function */ void execute(Message &message); - - /** - * The purpose of this instance is to access the execute function of this service when a - * MessageParser object is created - */ - static TestService instance; }; diff --git a/lib/Catch2 b/lib/Catch2 index 62460fafe6b54c3173bc5cbc46d05a5f071017ff..d63307279412de3870cf97cc6802bae8ab36089e 160000 --- a/lib/Catch2 +++ b/lib/Catch2 @@ -1 +1 @@ -Subproject commit 62460fafe6b54c3173bc5cbc46d05a5f071017ff +Subproject commit d63307279412de3870cf97cc6802bae8ab36089e diff --git a/src/ErrorHandler.cpp b/src/ErrorHandler.cpp index d689ab1a1835c08c4a2908c6822cd1513b3ac422..b0266ebd7762e9a1b6155f60dffb2016ee23027d 100644 --- a/src/ErrorHandler.cpp +++ b/src/ErrorHandler.cpp @@ -1,56 +1,45 @@ #include <iostream> #include <cxxabi.h> #include <ErrorHandler.hpp> - +#include <ServicePool.hpp> #include "Services/RequestVerificationService.hpp" -// TODO: Use service singleton, as soon as singletons are ready -static RequestVerificationService requestVerificationService; template<> void ErrorHandler::reportError(const Message &message, AcceptanceErrorType errorCode) { - requestVerificationService.failAcceptanceVerification(message); + Services.requestVerification.failAcceptanceVerification(message, errorCode); logError(message, errorCode); } template<> -void ErrorHandler::reportError(const Message &message, ExecutionErrorType errorCode) { - requestVerificationService.failExecutionVerification(message); +void ErrorHandler::reportError(const Message &message, ExecutionStartErrorType errorCode) { + Services.requestVerification.failStartExecutionVerification(message, errorCode); logError(message, errorCode); } -template<> -void ErrorHandler::reportError(const Message &message, RoutingErrorType errorCode) { - requestVerificationService.failRoutingVerification(message); +void ErrorHandler::reportProgressError(const Message &message, ExecutionProgressErrorType +errorCode, uint8_t stepID) { + Services.requestVerification.failProgressExecutionVerification(message, errorCode, stepID); logError(message, errorCode); } -void ErrorHandler::reportInternalError(ErrorHandler::InternalErrorType errorCode) { - logError(UnknownInternalError); +template<> +void ErrorHandler::reportError(const Message &message, ExecutionCompletionErrorType errorCode) { + Services.requestVerification.failCompletionExecutionVerification(message, errorCode); + + logError(message, errorCode); } -template<typename ErrorType> -void ErrorHandler::logError(const Message &message, ErrorType errorType) { - std::cerr - /* - * Gets the error class name from the template - * Note: This is g++-dependent code and should only be used for debugging. - */ - << abi::__cxa_demangle(typeid(ErrorType).name(), nullptr, nullptr, nullptr) - << " Error " << "[" << static_cast<uint16_t>(message.serviceType) << "," << - static_cast<uint16_t>(message.messageType) << "]: " << errorType << std::endl; +template<> +void ErrorHandler::reportError(const Message &message, RoutingErrorType errorCode) { + Services.requestVerification.failRoutingVerification(message, errorCode); + + logError(message, errorCode); } -template<typename ErrorType> -void ErrorHandler::logError(ErrorType errorType) { - std::cerr - /* - * Gets the error class name from the template - * Note: This is g++-dependent code and should only be used for debugging. - */ - << abi::__cxa_demangle(typeid(ErrorType).name(), nullptr, nullptr, nullptr) - << " Error: " << errorType << std::endl; +void ErrorHandler::reportInternalError(ErrorHandler::InternalErrorType errorCode) { + logError(UnknownInternalError); } diff --git a/src/MessageParser.cpp b/src/MessageParser.cpp index fe2426e5d394ca2d63e6036793417267e645ad47..8e18900b8818b9eb0e04669534c898c423786026 100644 --- a/src/MessageParser.cpp +++ b/src/MessageParser.cpp @@ -1,24 +1,23 @@ #include <cstring> +#include <Services/EventActionService.hpp> +#include <ServicePool.hpp> #include "ErrorHandler.hpp" #include "MessageParser.hpp" #include "macros.hpp" #include "Services/TestService.hpp" #include "Services/RequestVerificationService.hpp" -TestService TestService::instance; -RequestVerificationService RequestVerificationService::instance; void MessageParser::execute(Message &message) { switch (message.serviceType) { case 1: - RequestVerificationService::instance.execute(message); + Services.requestVerification.execute(message); break; case 17: - TestService::instance.execute(message); + Services.testService.execute(message); break; default: - // cout is very bad for embedded systems - std::cout << "This service hasn't been implemented yet or it doesn't exist"; + ErrorHandler::reportInternalError(ErrorHandler::UnknownMessageType); break; } } @@ -48,7 +47,7 @@ Message MessageParser::parse(uint8_t *data, uint32_t length) { if (packetType == Message::TC) { parseTC(data + 6, packetDataLength, message); } else { - assert(false); // Not implemented yet + parseTM(data + 6, packetDataLength, message); } return message; @@ -74,3 +73,32 @@ void MessageParser::parseTC(uint8_t *data, uint16_t length, Message &message) { memcpy(message.data, data + 5, length); message.dataSize = length; } + +Message MessageParser::parseRequestTC(String<ECSS_EVENT_SERVICE_STRING_SIZE> data) { + Message message; + auto *dataInt = reinterpret_cast<uint8_t *>(data.data()); + message.packetType = Message::TC; + parseTC(dataInt, ECSS_EVENT_SERVICE_STRING_SIZE, message); + return message; +} + +void MessageParser::parseTM(uint8_t *data, uint16_t length, Message &message) { + ErrorHandler::assertRequest(length >= 5, message, ErrorHandler::UnacceptableMessage); + + // Individual fields of the TM header + uint8_t pusVersion = data[0] >> 4; + uint8_t serviceType = data[1]; + uint8_t messageType = data[2]; + + ErrorHandler::assertRequest(pusVersion == 2, message, ErrorHandler::UnacceptableMessage); + + // Remove the length of the header + length -= 5; + + // Copy the data to the message + // TODO: See if memcpy is needed for this + message.serviceType = serviceType; + message.messageType = messageType; + memcpy(message.data, data + 5, length); + message.dataSize = length; +} diff --git a/src/Platform/x86/ErrorHandler.cpp b/src/Platform/x86/ErrorHandler.cpp new file mode 100644 index 0000000000000000000000000000000000000000..6119440cc09527624c64a4adc517e7d6c551e7ee --- /dev/null +++ b/src/Platform/x86/ErrorHandler.cpp @@ -0,0 +1,40 @@ +/** + * This file specifies the logging utilities for x86 desktop platforms. These logging functions + * just print the error to screen (via stderr). + */ + +#include <iostream> +#include <cxxabi.h> +#include <ErrorHandler.hpp> +#include <Message.hpp> + +// TODO: Find a way to reduce the number of copies of this chunk +template void ErrorHandler::logError(const Message &, ErrorHandler::AcceptanceErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionStartErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionProgressErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionCompletionErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::RoutingErrorType); +template void ErrorHandler::logError(ErrorHandler::InternalErrorType); + +template<typename ErrorType> +void ErrorHandler::logError(const Message &message, ErrorType errorType) { + std::cerr + /* + * Gets the error class name from the template + * Note: This is g++-dependent code and should only be used for debugging. + */ + << abi::__cxa_demangle(typeid(ErrorType).name(), nullptr, nullptr, nullptr) + << " Error " << "[" << static_cast<uint16_t>(message.serviceType) << "," << + static_cast<uint16_t>(message.messageType) << "]: " << errorType << std::endl; +} + +template<typename ErrorType> +void ErrorHandler::logError(ErrorType errorType) { + std::cerr + /* + * Gets the error class name from the template + * Note: This is g++-dependent code and should only be used for debugging. + */ + << abi::__cxa_demangle(typeid(ErrorType).name(), nullptr, nullptr, nullptr) + << " Error: " << errorType << std::endl; +} diff --git a/src/ServicePool.cpp b/src/ServicePool.cpp new file mode 100644 index 0000000000000000000000000000000000000000..f76e2ee77d066b475c0678baec2159ad3dc1a246 --- /dev/null +++ b/src/ServicePool.cpp @@ -0,0 +1,14 @@ +#include "ServicePool.hpp" + +ServicePool Services = ServicePool(); + +void ServicePool::reset() { + // Call the destructor + this->~ServicePool(); + + // Call the constructor + // Note the usage of "placement new" that replaces the contents of the Services variable. + // This is not dangerous usage, since all the memory that will be used for this has been + // statically allocated from before. + new (this) ServicePool(); +} diff --git a/src/Services/EventActionService.cpp b/src/Services/EventActionService.cpp new file mode 100644 index 0000000000000000000000000000000000000000..b61b16dcff7a92cbbeabfe226e983ee6fdc0eee7 --- /dev/null +++ b/src/Services/EventActionService.cpp @@ -0,0 +1,206 @@ +#include "Services/EventActionService.hpp" +#include "Message.hpp" +#include "MessageParser.hpp" + +/** + * @todo: Check if a uint16_t is needed (in case of changing the size of + * eventActionDefinitionArray + */ +void EventActionService::addEventActionDefinitions(Message message) { + // TC[19,1] + + if (message.messageType == 1 && message.packetType == Message::TC && message.serviceType == + 19) { + uint16_t index; + uint16_t applicationID = message.readEnum16(); + uint16_t eventDefinitionID = message.readEnum16(); + bool accepted = true; + for (index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (eventActionDefinitionArray[index].applicationId == applicationID && + eventActionDefinitionArray[index].eventDefinitionID == eventDefinitionID && + eventActionDefinitionArray[index].enabled) { + // @todo: throw a failed start of execution error + accepted = false; + } + } + if (accepted){ + for (index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + // @todo: throw an error if it's full + if (eventActionDefinitionArray[index].empty) { + break; + } + } + if (index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE) { + eventActionDefinitionArray[index].empty = false; + eventActionDefinitionArray[index].enabled = true; + eventActionDefinitionArray[index].applicationId = applicationID; + eventActionDefinitionArray[index].eventDefinitionID = eventDefinitionID; + if (message.dataSize - 4 > ECSS_EVENT_SERVICE_STRING_SIZE) { + ErrorHandler::reportInternalError(ErrorHandler::InternalErrorType::MessageTooLarge); + } else { + char data[ECSS_EVENT_SERVICE_STRING_SIZE]; + message.readString(data, message.dataSize - 4); + eventActionDefinitionArray[index].request = String<ECSS_EVENT_SERVICE_STRING_SIZE>( + data); + } + } + } + } +} + +void EventActionService::deleteEventActionDefinitions(Message message) { + // TC[19,2] + if (message.messageType == 2 && message.packetType == Message::TC && message.serviceType + == 19) { + uint16_t numberOfEventActionDefinitions = message.readUint16(); + for (uint16_t i = 0; i < numberOfEventActionDefinitions; i++) { + uint16_t applicationID = message.readEnum16(); + uint16_t eventDefinitionID = message.readEnum16(); + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (eventActionDefinitionArray[index].applicationId == applicationID && + eventActionDefinitionArray[index].eventDefinitionID == eventDefinitionID && + eventActionDefinitionArray[index].enabled) { + eventActionDefinitionArray[index].empty = true; + eventActionDefinitionArray[index].eventDefinitionID = 65535; + eventActionDefinitionArray[index].request = ""; + eventActionDefinitionArray[index].applicationId = 0; + eventActionDefinitionArray[index].enabled = false; + } + } + } + + } +} + +void EventActionService::deleteAllEventActionDefinitions(Message message) { + // TC[19,3] + if (message.messageType == 3 && message.packetType == Message::TC && message.serviceType + == 19) { + setEventActionFunctionStatus(false); + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (not eventActionDefinitionArray[index].empty) { + eventActionDefinitionArray[index].empty = true; + eventActionDefinitionArray[index].enabled = false; + eventActionDefinitionArray[index].eventDefinitionID = 65535; + eventActionDefinitionArray[index].request = ""; + eventActionDefinitionArray[index].applicationId = 0; + } + } + } +} + +void EventActionService::enableEventActionDefinitions(Message message) { + // TC[19,4] + if (message.messageType == 4 && message.packetType == Message::TC && message.serviceType + == 19) { + uint16_t numberOfEventActionDefinitions = message.readUint16(); + if (numberOfEventActionDefinitions != 0){ + for (uint16_t i = 0; i < numberOfEventActionDefinitions; i++) { + uint16_t applicationID = message.readEnum16(); + uint16_t eventDefinitionID = message.readEnum16(); + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (eventActionDefinitionArray[index].applicationId == applicationID && + eventActionDefinitionArray[index].eventDefinitionID == eventDefinitionID) { + eventActionDefinitionArray[index].enabled = true; + } + } + } + } else { + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (not eventActionDefinitionArray[index].empty){ + eventActionDefinitionArray[index].enabled = true; + } + } + } + } +} + +void EventActionService::disableEventActionDefinitions(Message message) { + // TC[19,5] + if (message.messageType == 5 && message.packetType == Message::TC && message.serviceType + == 19) { + uint16_t numberOfEventActionDefinitions = message.readUint16(); + if (numberOfEventActionDefinitions != 0){ + for (uint16_t i = 0; i < numberOfEventActionDefinitions; i++) { + uint16_t applicationID = message.readEnum16(); + uint16_t eventDefinitionID = message.readEnum16(); + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (eventActionDefinitionArray[index].applicationId == applicationID && + eventActionDefinitionArray[index].eventDefinitionID == eventDefinitionID) { + eventActionDefinitionArray[index].enabled = false; + } + } + } + } else { + for (uint16_t index = 0; index < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; index++) { + if (not eventActionDefinitionArray[index].empty){ + eventActionDefinitionArray[index].enabled = false; + } + } + } + } +} + +void EventActionService::requestEventActionDefinitionStatus(Message message) { + // TC[19,6] + if (message.messageType == 6 && message.packetType == Message::TC && message.serviceType + == 19) { + eventActionStatusReport(); + } +} + +void EventActionService::eventActionStatusReport() { + // TM[19,7] + Message report = createTM(7); + uint8_t count = 0; + for (uint16_t i = 0; i < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; i++) { + if (not eventActionDefinitionArray[i].empty) { + count++; + } + } + report.appendUint8(count); + for (uint16_t i = 0; i < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; i++) { + if (not eventActionDefinitionArray[i].empty) { + report.appendEnum16(eventActionDefinitionArray[i].applicationId); + report.appendEnum16(eventActionDefinitionArray[i].eventDefinitionID); + report.appendBoolean(eventActionDefinitionArray[i].enabled); + } + } + storeMessage(report); +} + +void EventActionService::enableEventActionFunction(Message message) { + // TC[19,8] + if (message.messageType == 8 && message.packetType == Message::TC && message.serviceType + == 19) { + setEventActionFunctionStatus(true); + } +} + +void EventActionService::disableEventActionFunction(Message message) { + // TC[19,9] + if (message.messageType == 9 && message.packetType == Message::TC && message.serviceType + == 19) { + setEventActionFunctionStatus(false); + } +} + +// Should I use the name execute here instead of executeAction? +// Should I use applicationID too? +void EventActionService::executeAction(uint16_t eventID) { + // Custom function + if (eventActionFunctionStatus) { + for (uint16_t i = 0; i < ECSS_EVENT_ACTION_STRUCT_ARRAY_SIZE; i++) { + if (not eventActionDefinitionArray[i].empty && + eventActionDefinitionArray[i].enabled == + true) { + if (eventActionDefinitionArray[i].eventDefinitionID == eventID) { + MessageParser messageParser; + Message message = messageParser.parseRequestTC( + eventActionDefinitionArray[i].request); + messageParser.execute(message); + } + } + } + } +} diff --git a/src/Services/EventReportService.cpp b/src/Services/EventReportService.cpp index f0326119bfd473332673265aa1e6635d7f0477d3..162b4b2349e6f5a14f264d1cf5a027580282c960 100644 --- a/src/Services/EventReportService.cpp +++ b/src/Services/EventReportService.cpp @@ -1,27 +1,29 @@ #include <Services/EventReportService.hpp> -#include "Services/EventReportService.hpp" +#include <Services/EventActionService.hpp> #include "Message.hpp" /** * @todo: Add message type in TCs * @todo: this code is error prone, depending on parameters given, add fail safes (probably?) */ -void EventReportService::informativeEventReport(Event eventID, String<64> data) { +void EventReportService::informativeEventReport(Event eventID, const String<64> & data) { // TM[5,1] - if (stateOfEvents[static_cast<uint16_t> (eventID)] == 1) { + if (stateOfEvents[static_cast<uint16_t> (eventID)]) { Message report = createTM(1); report.appendEnum16(eventID); report.appendString(data); + EventActionService eventActionService; + eventActionService.executeAction(eventID); storeMessage(report); } } void -EventReportService::lowSeverityAnomalyReport(Event eventID, String<64> data) { +EventReportService::lowSeverityAnomalyReport(Event eventID, const String<64> & data) { lowSeverityEventCount++; // TM[5,2] - if (stateOfEvents[static_cast<uint16_t> (eventID)] == 1) { + if (stateOfEvents[static_cast<uint16_t> (eventID)]) { lowSeverityReportCount++; Message report = createTM(2); report.appendEnum16(eventID); @@ -29,13 +31,15 @@ EventReportService::lowSeverityAnomalyReport(Event eventID, String<64> data) { lastLowSeverityReportID = static_cast<uint16_t >(eventID); storeMessage(report); + EventActionService eventActionService; + eventActionService.executeAction(eventID); } } -void EventReportService::mediumSeverityAnomalyReport(Event eventID, String<64> data) { +void EventReportService::mediumSeverityAnomalyReport(Event eventID, const String<64> & data) { mediumSeverityEventCount++; // TM[5,3] - if (stateOfEvents[static_cast<uint16_t> (eventID)] == 1) { + if (stateOfEvents[static_cast<uint16_t> (eventID)]) { mediumSeverityReportCount++; Message report = createTM(3); report.appendEnum16(eventID); @@ -43,14 +47,16 @@ void EventReportService::mediumSeverityAnomalyReport(Event eventID, String<64> d lastMediumSeverityReportID = static_cast<uint16_t >(eventID); storeMessage(report); + EventActionService eventActionService; + eventActionService.executeAction(eventID); } } void -EventReportService::highSeverityAnomalyReport(Event eventID, String<64> data) { +EventReportService::highSeverityAnomalyReport(Event eventID, const String<64> & data) { highSeverityEventCount++; // TM[5,4] - if (stateOfEvents[static_cast<uint16_t> (eventID)] == 1) { + if (stateOfEvents[static_cast<uint16_t> (eventID)]) { highSeverityReportCount++; Message report = createTM(4); report.appendEnum16(eventID); @@ -58,6 +64,8 @@ EventReportService::highSeverityAnomalyReport(Event eventID, String<64> data) { lastHighSeverityReportID = static_cast<uint16_t >(eventID); storeMessage(report); + EventActionService eventActionService; + eventActionService.executeAction(eventID); } } @@ -74,7 +82,7 @@ void EventReportService::enableReportGeneration(Message message) { } if (length <= numberOfEvents) { for (uint16_t i = 0; i < length; i++) { - stateOfEvents[static_cast<uint16_t> (eventID[i])] = 1; + stateOfEvents[static_cast<uint16_t> (eventID[i])] = true; } } disabledEventsCount = stateOfEvents.size() - stateOfEvents.count(); @@ -95,7 +103,7 @@ void EventReportService::disableReportGeneration(Message message) { } if (length <= numberOfEvents) { for (uint16_t i = 0; i < length; i++) { - stateOfEvents[static_cast<uint16_t> (eventID[i])] = 0; + stateOfEvents[static_cast<uint16_t> (eventID[i])] = false; } } disabledEventsCount = stateOfEvents.size() - stateOfEvents.count(); diff --git a/src/Services/RequestVerificationService.cpp b/src/Services/RequestVerificationService.cpp index 0e08b3e71ab47f462a306a8c7c2bde193a68a9dc..768971daf89b7388075adad9f3e6a471b0795e0c 100644 --- a/src/Services/RequestVerificationService.cpp +++ b/src/Services/RequestVerificationService.cpp @@ -1,5 +1,5 @@ #include "Services/RequestVerificationService.hpp" -#include "Message.hpp" + void RequestVerificationService::successAcceptanceVerification(const Message &request) { // TM[1,1] successful acceptance verification report @@ -10,14 +10,15 @@ void RequestVerificationService::successAcceptanceVerification(const Message &re report.appendEnumerated(1, request.packetType); // packet type report.appendBits(1, 0); // secondary header flag(not implemented) report.appendEnumerated(11, request.applicationId); // application process ID - report.appendEnumerated(2, 0); // sequence flags(not implemented) + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags report.appendBits(14, 0); // packet sequence count(not implemented) storeMessage(report); } void -RequestVerificationService::failAcceptanceVerification(const Message &request) { +RequestVerificationService::failAcceptanceVerification(const Message &request, + ErrorHandler::AcceptanceErrorType errorCode) { // TM[1,2] failed acceptance verification report Message report = createTM(2); @@ -26,14 +27,81 @@ RequestVerificationService::failAcceptanceVerification(const Message &request) { report.appendEnumerated(1, request.packetType); // packet type report.appendBits(1, 0); // secondary header flag(not implemented) report.appendEnumerated(11, request.applicationId); // application process ID - report.appendEnumerated(2, 0); // sequence flags(not implemented) + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags + report.appendBits(14, 0); // packet sequence count(not implemented) + report.appendEnum16(errorCode); // error code + + storeMessage(report); +} + +void RequestVerificationService::successStartExecutionVerification(const Message &request) { + // TM[1,3] successful start of execution verification report + + Message report = createTM(3); + + report.appendEnumerated(3, CCSDS_PACKET_VERSION); // packet version number + report.appendEnumerated(1, request.packetType); // packet type + report.appendBits(1, 0); // secondary header flag(not implemented) + report.appendEnumerated(11, request.applicationId); // application process ID + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags + report.appendBits(14, 0); // packet sequence count + + storeMessage(report); +} + +void RequestVerificationService::failStartExecutionVerification(const Message &request, + ErrorHandler::ExecutionStartErrorType errorCode) { + // TM[1,4] failed start of execution verification report + + Message report = createTM(4); + + report.appendEnumerated(3, CCSDS_PACKET_VERSION); // packet version number + report.appendEnumerated(1, request.packetType); // packet type + report.appendBits(1, 0); // secondary header flag(not implemented) + report.appendEnumerated(11, request.applicationId); // application process ID + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags report.appendBits(14, 0); // packet sequence count(not implemented) - report.appendEnum16(0); // error code(not implemented) + report.appendEnum16(errorCode); // error code storeMessage(report); } -void RequestVerificationService::successExecutionVerification(const Message &request) { +void RequestVerificationService::successProgressExecutionVerification(const Message &request, + uint8_t stepID) { + // TM[1,5] successful progress of execution verification report + + Message report = createTM(5); + + report.appendEnumerated(3, CCSDS_PACKET_VERSION); // packet version number + report.appendEnumerated(1, request.packetType); // packet type + report.appendBits(1, 0); // secondary header flag(not implemented) + report.appendEnumerated(11, request.applicationId); // application process ID + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags + report.appendBits(14, 0); // packet sequence count(not implemented) + report.appendByte(stepID); // step ID + + storeMessage(report); +} + +void RequestVerificationService::failProgressExecutionVerification(const Message &request, + ErrorHandler::ExecutionProgressErrorType errorCode, uint8_t stepID) { + // TM[1,6] failed progress of execution verification report + + Message report = createTM(6); + + report.appendEnumerated(3, CCSDS_PACKET_VERSION); // packet version number + report.appendEnumerated(1, request.packetType); // packet type + report.appendBits(1, 0); // secondary header flag(not implemented) + report.appendEnumerated(11, request.applicationId); // application process ID + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags + report.appendBits(14, 0); // packet sequence count(not implemented) + report.appendByte(stepID); // step ID + report.appendEnum16(errorCode); // error code + + storeMessage(report); +} + +void RequestVerificationService::successCompletionExecutionVerification(const Message &request) { // TM[1,7] successful completion of execution verification report Message report = createTM(7); @@ -42,14 +110,15 @@ void RequestVerificationService::successExecutionVerification(const Message &req report.appendEnumerated(1, request.packetType); // packet type report.appendBits(1, 0); // secondary header flag(not implemented) report.appendEnumerated(11, request.applicationId); // application process ID - report.appendEnumerated(2, 0); // sequence flags(not implemented) + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags report.appendBits(14, 0); // packet sequence count(not implemented) storeMessage(report); } void -RequestVerificationService::failExecutionVerification(const Message &request) { +RequestVerificationService::failCompletionExecutionVerification(const Message &request, + ErrorHandler::ExecutionCompletionErrorType errorCode) { // TM[1,8] failed completion of execution verification report Message report = createTM(8); @@ -58,15 +127,16 @@ RequestVerificationService::failExecutionVerification(const Message &request) { report.appendEnumerated(1, request.packetType); // packet type report.appendBits(1, 0); // secondary header flag(not implemented) report.appendEnumerated(11, request.applicationId); // application process ID - report.appendEnumerated(2, 0); // sequence flags(not implemented) + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags report.appendBits(14, 0); // packet sequence count(not implemented) - report.appendEnum16(0); // error code(not implemented) + report.appendEnum16(errorCode); // error code storeMessage(report); } void -RequestVerificationService::failRoutingVerification(const Message &request) { +RequestVerificationService::failRoutingVerification(const Message &request, + ErrorHandler::RoutingErrorType errorCode) { // TM[1,10] failed routing verification report Message report = createTM(10); @@ -75,34 +145,45 @@ RequestVerificationService::failRoutingVerification(const Message &request) { report.appendEnumerated(1, request.packetType); // packet type report.appendBits(1, 0); // secondary header flag(not implemented) report.appendEnumerated(11, request.applicationId); // application process ID - report.appendEnumerated(2, 0); // sequence flags(not implemented) + report.appendEnumerated(2, ECSS_SEQUENCE_FLAGS); // sequence flags report.appendBits(14, 0); // packet sequence count(not implemented) - report.appendEnum16(0); // error code(not implemented) + report.appendEnum16(errorCode); // error code storeMessage(report); } + void RequestVerificationService::execute(const Message &message) { switch (message.messageType) { case 1: successAcceptanceVerification(message); break; - case 2: - failAcceptanceVerification(message); + //case 2: + //failAcceptanceVerification(message); + //break; + case 3: + successStartExecutionVerification(message); break; + //case 4: + //failStartExecutionVerification(message); + //break; + //case 5: + //successProgressExecutionVerification(message); + //break; + //case 6: + //failProgressExecutionVerification(message); + //break; case 7: - successExecutionVerification(message); - break; - case 8: - failExecutionVerification(message); - break; - case 10: - failRoutingVerification(message); + successCompletionExecutionVerification(message); break; + //case 8: + //failCompletionExecutionVerification(message); + //break; + //case 10: + //failRoutingVerification(message); + //break; default: - // cout is very bad for embedded systems - std::cout << "Error: There is not such a message type in ST[01] service"; - assert(false); + ErrorHandler::reportInternalError(ErrorHandler::UnknownMessageType); break; } } diff --git a/src/main.cpp b/src/main.cpp index 7f49b9d59dd818882c6b570e3d8681fc90a6afd0..bdf4914e8cd7903523843bc515b33309e0cccdf2 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,4 +1,5 @@ #include <iostream> +#include <ServicePool.hpp> #include "Helpers/CRCHelper.hpp" #include "Helpers/TimeHelper.hpp" #include "Services/TestService.hpp" @@ -7,6 +8,7 @@ #include "Services/MemoryManagementService.hpp" #include "Services/EventReportService.hpp" #include "Services/TimeManagementService.hpp" +#include "Services/EventActionService.hpp" #include "Message.hpp" #include "MessageParser.hpp" #include "Services/MemoryManagementService.hpp" @@ -34,7 +36,7 @@ int main() { std::cout << packet.readFloat() << " " << std::dec << packet.readSint32() << std::endl; // ST[17] test - TestService testService; + TestService & testService = Services.testService; Message receivedPacket = Message(17, 1, Message::TC, 1); testService.areYouAlive(receivedPacket); receivedPacket = Message(17, 3, Message::TC, 1); @@ -43,7 +45,7 @@ int main() { // ST[20] test - ParameterService paramService; + ParameterService & paramService = Services.parameterManagement; // Test code for reportParameter Message sentPacket = Message(20, 1, Message::TC, 1); //application id is a dummy number (1) @@ -66,12 +68,12 @@ int main() { // ST[06] testing char anotherStr[8] = "Fgthred"; char yetAnotherStr[2] = "F"; - char *pStr = static_cast<char *>(malloc(4)); + char pStr[4]; *pStr = 'T'; *(pStr + 1) = 'G'; *(pStr + 2) = '\0'; - MemoryManagementService memMangService; + MemoryManagementService & memMangService = Services.memoryManagement; Message rcvPack = Message(6, 5, Message::TC, 1); rcvPack.appendEnum8(MemoryManagementService::MemoryID::EXTERNAL); // Memory ID rcvPack.appendUint16(3); // Iteration count @@ -111,22 +113,37 @@ int main() { // ST[01] test - RequestVerificationService reqVerifService; + RequestVerificationService & reqVerifService = Services.requestVerification; Message receivedMessage = Message(1, 1, Message::TC, 3); reqVerifService.successAcceptanceVerification(receivedMessage); receivedMessage = Message(1, 2, Message::TC, 3); - reqVerifService.failAcceptanceVerification(receivedMessage); + reqVerifService.failAcceptanceVerification(receivedMessage, ErrorHandler::UnknownAcceptanceError); + + receivedMessage = Message(1, 3, Message::TC, 3); + reqVerifService.successStartExecutionVerification(receivedMessage); + + receivedMessage = Message(1, 4, Message::TC, 3); + reqVerifService.failStartExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionStartError); + + receivedMessage = Message(1, 5, Message::TC, 3); + reqVerifService.successProgressExecutionVerification(receivedMessage, 0); + + receivedMessage = Message(1, 6, Message::TC, 3); + reqVerifService.failProgressExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionProgressError, 0); receivedMessage = Message(1, 7, Message::TC, 3); - reqVerifService.successExecutionVerification(receivedMessage); + reqVerifService.successCompletionExecutionVerification(receivedMessage); receivedMessage = Message(1, 8, Message::TC, 3); - reqVerifService.failExecutionVerification(receivedMessage); + reqVerifService.failCompletionExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionCompletionError); receivedMessage = Message(1, 10, Message::TC, 3); - reqVerifService.failRoutingVerification(receivedMessage); + reqVerifService.failRoutingVerification(receivedMessage, ErrorHandler::UnknownRoutingError); // ST[05] (5,1 to 5,4) test [works] const char eventReportData[12] = "Hello World"; @@ -154,14 +171,22 @@ int main() { // ST[01] test message = Message(1, 1, Message::TC, 3); messageParser.execute(message); - message = Message(1, 2, Message::TC, 3); + //message = Message(1, 2, Message::TC, 3); + //messageParser.execute(message); + message = Message(1, 3, Message::TC, 3); messageParser.execute(message); + //message = Message(1, 4, Message::TC, 3); + //messageParser.execute(message); + //message = Message(1, 5, Message::TC, 3) + //messageParser.execute(message); + //message = Message(1, 6, Message::TC, 3) + //messageParser.execute(message); message = Message(1, 7, Message::TC, 3); messageParser.execute(message); - message = Message(1, 8, Message::TC, 3); - messageParser.execute(message); - message = Message(1, 10, Message::TC, 3); - messageParser.execute(message); + //message = Message(1, 8, Message::TC, 3); + //messageParser.execute(message); + //message = Message(1, 10, Message::TC, 3); + //messageParser.execute(message); // ErrorHandler test std::cout << std::flush; @@ -173,7 +198,7 @@ int main() { errorMessage.appendByte(15); // ST[09] test - TimeManagementService timeReport; + TimeManagementService & timeReport = Services.timeManagement; struct TimeAndDate timeInfo = {0}; // 10/04/1998 10:15:00 timeInfo.year = 1998; @@ -186,7 +211,7 @@ int main() { // ST[05] (5,5 to 5,8) test [works] EventReportService::Event eventIDs[] = {EventReportService::HighSeverityUnknownEvent, - EventReportService::MediumSeverityUnknownEvent}; + EventReportService::MediumSeverityUnknownEvent}; EventReportService::Event eventIDs2[] = {EventReportService::HighSeverityUnknownEvent}; Message eventMessage(5, 6, Message::TC, 1); eventMessage.appendUint16(2); @@ -203,5 +228,67 @@ int main() { eventReportService.enableReportGeneration(eventMessage2); eventReportService.requestListOfDisabledEvents(eventMessage3); + // ST[19] test + + EventActionService & eventActionService = Services.eventAction; + Message eventActionDefinition(19, 1, Message::TC, 1); + eventActionDefinition.appendEnum16(0); + eventActionDefinition.appendEnum16(2); + String<64> TCdata = "hi"; + eventActionDefinition.appendString(TCdata); + eventActionService.addEventActionDefinitions(eventActionDefinition); + Message eventActionDefinition1(19, 1, Message::TC, 1); + eventActionDefinition1.appendEnum16(0); + eventActionDefinition1.appendEnum16(2); + TCdata = "hi1"; + eventActionDefinition1.appendString(TCdata); + eventActionService.addEventActionDefinitions(eventActionDefinition1); + Message eventActionDefinition2(19, 1, Message::TC, 1); + eventActionDefinition2.appendEnum16(0); + eventActionDefinition2.appendEnum16(3); + TCdata = "hi2"; + eventActionDefinition2.appendString(TCdata); + eventActionService.addEventActionDefinitions(eventActionDefinition2); + Message eventActionDefinition3(19, 5, Message::TC, 1); + eventActionDefinition3.appendUint16(2); + eventActionDefinition3.appendUint16(0); + eventActionDefinition3.appendUint16(2); + eventActionDefinition3.appendUint16(0); + eventActionDefinition3.appendUint16(3); + + eventActionService.disableEventActionDefinitions(eventActionDefinition3); + std::cout << "Status of position 0,1,2 should be 000:" << eventActionService + .eventActionDefinitionArray[0].enabled << eventActionService + .eventActionDefinitionArray[1].enabled << + eventActionService.eventActionDefinitionArray[2].enabled; + + Message eventActionDefinition5(19, 4, Message::TC, 1); + eventActionDefinition5.appendUint16(2); + eventActionDefinition5.appendUint16(0); + eventActionDefinition5.appendUint16(2); + eventActionDefinition5.appendUint16(0); + eventActionDefinition5.appendUint16(3); + eventActionService.enableEventActionDefinitions(eventActionDefinition5); + std::cout << "\nStatus of position 0,1,2 should be 111:" << eventActionService + .eventActionDefinitionArray[0].enabled << eventActionService + .eventActionDefinitionArray[1].enabled << + eventActionService.eventActionDefinitionArray[2].enabled; + + Message eventActionDefinition4(19, 2, Message::TC, 1); + eventActionDefinition4.appendUint16(1); + eventActionDefinition4.appendUint16(0); + eventActionDefinition4.appendUint16(2); + + eventActionService.deleteEventActionDefinitions(eventActionDefinition4); + std::cout << "\nPositions 0,1 empty should be 11:" << static_cast<uint16_t>(eventActionService + .eventActionDefinitionArray[0].empty) + << static_cast<uint16_t>(eventActionService.eventActionDefinitionArray[1].empty); + + Message eventActionDefinition6(19, 3, Message::TC, 1); + eventActionService.deleteAllEventActionDefinitions(eventActionDefinition6); + std::cout << "\nPositions 0,1 empty should be 1:" << static_cast<uint16_t>(eventActionService + .eventActionDefinitionArray[0].empty); + + return 0; } diff --git a/test/ErrorHandler.cpp b/test/ErrorHandler.cpp index e6d4003bc89d40ef363d1a24465e739abd2b7740..eb8be383e89a8ce91686eb0ceddf57c7cd383933 100644 --- a/test/ErrorHandler.cpp +++ b/test/ErrorHandler.cpp @@ -19,14 +19,60 @@ TEST_CASE("Error: Failed Acceptance", "[errors]") { CHECK(report.readBits(1) == static_cast<uint16_t>(Message::TC)); CHECK(report.readBits(1) == false); CHECK(report.readBits(11) == 47); - CHECK(report.readBits(2) == 0); + CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == 0); + CHECK(report.readEnum16() == ErrorHandler::MessageTooShort); +} + +TEST_CASE("Error: Failed Execution Start", "[errors]") { + Message failedMessage(38, 32, Message::TC, 56); + ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownExecutionStartError); + + REQUIRE(ServiceTests::hasOneMessage()); + Message report = ServiceTests::get(0); + + // Check that a TM[1,3] message was returned + CHECK(report.serviceType == 1); + CHECK(report.messageType == 4); + CHECK(report.packetType == Message::TM); + REQUIRE(report.dataSize == 6); + + CHECK(report.readBits(3) == CCSDS_PACKET_VERSION); + CHECK(report.readBits(1) == static_cast<uint16_t>(Message::TC)); + CHECK(report.readBits(1) == false); + CHECK(report.readBits(11) == 56); + CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); + CHECK(report.readBits(14) == failedMessage.packetSequenceCount); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionStartError); +} + +TEST_CASE("Error: Failed Execution Progress", "[errors]") { + Message failedMessage(38, 32, Message::TC, 56); + ErrorHandler::reportProgressError(failedMessage, ErrorHandler::UnknownExecutionProgressError, + 0); + + REQUIRE(ServiceTests::hasOneMessage()); + Message report = ServiceTests::get(0); + + // Check that a TM[1,6] message was returned + CHECK(report.serviceType == 1); + CHECK(report.messageType == 6); + CHECK(report.packetType == Message::TM); + REQUIRE(report.dataSize == 7); + + CHECK(report.readBits(3) == CCSDS_PACKET_VERSION); + CHECK(report.readBits(1) == static_cast<uint16_t>(Message::TC)); + CHECK(report.readBits(1) == false); + CHECK(report.readBits(11) == 56); + CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); + CHECK(report.readBits(14) == failedMessage.packetSequenceCount); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionProgressError); + CHECK(report.readByte() == 0); // stepID } TEST_CASE("Error: Failed Execution Completion", "[errors]") { Message failedMessage(38, 32, Message::TC, 56); - ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownExecutionError); + ErrorHandler::reportError(failedMessage, ErrorHandler::UnknownExecutionCompletionError); REQUIRE(ServiceTests::hasOneMessage()); Message report = ServiceTests::get(0); @@ -41,9 +87,9 @@ TEST_CASE("Error: Failed Execution Completion", "[errors]") { CHECK(report.readBits(1) == static_cast<uint16_t>(Message::TC)); CHECK(report.readBits(1) == false); CHECK(report.readBits(11) == 56); - CHECK(report.readBits(2) == 0); + CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == 0); + CHECK(report.readEnum16() == ErrorHandler::UnknownExecutionCompletionError); } TEST_CASE("Error: Failed Routing", "[errors]") { @@ -63,7 +109,7 @@ TEST_CASE("Error: Failed Routing", "[errors]") { CHECK(report.readBits(1) == static_cast<uint16_t>(Message::TC)); CHECK(report.readBits(1) == false); CHECK(report.readBits(11) == 71); - CHECK(report.readBits(2) == 0); + CHECK(report.readBits(2) == ECSS_SEQUENCE_FLAGS); CHECK(report.readBits(14) == failedMessage.packetSequenceCount); - CHECK(report.readEnum16() == 0); + CHECK(report.readEnum16() == ErrorHandler::UnknownRoutingError); } diff --git a/test/MessageParser.cpp b/test/MessageParser.cpp index 25265d55137c85cdb7fbdbf1796cafb3d6d1f1f5..ccf84c7a3b9ca4ffe2731bc90998827cbd36cbbc 100644 --- a/test/MessageParser.cpp +++ b/test/MessageParser.cpp @@ -16,13 +16,41 @@ TEST_CASE("ST[01] message execution", "[MessageParser][st01]") { CHECK(response.messageType == 1); CHECK(response.packetType == Message::TM); - message = Message(1, 2, Message::TC, 2); + //message = Message(1, 2, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(1); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 2); + //CHECK(response.packetType == Message::TM); + + message = Message(1, 3, Message::TC, 2); messageParser.execute(message); response = ServiceTests::get(1); CHECK(response.serviceType == 1); - CHECK(response.messageType == 2); + CHECK(response.messageType == 3); CHECK(response.packetType == Message::TM); + + //message = Message(1, 4, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(2); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 4); + //CHECK(response.packetType == Message::TM); + + //message = Message(1, 5, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(2); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 5); + //CHECK(response.packetType == Message::TM); + //message = Message(1, 6, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(2); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 6); + //CHECK(response.packetType == Message::TM); + message = Message(1, 7, Message::TC, 2); messageParser.execute(message); response = ServiceTests::get(2); @@ -30,19 +58,19 @@ TEST_CASE("ST[01] message execution", "[MessageParser][st01]") { CHECK(response.messageType == 7); CHECK(response.packetType == Message::TM); - message = Message(1, 8, Message::TC, 2); - messageParser.execute(message); - response = ServiceTests::get(3); - CHECK(response.serviceType == 1); - CHECK(response.messageType == 8); - CHECK(response.packetType == Message::TM); + //message = Message(1, 8, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(3); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 8); + //CHECK(response.packetType == Message::TM); - message = Message(1, 10, Message::TC, 2); - messageParser.execute(message); - response = ServiceTests::get(4); - CHECK(response.serviceType == 1); - CHECK(response.messageType == 10); - CHECK(response.packetType == Message::TM); + //message = Message(1, 10, Message::TC, 2); + //messageParser.execute(message); + //response = ServiceTests::get(4); + //CHECK(response.serviceType == 1); + //CHECK(response.messageType == 10); + //CHECK(response.packetType == Message::TM); } TEST_CASE("ST[17] message execution", "[MessageParser][st17]") { @@ -78,3 +106,21 @@ TEST_CASE("TC message parsing", "[MessageParser]") { CHECK(message.messageType == 31); CHECK(memcmp(message.data, "hello", 5) == 0); } + +TEST_CASE("TC data parsing into a message", "[MessageParser]") { + +} + +TEST_CASE("TM message parsing", "[MessageParser]") { + MessageParser messageParser; + uint8_t packet[] = {0x08, 0x02, 0xc0, 0x4d, 0x00, 0x0c, 0x20, 0x16, 0x11, 0x00, 0x00, 0x68, + 0x65, 0x6c, 0x6c, 0x6f, + 0x68, 0x69}; + Message message = messageParser.parse(packet, 18); + CHECK(message.packetType == Message::TM); + CHECK(message.applicationId == 2); + CHECK(message.dataSize == 7); + CHECK(message.serviceType == 22); + CHECK(message.messageType == 17); + CHECK(memcmp(message.data, "hellohi", 7) == 0); +} diff --git a/test/Services/EventActionService.cpp b/test/Services/EventActionService.cpp new file mode 100644 index 0000000000000000000000000000000000000000..964e8826e64404a08c7c6c544f85c0e69408fa56 --- /dev/null +++ b/test/Services/EventActionService.cpp @@ -0,0 +1,263 @@ +#include <catch2/catch.hpp> +#include <Services/EventActionService.hpp> +#include <Message.hpp> +#include "ServiceTests.hpp" +#include <etl/String.hpp> +#include <cstring> +#include <iostream> +#include <ServicePool.hpp> + +EventActionService & eventActionService = Services.eventAction; + +TEST_CASE("Add event-action definitions TC[19,1]", "[service][st09]") { + char checkstring[256]; + Message message(19, 1, Message::TC, 0); + message.appendEnum16(0); + message.appendEnum16(2); + String<64> data = "123"; + message.appendString(data); + + eventActionService.addEventActionDefinitions(message); + CHECK(eventActionService.eventActionDefinitionArray[0].empty == 0); + CHECK(eventActionService.eventActionDefinitionArray[0].applicationId == 0); + CHECK(eventActionService.eventActionDefinitionArray[0].eventDefinitionID == 2); + CHECK(eventActionService.eventActionDefinitionArray[0].enabled == 1); + CHECK(message.readEnum16() == 0); + CHECK(message.readEnum16() == 2); + message.readString(checkstring, 3); + CHECK(eventActionService.eventActionDefinitionArray[0].request.compare(data) == 0); + + Message message2(19, 1, Message::TC, 0); + message2.appendEnum16(1); + message2.appendEnum16(3); + data = "456"; + message2.appendString(data); + + eventActionService.addEventActionDefinitions(message2); + CHECK(eventActionService.eventActionDefinitionArray[1].empty == 0); + CHECK(eventActionService.eventActionDefinitionArray[1].applicationId == 1); + CHECK(eventActionService.eventActionDefinitionArray[1].eventDefinitionID == 3); + CHECK(eventActionService.eventActionDefinitionArray[1].enabled == 1); + + CHECK(message2.readEnum16() == 1); + CHECK(message2.readEnum16() == 3); + CHECK(eventActionService.eventActionDefinitionArray[1].request.compare(data) == 0); +} + +TEST_CASE("Delete event-action definitions TC[19,2]", "[service][st09]") { + Message message0(19, 1, Message::TC, 0); + message0.appendEnum16(1); + message0.appendEnum16(0); + String<64> data = "0"; + message0.appendString(data); + eventActionService.addEventActionDefinitions(message0); + Message message1(19, 1, Message::TC, 0); + message1.appendEnum16(1); + message1.appendEnum16(1); + data = "1"; + message1.appendString(data); + eventActionService.addEventActionDefinitions(message1); + Message message2(19, 1, Message::TC, 0); + message2.appendEnum16(1); + message2.appendEnum16(2); + data = "2"; + message2.appendString(data); + eventActionService.addEventActionDefinitions(message2); + Message message3(19, 1, Message::TC, 0); + message3.appendEnum16(1); + message3.appendEnum16(3); + data = "3"; + message3.appendString(data); + eventActionService.addEventActionDefinitions(message3); + Message message4(19, 1, Message::TC, 0); + message4.appendEnum16(1); + message4.appendEnum16(4); + data = "4"; + message4.appendString(data); + eventActionService.addEventActionDefinitions(message4); + + Message message(19, 2, Message::TC, 0); + message.appendUint16(2); + message.appendEnum16(1); + message.appendEnum16(4); + message.appendEnum16(1); + message.appendEnum16(2); + eventActionService.deleteEventActionDefinitions(message); + + CHECK(eventActionService.eventActionDefinitionArray[0].empty == 0); + CHECK(eventActionService.eventActionDefinitionArray[0].applicationId == 1); + CHECK(eventActionService.eventActionDefinitionArray[0].eventDefinitionID == 0); + CHECK(eventActionService.eventActionDefinitionArray[0].request.compare("0") == 0); + CHECK(eventActionService.eventActionDefinitionArray[0].enabled == 1); + + CHECK(eventActionService.eventActionDefinitionArray[1].empty == 0); + CHECK(eventActionService.eventActionDefinitionArray[1].applicationId == 1); + CHECK(eventActionService.eventActionDefinitionArray[1].eventDefinitionID == 1); + CHECK(eventActionService.eventActionDefinitionArray[1].request.compare("1") == 0); + CHECK(eventActionService.eventActionDefinitionArray[1].enabled == 1); + + CHECK(eventActionService.eventActionDefinitionArray[2].empty == 1); + CHECK(eventActionService.eventActionDefinitionArray[2].applicationId == 0); + CHECK(eventActionService.eventActionDefinitionArray[2].eventDefinitionID == 65535); + CHECK(eventActionService.eventActionDefinitionArray[2].request.compare("") == 0); + CHECK(eventActionService.eventActionDefinitionArray[2].enabled == 0); + + CHECK(eventActionService.eventActionDefinitionArray[3].empty == 0); + CHECK(eventActionService.eventActionDefinitionArray[3].applicationId == 1); + CHECK(eventActionService.eventActionDefinitionArray[3].eventDefinitionID == 3); + CHECK(eventActionService.eventActionDefinitionArray[3].request.compare("3") == 0); + CHECK(eventActionService.eventActionDefinitionArray[3].enabled == 1); + + CHECK(eventActionService.eventActionDefinitionArray[4].empty == 1); + CHECK(eventActionService.eventActionDefinitionArray[4].applicationId == 0); + CHECK(eventActionService.eventActionDefinitionArray[4].eventDefinitionID == 65535); + CHECK(eventActionService.eventActionDefinitionArray[4].request.compare("") == 0); + CHECK(eventActionService.eventActionDefinitionArray[4].enabled == 0); + +} + +TEST_CASE("Delete all event-action definitions TC[19,3]", "[service][st09]") { + Message message0(19, 1, Message::TC, 0); + message0.appendEnum16(1); + message0.appendEnum16(0); + String<64> data = "0"; + message0.appendString(data); + eventActionService.addEventActionDefinitions(message0); + Message message1(19, 1, Message::TC, 0); + message1.appendEnum16(1); + message1.appendEnum16(1); + data = "1"; + message1.appendString(data); + eventActionService.addEventActionDefinitions(message1); + Message message2(19, 1, Message::TC, 0); + message2.appendEnum16(1); + message2.appendEnum16(2); + data = "2"; + message2.appendString(data); + eventActionService.addEventActionDefinitions(message2); + Message message3(19, 1, Message::TC, 0); + message3.appendEnum16(1); + message3.appendEnum16(3); + data = "3"; + message3.appendString(data); + eventActionService.addEventActionDefinitions(message3); + Message message4(19, 1, Message::TC, 0); + message4.appendEnum16(1); + message4.appendEnum16(4); + data = "4"; + message4.appendString(data); + eventActionService.addEventActionDefinitions(message4); + + Message message(19, 3, Message::TC, 0); + eventActionService.deleteAllEventActionDefinitions(message); + + for (int i = 0; i < 256; i++){ + CHECK(eventActionService.eventActionDefinitionArray[i].empty == 1); + CHECK(eventActionService.eventActionDefinitionArray[i].applicationId == 0); + CHECK(eventActionService.eventActionDefinitionArray[i].eventDefinitionID == 65535); + CHECK(eventActionService.eventActionDefinitionArray[i].request.compare("") == 0); + } +} + +TEST_CASE("Enable event-action definitions TC[19,4]", "[service][st09]") { + Message message0(19, 1, Message::TC, 0); + message0.appendEnum16(1); + message0.appendEnum16(0); + String<64> data = "0"; + message0.appendString(data); + eventActionService.addEventActionDefinitions(message0); + Message message1(19, 1, Message::TC, 0); + message1.appendEnum16(1); + message1.appendEnum16(1); + data = "00"; + message1.appendString(data); + eventActionService.addEventActionDefinitions(message1); + Message message2(19, 4, Message::TC, 0); + message2.appendUint16(2); + message2.appendEnum16(1); + message2.appendEnum16(0); + message2.appendEnum16(1); + message2.appendEnum16(1); + eventActionService.enableEventActionDefinitions(message2); + CHECK(eventActionService.eventActionDefinitionArray[0].enabled == 1); + CHECK(eventActionService.eventActionDefinitionArray[1].enabled == 1); + +} + +TEST_CASE("Disable event-action definitions TC[19,5]", "[service][st09]") { + Message message0(19, 1, Message::TC, 0); + message0.appendEnum16(1); + message0.appendEnum16(0); + String<64> data = "0"; + message0.appendString(data); + eventActionService.addEventActionDefinitions(message0); + Message message1(19, 1, Message::TC, 0); + message1.appendEnum16(1); + message1.appendEnum16(0); + data = "00"; + message1.appendString(data); + eventActionService.addEventActionDefinitions(message1); + Message message2(19, 5, Message::TC, 0); + message2.appendUint16(1); + message2.appendEnum16(1); + message2.appendEnum16(0); + eventActionService.disableEventActionDefinitions(message2); + CHECK(eventActionService.eventActionDefinitionArray[0].enabled == 0); + CHECK(eventActionService.eventActionDefinitionArray[1].enabled == 0); +} + +TEST_CASE("Request event-action definition status TC[19,6]", "[service][st09]") { + Message message(19, 6, Message::TC, 0); + eventActionService.requestEventActionDefinitionStatus(message); + REQUIRE(ServiceTests::hasOneMessage()); + + Message report = ServiceTests::get(0); + CHECK(report.messageType == 7); +} + +TEST_CASE("Event-action status report TM[19,7]", "[service][st09]") { + Message message0(19, 1, Message::TC, 0); + message0.appendEnum16(1); + message0.appendEnum16(0); + String<64> data = "0"; + message0.appendString(data); + eventActionService.addEventActionDefinitions(message0); + Message message1(19, 1, Message::TC, 0); + message1.appendEnum16(1); + message1.appendEnum16(2); + data = "2"; + message1.appendString(data); + eventActionService.addEventActionDefinitions(message1); + Message message2(19, 5, Message::TC, 0); + message2.appendUint16(1); + message2.appendEnum16(1); + message2.appendEnum16(0); + eventActionService.disableEventActionDefinitions(message2); + eventActionService.eventActionStatusReport(); + REQUIRE(ServiceTests::hasOneMessage()); + + Message report = ServiceTests::get(0); + CHECK(report.readUint8() == 2); + CHECK(report.readEnum16() == 1); + CHECK(report.readEnum16() == 0); + CHECK(report.readUint8() == 0); + CHECK(report.readEnum16() == 1); + CHECK(report.readEnum16() == 2); + CHECK(report.readUint8() == 1); +} + +TEST_CASE("Enable event-action function TC[19,8]", "[service][st09]") { + Message message(19, 8, Message::TC, 0); + eventActionService.enableEventActionFunction(message); + CHECK(eventActionService.getEventActionFunctionStatus() == true); +} + +TEST_CASE("Disable event-action function TC[19,9]", "[service][st09]") { + Message message(19, 9, Message::TC, 0); + eventActionService.disableEventActionFunction(message); + CHECK(eventActionService.getEventActionFunctionStatus() == false); +} + +TEST_CASE("Execute a TC request", "[service][st09]"){ + +} diff --git a/test/Services/EventReportService.cpp b/test/Services/EventReportService.cpp index 0bf8133a30947c79942c360fc9f4db86c98c0143..2d76b5cc08511ce8c292b3aca2de8823ea0c12a6 100644 --- a/test/Services/EventReportService.cpp +++ b/test/Services/EventReportService.cpp @@ -4,11 +4,12 @@ #include "ServiceTests.hpp" #include <cstring> +EventReportService & eventReportService = Services.eventReport; + /* - * @todo Change the reinterpret_cast + * @todo: Change the reinterpret_cast */ TEST_CASE("Informative Event Report TM[5,1]", "[service][st05]") { - EventReportService eventReportService; const char eventReportData[] = "HelloWorld"; char checkString[255]; eventReportService.informativeEventReport(EventReportService::InformativeUnknownEvent, @@ -28,7 +29,6 @@ TEST_CASE("Informative Event Report TM[5,1]", "[service][st05]") { } TEST_CASE("Low Severity Anomaly Report TM[5,2]", "[service][st05]") { - EventReportService eventReportService; const char eventReportData[] = "HelloWorld"; char checkString[255]; eventReportService.lowSeverityAnomalyReport(EventReportService::LowSeverityUnknownEvent, @@ -48,7 +48,6 @@ TEST_CASE("Low Severity Anomaly Report TM[5,2]", "[service][st05]") { } TEST_CASE("Medium Severity Anomaly Report TM[5,3]", "[service][st05]") { - EventReportService eventReportService; const char eventReportData[] = "HelloWorld"; char checkString[255]; eventReportService.mediumSeverityAnomalyReport @@ -68,7 +67,6 @@ TEST_CASE("Medium Severity Anomaly Report TM[5,3]", "[service][st05]") { } TEST_CASE("High Severity Anomaly Report TM[5,4]", "[service][st05]") { - EventReportService eventReportService; const char eventReportData[] = "HelloWorld"; char checkString[255]; eventReportService.highSeverityAnomalyReport(EventReportService::HighSeverityUnknownEvent, @@ -88,7 +86,6 @@ TEST_CASE("High Severity Anomaly Report TM[5,4]", "[service][st05]") { } TEST_CASE("Enable Report Generation TC[5,5]", "[service][st05]") { - EventReportService eventReportService; eventReportService.getStateOfEvents().reset(); EventReportService::Event eventID[] = {EventReportService::AssertionFail, EventReportService::LowSeverityUnknownEvent}; @@ -102,7 +99,6 @@ TEST_CASE("Enable Report Generation TC[5,5]", "[service][st05]") { } TEST_CASE("Disable Report Generation TC[5,6]", "[service][st05]") { - EventReportService eventReportService; EventReportService::Event eventID[] = {EventReportService::InformativeUnknownEvent, EventReportService::MediumSeverityUnknownEvent}; Message message(5, 6, Message::TC, 1); @@ -120,7 +116,6 @@ TEST_CASE("Disable Report Generation TC[5,6]", "[service][st05]") { } TEST_CASE("Request list of disabled events TC[5,7]", "[service][st05]") { - EventReportService eventReportService; Message message(5, 7, Message::TC, 1); eventReportService.requestListOfDisabledEvents(message); REQUIRE(ServiceTests::hasOneMessage()); @@ -131,7 +126,6 @@ TEST_CASE("Request list of disabled events TC[5,7]", "[service][st05]") { } TEST_CASE("List of Disabled Events Report TM[5,8]", "[service][st05]") { - EventReportService eventReportService; EventReportService::Event eventID[] = {EventReportService::MCUStart, EventReportService::HighSeverityUnknownEvent}; Message message(5, 6, Message::TC, 1); @@ -156,7 +150,6 @@ TEST_CASE("List of Disabled Events Report TM[5,8]", "[service][st05]") { } TEST_CASE("List of observables 6.5.6", "[service][st05]") { - EventReportService eventReportService; EventReportService::Event eventID[] = {EventReportService::HighSeverityUnknownEvent}; Message message(5, 6, Message::TC, 1); message.appendUint16(1); diff --git a/test/Services/MemoryManagementService.cpp b/test/Services/MemoryManagementService.cpp index 64b0181f904a8d53845d43019c6dc9f579b41b9b..ec1ef2d5c0e4094d1905ad3ebfcc342d5adef396 100644 --- a/test/Services/MemoryManagementService.cpp +++ b/test/Services/MemoryManagementService.cpp @@ -4,6 +4,8 @@ #include "ServiceTests.hpp" #include "Helpers/CRCHelper.hpp" +MemoryManagementService & memMangService = Services.memoryManagement; + TEST_CASE("TM[6,2]", "[service][st06]") { // Required test variables char *pStr = static_cast<char *>(malloc(4)); @@ -12,8 +14,6 @@ TEST_CASE("TM[6,2]", "[service][st06]") { *(pStr + 2) = '\0'; uint8_t data[2] = {'h', 'R'}; - MemoryManagementService memMangService; - Message receivedPacket = Message(6, 2, Message::TC, 1); receivedPacket.appendEnum8(MemoryManagementService::MemoryID::EXTERNAL); // Memory ID receivedPacket.appendUint16(2); // Iteration count diff --git a/test/Services/ParameterService.cpp b/test/Services/ParameterService.cpp index dbf1820b51e3d1d13f13f70e5f3eb7e139289894..28f59a40837d957d87f78bcd29090a5ed5864b1f 100644 --- a/test/Services/ParameterService.cpp +++ b/test/Services/ParameterService.cpp @@ -3,11 +3,9 @@ #include "Message.hpp" #include "ServiceTests.hpp" -#define CATCH_CONFIG_MAIN +ParameterService & pserv = Services.parameterManagement; TEST_CASE("Parameter Report Subservice") { - ParameterService pserv; - SECTION("Faulty Instruction Handling Test") { Message request(20, 1, Message::TC, 1); Message report(20, 2, Message::TM, 1); @@ -42,8 +40,6 @@ TEST_CASE("Parameter Report Subservice") { } TEST_CASE("Parameter Setting Subservice") { - ParameterService pserv; - SECTION("Faulty Instruction Handling Test") { Message setRequest(20, 3, Message::TC, 1); Message reportRequest(20, 1, Message::TC, 1); diff --git a/test/Services/RequestVerificationService.cpp b/test/Services/RequestVerificationService.cpp index 65a256d3d37010317e7b61106beeb2083f7e976e..8464dc5b8eb48cb1dfc1de38c0f4bcd3dfc59a20 100644 --- a/test/Services/RequestVerificationService.cpp +++ b/test/Services/RequestVerificationService.cpp @@ -3,9 +3,9 @@ #include <Message.hpp> #include "ServiceTests.hpp" -TEST_CASE("TM[1,1]", "[service][st01]") { - RequestVerificationService reqVerifService; +RequestVerificationService & reqVerifService = Services.requestVerification; +TEST_CASE("TM[1,1]", "[service][st01]") { Message receivedMessage = Message(1, 1, Message::TC, 3); reqVerifService.successAcceptanceVerification(receivedMessage); REQUIRE(ServiceTests::hasOneMessage()); @@ -22,15 +22,14 @@ TEST_CASE("TM[1,1]", "[service][st01]") { CHECK(response.readEnumerated(1) == Message::TC); // packet type CHECK(response.readBits(1) == 0); // secondary header flag CHECK(response.readEnumerated(11) == 3); // application process ID - CHECK(response.readEnumerated(2) == 0); // sequence flags + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count } TEST_CASE("TM[1,2]", "[service][st01]") { - RequestVerificationService reqVerifService; - Message receivedMessage = Message(1, 2, Message::TC, 3); - reqVerifService.failAcceptanceVerification(receivedMessage); + reqVerifService.failAcceptanceVerification(receivedMessage, + ErrorHandler::UnknownAcceptanceError); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -45,16 +44,105 @@ TEST_CASE("TM[1,2]", "[service][st01]") { CHECK(response.readEnumerated(1) == Message::TC); // packet type CHECK(response.readBits(1) == 0); // secondary header flag CHECK(response.readEnumerated(11) == 3); // application process ID - CHECK(response.readEnumerated(2) == 0); // sequence flags + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count - CHECK(response.readEnum16() == 0); // error code + CHECK(response.readEnum16() == ErrorHandler::UnknownAcceptanceError); // error code } -TEST_CASE("TM[1,7]", "[service][st01]") { - RequestVerificationService reqVerifService; +TEST_CASE("TM[1,3]", "[service][st01]") { + Message receivedMessage = Message(1, 3, Message::TC, 3); + reqVerifService.successStartExecutionVerification(receivedMessage); + REQUIRE(ServiceTests::hasOneMessage()); + Message response = ServiceTests::get(0); + // Checks for the data-members of the object response + CHECK(response.serviceType == 1); + CHECK(response.messageType == 3); + CHECK(response.packetType == Message::TM); // packet type + CHECK(response.applicationId == 0); + REQUIRE(response.dataSize == 4); // dataSize is the number of bytes of data array + // Check for the value that is stored in <<data>> array(data-member of object response) + CHECK(response.readEnumerated(3) == CCSDS_PACKET_VERSION); // packet version number + CHECK(response.readEnumerated(1) == Message::TC); // packet type + CHECK(response.readBits(1) == 0); // secondary header flag + CHECK(response.readEnumerated(11) == 3); // application process ID + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags + CHECK(response.readBits(14) == 0); // packet sequence count +} + +TEST_CASE("TM[1,4]", "[service][st01]") { + Message receivedMessage = Message(1, 2, Message::TC, 3); + reqVerifService.failStartExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionStartError); + REQUIRE(ServiceTests::hasOneMessage()); + + Message response = ServiceTests::get(0); + // Checks for the data-members of the object response + CHECK(response.serviceType == 1); + CHECK(response.messageType == 4); + CHECK(response.packetType == Message::TM); // packet type + CHECK(response.applicationId == 0); + REQUIRE(response.dataSize == 6); // dataSize is the number of bytes of data array + // Check for the value that is stored in <<data>> array(data-member of object response) + CHECK(response.readEnumerated(3) == CCSDS_PACKET_VERSION); // packet version number + CHECK(response.readEnumerated(1) == Message::TC); // packet type + CHECK(response.readBits(1) == 0); // secondary header flag + CHECK(response.readEnumerated(11) == 3); // application process ID + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags + CHECK(response.readBits(14) == 0); // packet sequence count + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionStartError); // error code +} + +TEST_CASE("TM[1,5]", "[service][st01]") { + Message receivedMessage = Message(1, 5, Message::TC, 3); + reqVerifService.successProgressExecutionVerification(receivedMessage, 0); + REQUIRE(ServiceTests::hasOneMessage()); + + Message response = ServiceTests::get(0); + // Checks for the data-members of the object response + CHECK(response.serviceType == 1); + CHECK(response.messageType == 5); + CHECK(response.packetType == Message::TM); // packet type + CHECK(response.applicationId == 0); + REQUIRE(response.dataSize == 5); // dataSize is the number of bytes of data array + // Check for the value that is stored in <<data>> array(data-member of object response) + CHECK(response.readEnumerated(3) == CCSDS_PACKET_VERSION); // packet version number + CHECK(response.readEnumerated(1) == Message::TC); // packet type + CHECK(response.readBits(1) == 0); // secondary header flag + CHECK(response.readEnumerated(11) == 3); // application process ID + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags + CHECK(response.readBits(14) == 0); // packet sequence count + CHECK(response.readByte() == 0); // step ID +} + +TEST_CASE("TM[1,6]", "[service][st01]") { + Message receivedMessage = Message(1, 5, Message::TC, 3); + reqVerifService.failProgressExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionProgressError, + 0); + REQUIRE(ServiceTests::hasOneMessage()); + + Message response = ServiceTests::get(0); + // Checks for the data-members of the object response + CHECK(response.serviceType == 1); + CHECK(response.messageType == 6); + CHECK(response.packetType == Message::TM); // packet type + CHECK(response.applicationId == 0); + REQUIRE(response.dataSize == 7); // dataSize is the number of bytes of data array + // Check for the value that is stored in <<data>> array(data-member of object response) + CHECK(response.readEnumerated(3) == CCSDS_PACKET_VERSION); // packet version number + CHECK(response.readEnumerated(1) == Message::TC); // packet type + CHECK(response.readBits(1) == 0); // secondary header flag + CHECK(response.readEnumerated(11) == 3); // application process ID + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags + CHECK(response.readBits(14) == 0); // packet sequence count + CHECK(response.readByte() == 0); // step ID + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionProgressError); +} + +TEST_CASE("TM[1,7]", "[service][st01]") { Message receivedMessage = Message(1, 7, Message::TC, 3); - reqVerifService.successExecutionVerification(receivedMessage); + reqVerifService.successCompletionExecutionVerification(receivedMessage); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -69,15 +157,14 @@ TEST_CASE("TM[1,7]", "[service][st01]") { CHECK(response.readEnumerated(1) == Message::TC); // packet type CHECK(response.readBits(1) == 0); // secondary header flag CHECK(response.readEnumerated(11) == 3); // application process ID - CHECK(response.readEnumerated(2) == 0); // sequence flags + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count } TEST_CASE("TM[1,8]", "[service][st01]") { - RequestVerificationService reqVerifService; - Message receivedMessage = Message(1, 8, Message::TC, 3); - reqVerifService.failExecutionVerification(receivedMessage); + reqVerifService.failCompletionExecutionVerification(receivedMessage, + ErrorHandler::UnknownExecutionCompletionError); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -91,16 +178,14 @@ TEST_CASE("TM[1,8]", "[service][st01]") { CHECK(response.readEnumerated(1) == Message::TC); // packet type CHECK(response.readBits(1) == 0); // secondary header flag CHECK(response.readEnumerated(11) == 3); // application process ID - CHECK(response.readEnumerated(2) == 0); // sequence flags + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count - CHECK(response.readEnum16() == 0); // error code + CHECK(response.readEnum16() == ErrorHandler::UnknownExecutionCompletionError); // error code } TEST_CASE("TM[1,10]", "[service][st01]") { - RequestVerificationService reqVerifService; - Message receivedMessage = Message(1, 10, Message::TC, 3); - reqVerifService.failRoutingVerification(receivedMessage); + reqVerifService.failRoutingVerification(receivedMessage, ErrorHandler::UnknownRoutingError); REQUIRE(ServiceTests::hasOneMessage()); Message response = ServiceTests::get(0); @@ -115,7 +200,7 @@ TEST_CASE("TM[1,10]", "[service][st01]") { CHECK(response.readEnumerated(1) == Message::TC); // packet type CHECK(response.readBits(1) == 0); // secondary header flag CHECK(response.readEnumerated(11) == 3); // application process ID - CHECK(response.readEnumerated(2) == 0); // sequence flags + CHECK(response.readEnumerated(2) == ECSS_SEQUENCE_FLAGS); // sequence flags CHECK(response.readBits(14) == 0); // packet sequence count - CHECK(response.readEnum16() == 0); // error code + CHECK(response.readEnum16() == ErrorHandler::UnknownRoutingError); // error code } diff --git a/test/Services/ServiceTests.hpp b/test/Services/ServiceTests.hpp index a160558a0aac56d215ae6af329ce7b690c0b2f4d..0c9f5b922501c10d7f6c7b28ebed119c9246e2ba 100644 --- a/test/Services/ServiceTests.hpp +++ b/test/Services/ServiceTests.hpp @@ -2,7 +2,9 @@ #define ECSS_SERVICES_TESTS_SERVICES_SERVICETESTS_HPP #include <vector> +#include <map> #include <Message.hpp> +#include <ServicePool.hpp> /** * Supporting class for tests against ECSS services @@ -10,8 +12,24 @@ * @todo See if members of this class can be made non-static */ class ServiceTests { + /** + * The list of Messages that have been sent as a result of all the processing. + */ static std::vector<Message> queuedMessages; + /** + * The list of Errors that the ErrorHandler caught + * @var A multimap with keys (ErrorSource, ErrorType) and values of 1 + * @todo If errors get more complex, this should hold the complete error information + */ + static std::multimap<std::pair<ErrorHandler::ErrorSource, uint16_t>, bool> thrownErrors; + + /** + * Whether an error assertion function was called, indicating that we are expecting to see + * Errors thrown after this Message + */ + static bool expectingErrors; + public: /** * Get a message from the list of queued messages to send @@ -28,6 +46,17 @@ public: queuedMessages.push_back(message); } + /** + * Add one error to the list of occurred errors. + * + * @param errorSource The source of the error. + * @param errorCode The integer code of the error, coming directly from one of the ErrorCode + * enumerations in ErrorHandler. + */ + static void addError(ErrorHandler::ErrorSource errorSource, uint16_t errorCode) { + thrownErrors.emplace(std::make_pair(errorSource, errorCode), 1); + } + /** * Counts the number of messages in the queue */ @@ -43,10 +72,56 @@ public: } /** - * Remove all the queued messages from the list, starting over from 0 items again + * Reset the testing environment, starting from zero for all parameters */ static void reset() { queuedMessages.clear(); + thrownErrors.clear(); + expectingErrors = false; + + Services.reset(); + } + +/** + * Return whether an error assertion function was called, which means that we are expecting this + * request to contain errors + * @return + */ + static bool isExpectingErrors() { + return expectingErrors; + } + + /** + * Find if there are *no* thrown errors + * @return True if 0 errors were thrown after the message + * @todo Implement a way to run this assertion at the end of every test + */ + static bool hasNoErrors() { + return thrownErrors.empty(); + } + + /** + * Find the number of thrown errors after the processing of this Message. + */ + static uint64_t countErrors() { + expectingErrors = true; + + return thrownErrors.size(); + } + + /** + * Find if an error + * @tparam ErrorType An enumeration of ErrorHandler + * @param errorType The error code of the Error, corresponding to the correct type as + * specified in ErrorHandler + */ + template<typename ErrorType> + static bool thrownError(ErrorType errorType) { + ErrorHandler::ErrorSource errorSource = ErrorHandler::findErrorSource(errorType); + + expectingErrors = true; + + return thrownErrors.find(std::make_pair(errorSource, errorType)) != thrownErrors.end(); } }; diff --git a/test/Services/TestService.cpp b/test/Services/TestService.cpp index a94934ad20836620ec2ab1779d4ce0107798d08c..700c0b9df512d6a5e8aa2ae803762f1e07240294 100644 --- a/test/Services/TestService.cpp +++ b/test/Services/TestService.cpp @@ -3,9 +3,9 @@ #include <Message.hpp> #include "ServiceTests.hpp" -TEST_CASE("TM[17,1]", "[service][st17]") { - TestService testService; +TestService & testService = Services.testService; +TEST_CASE("TM[17,1]", "[service][st17]") { Message receivedPacket = Message(17, 1, Message::TC, 1); testService.areYouAlive(receivedPacket); REQUIRE(ServiceTests::hasOneMessage()); @@ -17,8 +17,6 @@ TEST_CASE("TM[17,1]", "[service][st17]") { } TEST_CASE("TM[17,3]", "[service][st17]") { - TestService testService; - Message receivedPacket = Message(17, 3, Message::TC, 1); receivedPacket.appendEnum16(40); testService.onBoardConnection(receivedPacket); diff --git a/test/Services/TimeManagementService.cpp b/test/Services/TimeManagementService.cpp index 6e03ea993dca4945a7de03e83097eda953d4ffe8..9a4894f6ba09d939fe42dee17b68f0d19cd84461 100644 --- a/test/Services/TimeManagementService.cpp +++ b/test/Services/TimeManagementService.cpp @@ -2,9 +2,9 @@ #include <Services/TimeManagementService.hpp> #include "ServiceTests.hpp" -TEST_CASE("TM[9,3]", "[service][st09]") { - TimeManagementService timeService; +TimeManagementService & timeService = Services.timeManagement; +TEST_CASE("TM[9,3]", "[service][st09]") { struct TimeAndDate TimeInfo = {0}; // 10/04/2020 10:15:00 TimeInfo.year = 2020; @@ -14,7 +14,6 @@ TEST_CASE("TM[9,3]", "[service][st09]") { TimeInfo.minute = 15; TimeInfo.second = 0; - TimeHelper time; uint32_t currTime = TimeHelper::utcToSeconds(TimeInfo); uint16_t elapsedDays = currTime/86400; diff --git a/test/TestPlatform.cpp b/test/TestPlatform.cpp index 10f9cdf366fd4950138248a6564b33c7d8dd0a10..0880d64ea865d220846ac5659068606cbce65d62 100644 --- a/test/TestPlatform.cpp +++ b/test/TestPlatform.cpp @@ -5,15 +5,49 @@ #include <Service.hpp> #include "Services/ServiceTests.hpp" +// Explicit template specializations for the logError() function +template void ErrorHandler::logError(const Message &, ErrorHandler::AcceptanceErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionStartErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionProgressErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::ExecutionCompletionErrorType); +template void ErrorHandler::logError(const Message &, ErrorHandler::RoutingErrorType); +template void ErrorHandler::logError(ErrorHandler::InternalErrorType); + +// Initialisation of ServiceTests properties std::vector<Message> ServiceTests::queuedMessages = std::vector<Message>(); +std::multimap<std::pair<ErrorHandler::ErrorSource, uint16_t>, bool> ServiceTests::thrownErrors = + std::multimap<std::pair<ErrorHandler::ErrorSource, uint16_t>, bool>(); +bool ServiceTests::expectingErrors = false; void Service::storeMessage(const Message &message) { + // Just add the message to the queue ServiceTests::queue(message); } +template<typename ErrorType> +void ErrorHandler::logError(const Message &message, ErrorType errorType) { + logError(errorType); +} + +template<typename ErrorType> +void ErrorHandler::logError(ErrorType errorType) { + ServiceTests::addError(ErrorHandler::findErrorSource(errorType), errorType); +} + struct ServiceTestsListener : Catch::TestEventListenerBase { using TestEventListenerBase::TestEventListenerBase; // inherit constructor + void sectionEnded(Catch::SectionStats const §ionStats) override { + // Make sure we don't have any errors + if (not ServiceTests::isExpectingErrors()) { + // An Error was thrown with this Message. If you expected this to happen, please call a + // corresponding assertion function from ServiceTests to silence this message. + + //TODO: Uncomment the following line as soon as Issue #19 is closed + // CHECK(ServiceTests::hasNoErrors()); + } + } + void testCaseEnded(Catch::TestCaseStats const &testCaseStats) override { // Tear-down after a test case is run ServiceTests::reset();