From 742bf643e74f632bd89ef9a8fb592fd1f789246d Mon Sep 17 00:00:00 2001 From: Khalil Estell Date: Tue, 23 Aug 2022 08:09:55 -0700 Subject: [PATCH] Fix conan files such that they conform to CCI CCI meaning conan center index requirements Issue #405 --- .github/workflows/take.yml | 2 +- conandata.yml | 4 + conanfile.py | 8 +- docs/_config.yml | 2 +- include/libhal/LICENSE | 201 ++++++++++++++++++++++++++++++++++++ include/libhal/adc/mock.hpp | 82 +++++++-------- include/libhal/config.hpp | 2 +- test_package/CMakeLists.txt | 2 +- tests/adc/mock.test.cpp | 58 +++++------ tests/enum.test.cpp | 2 +- tests/ostreams.hpp | 2 +- 11 files changed, 285 insertions(+), 80 deletions(-) create mode 100644 conandata.yml create mode 100644 include/libhal/LICENSE diff --git a/.github/workflows/take.yml b/.github/workflows/take.yml index f1bd260e0..608a079a3 100644 --- a/.github/workflows/take.yml +++ b/.github/workflows/take.yml @@ -13,4 +13,4 @@ jobs: env: GITHUB_TOKEN: ${{ github.token }} with: - message: Thanks for taking this issue! Let us know if you have any questions! \ No newline at end of file + message: Thanks for taking this issue! Let us know if you have any questions! diff --git a/conandata.yml b/conandata.yml new file mode 100644 index 000000000..65c67c2e4 --- /dev/null +++ b/conandata.yml @@ -0,0 +1,4 @@ +sources: + "0.0.0": + url: "https://github.com/libhal/libhal/archive/refs/tags/v0.0.0.tar.gz" + sha256: "8f4851281c4bfc8f53f332eff67917f19fdb5edf2f71ddb329ecc017ff78cfbb" diff --git a/conanfile.py b/conanfile.py index d240b2083..a663065a3 100644 --- a/conanfile.py +++ b/conanfile.py @@ -3,18 +3,18 @@ class libhal_conan(ConanFile): name = "libhal" - license = "Apache License Version 2.0" - url = "https://github.com/libhal/libhal" + license = "Apache-2.0" + url = "https://github.com/conan-io/conan-center-index" homepage = "https://libhal.github.io/libhal" description = ("A collection of interfaces and abstractions for embedded " "peripherals and devices using modern C++") topics = ("peripherals", "hardware", "abstraction", "devices") settings = "os", "compiler", "arch", "build_type" - exports_sources = "include/*", "LICENSE" + exports_sources = "include/*" no_copy_source = True def package(self): - self.copy("LICENSE", dst="licenses") + self.copy("*LICENSE*", dst="licenses", keep_path=False) self.copy("*.h") self.copy("*.hpp") diff --git a/docs/_config.yml b/docs/_config.yml index db354a153..457845daf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,4 +3,4 @@ plugins: - jekyll-remote-theme markdown: kramdown highlighter: rouge -input: GFM \ No newline at end of file +input: GFM diff --git a/include/libhal/LICENSE b/include/libhal/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/include/libhal/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/include/libhal/adc/mock.hpp b/include/libhal/adc/mock.hpp index 3376af672..19753a9d6 100644 --- a/include/libhal/adc/mock.hpp +++ b/include/libhal/adc/mock.hpp @@ -1,41 +1,41 @@ -#pragma once - -#include - -#include "interface.hpp" - -namespace hal::mock { -/** - * @addtogroup adc - * @{ - */ -/** - * @brief Mock adc implementation for use in unit tests and simulations. - */ -struct adc : public hal::adc -{ - /** - * @brief Queues the percentages to be returned for read() - * - * @param p_adc_values - queue of percentages - */ - void set(std::queue& p_adc_values) - { - m_adc_values = p_adc_values; - } - -private: - result driver_read() noexcept - { - if (m_adc_values.size() == 0) { - return hal::new_error(std::out_of_range("percentages queue is empty!")); - } - percentage m_current_value = m_adc_values.front(); - m_adc_values.pop(); - return m_current_value; - } - - std::queue m_adc_values{}; -}; -/** @} */ -} // namespace hal::mock +#pragma once + +#include + +#include "interface.hpp" + +namespace hal::mock { +/** + * @addtogroup adc + * @{ + */ +/** + * @brief Mock adc implementation for use in unit tests and simulations. + */ +struct adc : public hal::adc +{ + /** + * @brief Queues the percentages to be returned for read() + * + * @param p_adc_values - queue of percentages + */ + void set(std::queue& p_adc_values) + { + m_adc_values = p_adc_values; + } + +private: + result driver_read() noexcept + { + if (m_adc_values.size() == 0) { + return hal::new_error(std::out_of_range("percentages queue is empty!")); + } + percentage m_current_value = m_adc_values.front(); + m_adc_values.pop(); + return m_current_value; + } + + std::queue m_adc_values{}; +}; +/** @} */ +} // namespace hal::mock diff --git a/include/libhal/config.hpp b/include/libhal/config.hpp index e1099809d..bccd86028 100644 --- a/include/libhal/config.hpp +++ b/include/libhal/config.hpp @@ -52,4 +52,4 @@ namespace hal { config::platform.starts_with("unittest") || config::platform.starts_with("test")); } -}; // namespace hal \ No newline at end of file +}; // namespace hal diff --git a/test_package/CMakeLists.txt b/test_package/CMakeLists.txt index 7a1a40aeb..41505bbdc 100644 --- a/test_package/CMakeLists.txt +++ b/test_package/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.1...3.21) +cmake_minimum_required(VERSION 3.1.2) set(CMAKE_C_COMPILER "gcc-11") set(CMAKE_CXX_COMPILER "g++-11") diff --git a/tests/adc/mock.test.cpp b/tests/adc/mock.test.cpp index 3b98f9c6c..c876b0a87 100644 --- a/tests/adc/mock.test.cpp +++ b/tests/adc/mock.test.cpp @@ -1,29 +1,29 @@ -#include - -#include -#include - -namespace hal { -boost::ut::suite adc_mock_test = []() { - using namespace boost::ut; - - // Setup - auto expected1 = percentage(0.25); - auto expected2 = percentage(0.5); - auto expected3 = percentage(1.0); - hal::mock::adc mock; - std::deque percentages{ expected1, expected2, expected3 }; - std::queue queue(percentages); - - // Exercise - mock.set(queue); - auto result1 = mock.read().value(); - auto result2 = mock.read().value(); - auto result3 = mock.read().value(); - - // Verify - expect(that % expected1.value() == result1.value()); - expect(that % expected2.value() == result2.value()); - expect(that % expected3.value() == result3.value()); -}; -} // namespace hal +#include + +#include +#include + +namespace hal { +boost::ut::suite adc_mock_test = []() { + using namespace boost::ut; + + // Setup + auto expected1 = percentage(0.25); + auto expected2 = percentage(0.5); + auto expected3 = percentage(1.0); + hal::mock::adc mock; + std::deque percentages{ expected1, expected2, expected3 }; + std::queue queue(percentages); + + // Exercise + mock.set(queue); + auto result1 = mock.read().value(); + auto result2 = mock.read().value(); + auto result3 = mock.read().value(); + + // Verify + expect(that % expected1.value() == result1.value()); + expect(that % expected2.value() == result2.value()); + expect(that % expected3.value() == result3.value()); +}; +} // namespace hal diff --git a/tests/enum.test.cpp b/tests/enum.test.cpp index a44c885b9..148118663 100644 --- a/tests/enum.test.cpp +++ b/tests/enum.test.cpp @@ -1 +1 @@ -#include \ No newline at end of file +#include diff --git a/tests/ostreams.hpp b/tests/ostreams.hpp index 785b65a34..c9e34d685 100644 --- a/tests/ostreams.hpp +++ b/tests/ostreams.hpp @@ -58,4 +58,4 @@ inline std::ostream& operator<<(std::ostream& os, << std::setfill(' ') << std::setw(10) << p_percent.value() << " }"); } -} // namespace hal \ No newline at end of file +} // namespace hal