From cc01ec5fe5a5706b381b512937c6681d720f3731 Mon Sep 17 00:00:00 2001 From: jeangab Date: Fri, 6 Sep 2024 12:17:23 -0400 Subject: [PATCH 1/5] chore(harmony): Use Cargo workspaces for core harmony and client specific implementation --- harmony-rs/Cargo.lock | 35 +- harmony-rs/Cargo.toml | 30 +- harmony-rs/LICENSE | 660 ++++++++++++++++++ harmony-rs/fqm/Cargo.toml | 6 + .../inventory/fqm.rs => fqm/src/inventory.rs} | 0 harmony-rs/fqm/src/lib.rs | 14 + harmony-rs/harmony/Cargo.toml | 18 + .../{ => harmony}/src/domain/cluster/mod.rs | 0 .../{ => harmony}/src/domain/data/id.rs | 0 .../{ => harmony}/src/domain/data/mod.rs | 0 .../{ => harmony}/src/domain/data/version.rs | 0 .../{ => harmony}/src/domain/executors/mod.rs | 5 +- harmony-rs/{ => harmony}/src/domain/filter.rs | 0 .../src/domain/hardware/building.rs | 0 .../{ => harmony}/src/domain/hardware/host.rs | 0 .../{ => harmony}/src/domain/hardware/mod.rs | 0 .../src/domain/hardware/network_cable.rs | 0 .../src/domain/hardware/power_cable.rs | 0 .../{ => harmony}/src/domain/hardware/rack.rs | 0 .../src/domain/hardware/switch.rs | 0 .../{ => harmony}/src/domain/hardware/ups.rs | 0 .../{ => harmony}/src/domain/interpret/mod.rs | 0 .../{ => harmony}/src/domain/inventory/mod.rs | 0 .../{ => harmony}/src/domain/maestro/mod.rs | 0 harmony-rs/{ => harmony}/src/domain/mod.rs | 0 harmony-rs/{ => harmony}/src/domain/score.rs | 0 .../{ => harmony}/src/domain/topology/mod.rs | 0 .../ansible/opnsense_dhcp_configuration.rs | 0 .../src/infra/executors/boot/mod.rs | 0 .../{ => harmony}/src/infra/executors/mod.rs | 0 .../src/infra/executors/power/mod.rs | 0 .../harmony/src/infra/executors/russh/mod.rs | 41 ++ harmony-rs/{ => harmony}/src/infra/mod.rs | 1 - harmony-rs/{ => harmony}/src/lib.rs | 0 harmony-rs/{ => harmony}/src/main.rs | 6 +- harmony-rs/{ => harmony}/src/main_ipmi.rs | 0 harmony-rs/{ => harmony}/src/main_redfish.rs | 0 harmony-rs/{ => harmony}/src/modules/mod.rs | 0 .../src/modules/opnsense_dhcp.rs | 4 +- harmony-rs/src/infra/executors/russh/mod.rs | 104 --- harmony-rs/src/infra/inventory/mod.rs | 1 - 41 files changed, 783 insertions(+), 142 deletions(-) create mode 100644 harmony-rs/LICENSE create mode 100644 harmony-rs/fqm/Cargo.toml rename harmony-rs/{src/infra/inventory/fqm.rs => fqm/src/inventory.rs} (100%) create mode 100644 harmony-rs/fqm/src/lib.rs create mode 100644 harmony-rs/harmony/Cargo.toml rename harmony-rs/{ => harmony}/src/domain/cluster/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/data/id.rs (100%) rename harmony-rs/{ => harmony}/src/domain/data/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/data/version.rs (100%) rename harmony-rs/{ => harmony}/src/domain/executors/mod.rs (84%) rename harmony-rs/{ => harmony}/src/domain/filter.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/building.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/host.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/network_cable.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/power_cable.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/rack.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/switch.rs (100%) rename harmony-rs/{ => harmony}/src/domain/hardware/ups.rs (100%) rename harmony-rs/{ => harmony}/src/domain/interpret/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/inventory/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/maestro/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/mod.rs (100%) rename harmony-rs/{ => harmony}/src/domain/score.rs (100%) rename harmony-rs/{ => harmony}/src/domain/topology/mod.rs (100%) rename harmony-rs/{ => harmony}/src/infra/executors/ansible/opnsense_dhcp_configuration.rs (100%) rename harmony-rs/{ => harmony}/src/infra/executors/boot/mod.rs (100%) rename harmony-rs/{ => harmony}/src/infra/executors/mod.rs (100%) rename harmony-rs/{ => harmony}/src/infra/executors/power/mod.rs (100%) create mode 100644 harmony-rs/harmony/src/infra/executors/russh/mod.rs rename harmony-rs/{ => harmony}/src/infra/mod.rs (50%) rename harmony-rs/{ => harmony}/src/lib.rs (100%) rename harmony-rs/{ => harmony}/src/main.rs (71%) rename harmony-rs/{ => harmony}/src/main_ipmi.rs (100%) rename harmony-rs/{ => harmony}/src/main_redfish.rs (100%) rename harmony-rs/{ => harmony}/src/modules/mod.rs (100%) rename harmony-rs/{ => harmony}/src/modules/opnsense_dhcp.rs (92%) delete mode 100644 harmony-rs/src/infra/executors/russh/mod.rs delete mode 100644 harmony-rs/src/infra/inventory/mod.rs diff --git a/harmony-rs/Cargo.lock b/harmony-rs/Cargo.lock index 2641eef..91876e4 100644 --- a/harmony-rs/Cargo.lock +++ b/harmony-rs/Cargo.lock @@ -258,9 +258,9 @@ dependencies = [ [[package]] name = "cc" -version = "1.1.15" +version = "1.1.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "57b6a275aa2903740dc87da01c62040406b8812552e97129a63ea8850a17c6e6" +checksum = "e9d013ecb737093c0e86b151a7b837993cf9ec6c502946cfb44bedc392421e0b" dependencies = [ "shlex", ] @@ -322,9 +322,9 @@ checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" [[package]] name = "cpufeatures" -version = "0.2.13" +version = "0.2.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "51e852e6dc9a5bed1fae92dd2375037bf2b768725bf3be87811edee3249d09ad" +checksum = "608697df725056feaccfa42cffdaeeec3fccc4ffc38358ecd19b243e716a78e0" dependencies = [ "libc", ] @@ -616,6 +616,10 @@ dependencies = [ "percent-encoding", ] +[[package]] +name = "fqm" +version = "0.1.0" + [[package]] name = "funty" version = "2.0.0" @@ -780,9 +784,10 @@ dependencies = [ ] [[package]] -name = "harmony-rs" +name = "harmony" version = "0.1.0" dependencies = [ + "async-trait", "derive-new", "env_logger", "libredfish", @@ -930,9 +935,9 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.4.0" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "93ead53efc7ea8ed3cfb0c79fc8023fbb782a5432b52830b6518941cebe6505c" +checksum = "68b900aa2f7301e21c36462b170ee99994de34dff39a4a6a528e80e7376d07e5" dependencies = [ "equivalent", "hashbrown", @@ -1682,9 +1687,9 @@ dependencies = [ [[package]] name = "rustix" -version = "0.38.35" +version = "0.38.36" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a85d50532239da68e9addb745ba38ff4612a242c1c7ceea689c4bc7c2f43c36f" +checksum = "3f55e80d50763938498dd5ebb18647174e0c76dc38c5505294bb224624f30f36" dependencies = [ "bitflags 2.6.0", "errno", @@ -1802,9 +1807,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.127" +version = "1.0.128" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8043c06d9f82bd7271361ed64f415fe5e12a77fdb52e573e7f06a516dea329ad" +checksum = "6ff5456707a1de34e7e37f2a6fd3d3f808c318259cbd01ab6377795054b483d8" dependencies = [ "itoa", "memchr", @@ -1971,9 +1976,9 @@ checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" [[package]] name = "syn" -version = "2.0.76" +version = "2.0.77" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "578e081a14e0cefc3279b0472138c513f37b41a08d5a3cca9b6e4e8ceb6cd525" +checksum = "9f35bcdf61fd8e7be6caf75f429fdca8beb3ed76584befb503b1569faee373ed" dependencies = [ "proc-macro2", "quote", @@ -2112,9 +2117,9 @@ dependencies = [ [[package]] name = "tokio-util" -version = "0.7.11" +version = "0.7.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cf6b47b3771c49ac75ad09a6162f53ad4b8088b76ac60e8ec1455b31a189fe1" +checksum = "61e7c3654c13bcd040d4a03abee2c75b1d14a37b423cf5a813ceae1cc903ec6a" dependencies = [ "bytes", "futures-core", diff --git a/harmony-rs/Cargo.toml b/harmony-rs/Cargo.toml index b4cdbb4..256f1bd 100644 --- a/harmony-rs/Cargo.toml +++ b/harmony-rs/Cargo.toml @@ -1,17 +1,17 @@ -[package] -name = "harmony-rs" -version = "0.1.0" -edition = "2021" +[workspace] +resolver = "2" +members = [ + "fqm", + "harmony", +] -[dependencies] -derive-new = "0.7.0" -env_logger = "0.11.5" -libredfish = "0.1.1" +[workspace.package] +version = "0.1.0" +readme = "README.md" +license = "GNU AGPL v3" + +[workspace.dependencies] log = "0.4.22" -reqwest = {version = "0.11", features = ["blocking", "json"] } -russh = "0.45.0" -rust-ipmi = "0.1.1" -semver = "1.0.23" -serde = { version = "1.0.209", features = ["derive"] } -serde_json = "1.0.127" -tokio = { version = "1.40.0", features = ["io-std"] } +env_logger = "0.11.5" +derive-new = "0.7.0" +async-trait = "0.1.82" diff --git a/harmony-rs/LICENSE b/harmony-rs/LICENSE new file mode 100644 index 0000000..c6f01c6 --- /dev/null +++ b/harmony-rs/LICENSE @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . diff --git a/harmony-rs/fqm/Cargo.toml b/harmony-rs/fqm/Cargo.toml new file mode 100644 index 0000000..69e1ce8 --- /dev/null +++ b/harmony-rs/fqm/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "fqm" +version = "0.1.0" +edition = "2021" + +[dependencies] diff --git a/harmony-rs/src/infra/inventory/fqm.rs b/harmony-rs/fqm/src/inventory.rs similarity index 100% rename from harmony-rs/src/infra/inventory/fqm.rs rename to harmony-rs/fqm/src/inventory.rs diff --git a/harmony-rs/fqm/src/lib.rs b/harmony-rs/fqm/src/lib.rs new file mode 100644 index 0000000..7d12d9a --- /dev/null +++ b/harmony-rs/fqm/src/lib.rs @@ -0,0 +1,14 @@ +pub fn add(left: usize, right: usize) -> usize { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +} diff --git a/harmony-rs/harmony/Cargo.toml b/harmony-rs/harmony/Cargo.toml new file mode 100644 index 0000000..be11fef --- /dev/null +++ b/harmony-rs/harmony/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "harmony" +version = "0.1.0" +edition = "2021" + +[dependencies] +libredfish = "0.1.1" +reqwest = {version = "0.11", features = ["blocking", "json"] } +russh = "0.45.0" +rust-ipmi = "0.1.1" +semver = "1.0.23" +serde = { version = "1.0.209", features = ["derive"] } +serde_json = "1.0.127" +tokio = { version = "1.40.0", features = ["io-std"] } +derive-new = { workspace = true } +log = { workspace = true } +env_logger = { workspace = true } +async-trait = { workspace = true } diff --git a/harmony-rs/src/domain/cluster/mod.rs b/harmony-rs/harmony/src/domain/cluster/mod.rs similarity index 100% rename from harmony-rs/src/domain/cluster/mod.rs rename to harmony-rs/harmony/src/domain/cluster/mod.rs diff --git a/harmony-rs/src/domain/data/id.rs b/harmony-rs/harmony/src/domain/data/id.rs similarity index 100% rename from harmony-rs/src/domain/data/id.rs rename to harmony-rs/harmony/src/domain/data/id.rs diff --git a/harmony-rs/src/domain/data/mod.rs b/harmony-rs/harmony/src/domain/data/mod.rs similarity index 100% rename from harmony-rs/src/domain/data/mod.rs rename to harmony-rs/harmony/src/domain/data/mod.rs diff --git a/harmony-rs/src/domain/data/version.rs b/harmony-rs/harmony/src/domain/data/version.rs similarity index 100% rename from harmony-rs/src/domain/data/version.rs rename to harmony-rs/harmony/src/domain/data/version.rs diff --git a/harmony-rs/src/domain/executors/mod.rs b/harmony-rs/harmony/src/domain/executors/mod.rs similarity index 84% rename from harmony-rs/src/domain/executors/mod.rs rename to harmony-rs/harmony/src/domain/executors/mod.rs index 8af236e..6d8096f 100644 --- a/harmony-rs/src/domain/executors/mod.rs +++ b/harmony-rs/harmony/src/domain/executors/mod.rs @@ -1,5 +1,7 @@ use std::fmt; +use async_trait::async_trait; + pub struct ExecutorResult { message: String, } @@ -25,6 +27,7 @@ impl fmt::Display for ExecutorError { impl std::error::Error for ExecutorError {} +#[async_trait] pub trait SshClient { - fn test_connection(&self, username: String, password: String) -> Result<(), ExecutorError>; + async fn test_connection(&self, username: String, password: String) -> Result<(), ExecutorError>; } diff --git a/harmony-rs/src/domain/filter.rs b/harmony-rs/harmony/src/domain/filter.rs similarity index 100% rename from harmony-rs/src/domain/filter.rs rename to harmony-rs/harmony/src/domain/filter.rs diff --git a/harmony-rs/src/domain/hardware/building.rs b/harmony-rs/harmony/src/domain/hardware/building.rs similarity index 100% rename from harmony-rs/src/domain/hardware/building.rs rename to harmony-rs/harmony/src/domain/hardware/building.rs diff --git a/harmony-rs/src/domain/hardware/host.rs b/harmony-rs/harmony/src/domain/hardware/host.rs similarity index 100% rename from harmony-rs/src/domain/hardware/host.rs rename to harmony-rs/harmony/src/domain/hardware/host.rs diff --git a/harmony-rs/src/domain/hardware/mod.rs b/harmony-rs/harmony/src/domain/hardware/mod.rs similarity index 100% rename from harmony-rs/src/domain/hardware/mod.rs rename to harmony-rs/harmony/src/domain/hardware/mod.rs diff --git a/harmony-rs/src/domain/hardware/network_cable.rs b/harmony-rs/harmony/src/domain/hardware/network_cable.rs similarity index 100% rename from harmony-rs/src/domain/hardware/network_cable.rs rename to harmony-rs/harmony/src/domain/hardware/network_cable.rs diff --git a/harmony-rs/src/domain/hardware/power_cable.rs b/harmony-rs/harmony/src/domain/hardware/power_cable.rs similarity index 100% rename from harmony-rs/src/domain/hardware/power_cable.rs rename to harmony-rs/harmony/src/domain/hardware/power_cable.rs diff --git a/harmony-rs/src/domain/hardware/rack.rs b/harmony-rs/harmony/src/domain/hardware/rack.rs similarity index 100% rename from harmony-rs/src/domain/hardware/rack.rs rename to harmony-rs/harmony/src/domain/hardware/rack.rs diff --git a/harmony-rs/src/domain/hardware/switch.rs b/harmony-rs/harmony/src/domain/hardware/switch.rs similarity index 100% rename from harmony-rs/src/domain/hardware/switch.rs rename to harmony-rs/harmony/src/domain/hardware/switch.rs diff --git a/harmony-rs/src/domain/hardware/ups.rs b/harmony-rs/harmony/src/domain/hardware/ups.rs similarity index 100% rename from harmony-rs/src/domain/hardware/ups.rs rename to harmony-rs/harmony/src/domain/hardware/ups.rs diff --git a/harmony-rs/src/domain/interpret/mod.rs b/harmony-rs/harmony/src/domain/interpret/mod.rs similarity index 100% rename from harmony-rs/src/domain/interpret/mod.rs rename to harmony-rs/harmony/src/domain/interpret/mod.rs diff --git a/harmony-rs/src/domain/inventory/mod.rs b/harmony-rs/harmony/src/domain/inventory/mod.rs similarity index 100% rename from harmony-rs/src/domain/inventory/mod.rs rename to harmony-rs/harmony/src/domain/inventory/mod.rs diff --git a/harmony-rs/src/domain/maestro/mod.rs b/harmony-rs/harmony/src/domain/maestro/mod.rs similarity index 100% rename from harmony-rs/src/domain/maestro/mod.rs rename to harmony-rs/harmony/src/domain/maestro/mod.rs diff --git a/harmony-rs/src/domain/mod.rs b/harmony-rs/harmony/src/domain/mod.rs similarity index 100% rename from harmony-rs/src/domain/mod.rs rename to harmony-rs/harmony/src/domain/mod.rs diff --git a/harmony-rs/src/domain/score.rs b/harmony-rs/harmony/src/domain/score.rs similarity index 100% rename from harmony-rs/src/domain/score.rs rename to harmony-rs/harmony/src/domain/score.rs diff --git a/harmony-rs/src/domain/topology/mod.rs b/harmony-rs/harmony/src/domain/topology/mod.rs similarity index 100% rename from harmony-rs/src/domain/topology/mod.rs rename to harmony-rs/harmony/src/domain/topology/mod.rs diff --git a/harmony-rs/src/infra/executors/ansible/opnsense_dhcp_configuration.rs b/harmony-rs/harmony/src/infra/executors/ansible/opnsense_dhcp_configuration.rs similarity index 100% rename from harmony-rs/src/infra/executors/ansible/opnsense_dhcp_configuration.rs rename to harmony-rs/harmony/src/infra/executors/ansible/opnsense_dhcp_configuration.rs diff --git a/harmony-rs/src/infra/executors/boot/mod.rs b/harmony-rs/harmony/src/infra/executors/boot/mod.rs similarity index 100% rename from harmony-rs/src/infra/executors/boot/mod.rs rename to harmony-rs/harmony/src/infra/executors/boot/mod.rs diff --git a/harmony-rs/src/infra/executors/mod.rs b/harmony-rs/harmony/src/infra/executors/mod.rs similarity index 100% rename from harmony-rs/src/infra/executors/mod.rs rename to harmony-rs/harmony/src/infra/executors/mod.rs diff --git a/harmony-rs/src/infra/executors/power/mod.rs b/harmony-rs/harmony/src/infra/executors/power/mod.rs similarity index 100% rename from harmony-rs/src/infra/executors/power/mod.rs rename to harmony-rs/harmony/src/infra/executors/power/mod.rs diff --git a/harmony-rs/harmony/src/infra/executors/russh/mod.rs b/harmony-rs/harmony/src/infra/executors/russh/mod.rs new file mode 100644 index 0000000..d6d1845 --- /dev/null +++ b/harmony-rs/harmony/src/infra/executors/russh/mod.rs @@ -0,0 +1,41 @@ +use std::sync::Arc; +use async_trait::async_trait; + +use russh::{client, keys::key}; + +use crate::domain::executors::{ExecutorError, SshClient}; + +pub struct RusshClient; + +#[async_trait] +impl SshClient for RusshClient { + async fn test_connection(&self, _username: String, _password: String) -> Result<(), crate::domain::executors::ExecutorError> { + let config = client::Config::default(); + let c = Client{}; + let _client = client::connect(Arc::new(config), ("192.168.12.1", 22), c).await?; + Ok(()) + } +} + +struct Client {} + +// More SSH event handlers +// can be defined in this trait +// In this example, we're only using Channel, so these aren't needed. +#[async_trait] +impl client::Handler for Client { + type Error = ExecutorError; + + async fn check_server_key( + &mut self, + _server_public_key: &key::PublicKey, + ) -> Result { + Ok(true) + } +} + +impl From for ExecutorError { + fn from(_value: russh::Error) -> Self { + todo!() + } +} diff --git a/harmony-rs/src/infra/mod.rs b/harmony-rs/harmony/src/infra/mod.rs similarity index 50% rename from harmony-rs/src/infra/mod.rs rename to harmony-rs/harmony/src/infra/mod.rs index ed4e230..7c47003 100644 --- a/harmony-rs/src/infra/mod.rs +++ b/harmony-rs/harmony/src/infra/mod.rs @@ -1,2 +1 @@ -pub mod inventory; pub mod executors; diff --git a/harmony-rs/src/lib.rs b/harmony-rs/harmony/src/lib.rs similarity index 100% rename from harmony-rs/src/lib.rs rename to harmony-rs/harmony/src/lib.rs diff --git a/harmony-rs/src/main.rs b/harmony-rs/harmony/src/main.rs similarity index 71% rename from harmony-rs/src/main.rs rename to harmony-rs/harmony/src/main.rs index 7dd3100..a04c1d3 100644 --- a/harmony-rs/src/main.rs +++ b/harmony-rs/harmony/src/main.rs @@ -1,9 +1,9 @@ -use harmony_rs::{ +use harmony::{ domain::{ inventory::{Inventory, InventoryFilter}, maestro::Maestro, }, - infra::inventory::fqm::get_fqm_inventory, modules::opnsense_dhcp::OPNSenseDhcpScore, + modules::opnsense_dhcp::OPNSenseDhcpScore, }; pub fn main() { @@ -15,5 +15,5 @@ pub fn main() { } fn get_inventory() -> Inventory { - get_fqm_inventory() + todo!() } diff --git a/harmony-rs/src/main_ipmi.rs b/harmony-rs/harmony/src/main_ipmi.rs similarity index 100% rename from harmony-rs/src/main_ipmi.rs rename to harmony-rs/harmony/src/main_ipmi.rs diff --git a/harmony-rs/src/main_redfish.rs b/harmony-rs/harmony/src/main_redfish.rs similarity index 100% rename from harmony-rs/src/main_redfish.rs rename to harmony-rs/harmony/src/main_redfish.rs diff --git a/harmony-rs/src/modules/mod.rs b/harmony-rs/harmony/src/modules/mod.rs similarity index 100% rename from harmony-rs/src/modules/mod.rs rename to harmony-rs/harmony/src/modules/mod.rs diff --git a/harmony-rs/src/modules/opnsense_dhcp.rs b/harmony-rs/harmony/src/modules/opnsense_dhcp.rs similarity index 92% rename from harmony-rs/src/modules/opnsense_dhcp.rs rename to harmony-rs/harmony/src/modules/opnsense_dhcp.rs index a120a55..7b72a5d 100644 --- a/harmony-rs/src/modules/opnsense_dhcp.rs +++ b/harmony-rs/harmony/src/modules/opnsense_dhcp.rs @@ -2,7 +2,7 @@ use derive_new::new; use log::info; use crate::{domain::{ - data::{Id, Version}, executors::SshClient, hardware::NetworkInterface, interpret::{InterpretError, InterpretStatus, Outcome}, inventory::Inventory, topology::IpAddress + data::{Id, Version}, hardware::NetworkInterface, interpret::{InterpretError, InterpretStatus, Outcome}, inventory::Inventory, topology::IpAddress }, infra::executors::russh::RusshClient}; use crate::domain::{ @@ -73,7 +73,7 @@ impl Interpret for OPNSenseDhcpInterpret { fn execute(&self, _inventory: &Inventory) -> Result { info!("Executing {} on inventory {_inventory:?}", self.get_name()); - let ssh_client = RusshClient{}; + let _ssh_client = RusshClient{}; // ssh_client.test_connection("username", "password"); todo!() } diff --git a/harmony-rs/src/infra/executors/russh/mod.rs b/harmony-rs/src/infra/executors/russh/mod.rs deleted file mode 100644 index 67a2577..0000000 --- a/harmony-rs/src/infra/executors/russh/mod.rs +++ /dev/null @@ -1,104 +0,0 @@ -use std::{net::ToSocketAddrs, path::Path, sync::Arc, time::Duration}; - -use russh::{client, keys::{key, load_secret_key}, ChannelMsg, Disconnect}; -use tokio::io::AsyncWriteExt; - -use crate::domain::executors::SshClient; - -pub struct RusshClient; - -impl SshClient for RusshClient { - fn test_connection(&self, username: String, password: String) -> Result<(), crate::domain::executors::ExecutorError> { - todo!() - //Session::connect(); - - } -} - -struct Client {} - -// More SSH event handlers -// can be defined in this trait -// In this example, we're only using Channel, so these aren't needed. -#[async_trait] -impl client::Handler for Client { - type Error = russh::Error; - - async fn check_server_key( - &mut self, - _server_public_key: &key::PublicKey, - ) -> Result { - Ok(true) - } -} - - -/// This struct is a convenience wrapper -/// around a russh client -pub struct Session { - session: client::Handle, -} - -impl Session { - async fn connect, A: ToSocketAddrs>( - key_path: P, - user: impl Into, - addrs: A, - ) -> Result { - let key_pair = load_secret_key(key_path, None)?; - let config = client::Config { - inactivity_timeout: Some(Duration::from_secs(5)), - ..<_>::default() - }; - - let config = Arc::new(config); - let sh = Client {}; - - let mut session = client::connect(config, addrs, sh).await?; - let auth_res = session - .authenticate_publickey(user, Arc::new(key_pair)) - .await?; - - if !auth_res { - Err("Authentication failed") - } - - Ok(Self { session }) - } - - async fn call(&mut self, command: &str) -> Result { - let mut channel = self.session.channel_open_session().await?; - channel.exec(true, command).await?; - - let mut code = None; - let mut stdout = tokio::io::stdout(); - - loop { - // There's an event available on the session channel - let Some(msg) = channel.wait().await else { - break; - }; - match msg { - // Write data to the terminal - ChannelMsg::Data { ref data } => { - stdout.write_all(data).await?; - stdout.flush().await?; - } - // The command has returned an exit code - ChannelMsg::ExitStatus { exit_status } => { - code = Some(exit_status); - // cannot leave the loop immediately, there might still be more data to receive - } - _ => {} - } - } - Ok(code.expect("program did not exit cleanly")) - } - - async fn close(&mut self) -> Result<()> { - self.session - .disconnect(Disconnect::ByApplication, "", "English") - .await?; - Ok(()) - } -} diff --git a/harmony-rs/src/infra/inventory/mod.rs b/harmony-rs/src/infra/inventory/mod.rs deleted file mode 100644 index 1e8da7e..0000000 --- a/harmony-rs/src/infra/inventory/mod.rs +++ /dev/null @@ -1 +0,0 @@ -pub mod fqm; From 8592a3bc364faf7c8a3db8e332f54204f278650a Mon Sep 17 00:00:00 2001 From: jeangab Date: Fri, 6 Sep 2024 16:10:06 -0400 Subject: [PATCH 2/5] feat: Refactored harmony into a workspace with independent modules per client, completed RusshClient test_connection implementation. Needs refactoring though --- harmony-rs/Cargo.lock | 6 +++ harmony-rs/Cargo.toml | 1 + harmony-rs/fqm/Cargo.toml | 5 ++ harmony-rs/fqm/src/inventory.rs | 12 +++-- harmony-rs/fqm/src/lib.rs | 1 + harmony-rs/fqm/src/main.rs | 22 +++++++++ harmony-rs/harmony/Cargo.toml | 2 +- .../harmony/src/domain/executors/mod.rs | 2 +- harmony-rs/harmony/src/domain/hardware/mod.rs | 10 ++-- .../harmony/src/domain/interpret/mod.rs | 46 +++++++++++++++++-- harmony-rs/harmony/src/domain/maestro/mod.rs | 7 +-- .../harmony/src/infra/executors/russh/mod.rs | 13 ++++-- harmony-rs/harmony/src/main.rs | 19 -------- .../harmony/src/modules/opnsense_dhcp.rs | 16 +++++-- 14 files changed, 116 insertions(+), 46 deletions(-) create mode 100644 harmony-rs/fqm/src/main.rs delete mode 100644 harmony-rs/harmony/src/main.rs diff --git a/harmony-rs/Cargo.lock b/harmony-rs/Cargo.lock index 91876e4..db8e801 100644 --- a/harmony-rs/Cargo.lock +++ b/harmony-rs/Cargo.lock @@ -619,6 +619,12 @@ dependencies = [ [[package]] name = "fqm" version = "0.1.0" +dependencies = [ + "env_logger", + "harmony", + "log", + "tokio", +] [[package]] name = "funty" diff --git a/harmony-rs/Cargo.toml b/harmony-rs/Cargo.toml index 256f1bd..3b9fa25 100644 --- a/harmony-rs/Cargo.toml +++ b/harmony-rs/Cargo.toml @@ -15,3 +15,4 @@ log = "0.4.22" env_logger = "0.11.5" derive-new = "0.7.0" async-trait = "0.1.82" +tokio = { version = "1.40.0", features = ["io-std"] } diff --git a/harmony-rs/fqm/Cargo.toml b/harmony-rs/fqm/Cargo.toml index 69e1ce8..3a9ebdc 100644 --- a/harmony-rs/fqm/Cargo.toml +++ b/harmony-rs/fqm/Cargo.toml @@ -4,3 +4,8 @@ version = "0.1.0" edition = "2021" [dependencies] +harmony = { path = "../harmony" } +log = { workspace = true } +env_logger = { workspace = true } +tokio = { workspace = true } + diff --git a/harmony-rs/fqm/src/inventory.rs b/harmony-rs/fqm/src/inventory.rs index cd9bf0e..9efcefd 100644 --- a/harmony-rs/fqm/src/inventory.rs +++ b/harmony-rs/fqm/src/inventory.rs @@ -1,9 +1,11 @@ -use crate::domain::{ - hardware::{Location, Host, HostCategory}, +use harmony::domain::{ + hardware::{Host, HostCategory, Location, NetworkInterface}, inventory::Inventory, }; -pub fn get_fqm_inventory() -> Inventory { +pub fn get_inventory() -> Inventory { + let network = vec![NetworkInterface::new(1_000_000_000, "TODO MAC ADDRESS".into(), true ) ]; + let storage = vec![]; Inventory { location: Location::new( "1134 Grande Allée Ouest 1er étage, Québec, Qc".into(), @@ -11,8 +13,8 @@ pub fn get_fqm_inventory() -> Inventory { ), host: vec![Host { category: HostCategory::Server, - network: vec![], - storage: vec![], + network, + storage, labels: vec![], }], switch: vec![], diff --git a/harmony-rs/fqm/src/lib.rs b/harmony-rs/fqm/src/lib.rs index 7d12d9a..e39d3a9 100644 --- a/harmony-rs/fqm/src/lib.rs +++ b/harmony-rs/fqm/src/lib.rs @@ -1,3 +1,4 @@ +pub mod inventory; pub fn add(left: usize, right: usize) -> usize { left + right } diff --git a/harmony-rs/fqm/src/main.rs b/harmony-rs/fqm/src/main.rs new file mode 100644 index 0000000..99b8082 --- /dev/null +++ b/harmony-rs/fqm/src/main.rs @@ -0,0 +1,22 @@ +use fqm::inventory::get_inventory; +use harmony::{ + domain::{ + inventory::{Inventory, InventoryFilter}, + maestro::Maestro, + }, + modules::opnsense_dhcp::OPNSenseDhcpScore, +}; +use log::info; + +#[tokio::main] +async fn main() { + env_logger::init(); + + tokio::spawn(async move { + info!("FQM Harmony Starting"); + let maestro = Maestro::new(get_inventory()); + let score = OPNSenseDhcpScore::new(InventoryFilter::new(vec![])); + let result = maestro.interpret(score).await.unwrap(); + info!("{result}"); + }).await; +} diff --git a/harmony-rs/harmony/Cargo.toml b/harmony-rs/harmony/Cargo.toml index be11fef..0108040 100644 --- a/harmony-rs/harmony/Cargo.toml +++ b/harmony-rs/harmony/Cargo.toml @@ -11,7 +11,7 @@ rust-ipmi = "0.1.1" semver = "1.0.23" serde = { version = "1.0.209", features = ["derive"] } serde_json = "1.0.127" -tokio = { version = "1.40.0", features = ["io-std"] } +tokio = { workspace = true } derive-new = { workspace = true } log = { workspace = true } env_logger = { workspace = true } diff --git a/harmony-rs/harmony/src/domain/executors/mod.rs b/harmony-rs/harmony/src/domain/executors/mod.rs index 6d8096f..21de8d7 100644 --- a/harmony-rs/harmony/src/domain/executors/mod.rs +++ b/harmony-rs/harmony/src/domain/executors/mod.rs @@ -29,5 +29,5 @@ impl std::error::Error for ExecutorError {} #[async_trait] pub trait SshClient { - async fn test_connection(&self, username: String, password: String) -> Result<(), ExecutorError>; + async fn test_connection(&self, username: &str, password: &str) -> Result<(), ExecutorError>; } diff --git a/harmony-rs/harmony/src/domain/hardware/mod.rs b/harmony-rs/harmony/src/domain/hardware/mod.rs index 28e4d8c..32de3e1 100644 --- a/harmony-rs/harmony/src/domain/hardware/mod.rs +++ b/harmony-rs/harmony/src/domain/hardware/mod.rs @@ -18,14 +18,15 @@ pub enum HostCategory { Switch, } -#[derive(Debug)] +#[derive(Debug, new)] pub struct NetworkInterface { speed: u64, mac_address: MacAddress, plugged_in: bool, } type MacAddress = String; -#[derive(Debug)] + +#[derive(Debug, new)] pub enum StorageConnectionType { Sata3g, Sata6g, @@ -56,7 +57,10 @@ pub struct Switch { #[derive(Debug)] pub struct Firewall {} #[derive(Debug)] -pub struct Label; +pub struct Label { + name: String, + value: String, +} pub type Address = String; #[derive(new, Debug)] diff --git a/harmony-rs/harmony/src/domain/interpret/mod.rs b/harmony-rs/harmony/src/domain/interpret/mod.rs index 3d0a6c1..f3350c2 100644 --- a/harmony-rs/harmony/src/domain/interpret/mod.rs +++ b/harmony-rs/harmony/src/domain/interpret/mod.rs @@ -1,7 +1,10 @@ +use std::error::Error; + +use async_trait::async_trait; +use derive_new::new; + use super::{ - data::{Id, Version}, - inventory::Inventory, - score::Score, + data::{Id, Version}, executors::ExecutorError, inventory::Inventory, score::Score }; pub enum InterpretName { @@ -16,19 +19,25 @@ impl std::fmt::Display for InterpretName { } } +#[async_trait] pub trait Interpret { - fn execute(&self, inventory: &Inventory) -> Result; + async fn execute(&self, inventory: &Inventory) -> Result; fn get_name(&self) -> InterpretName; fn get_version(&self) -> Version; fn get_status(&self) -> InterpretStatus; fn get_children(&self) -> Vec; } -#[derive(Debug)] +#[derive(Debug, new)] pub struct Outcome { status: InterpretStatus, message: String, } +impl std::fmt::Display for Outcome { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_fmt(format_args!("Outcome {}: {}", self.status, self.message)) + } +} #[derive(Debug, Clone)] pub enum InterpretStatus { @@ -39,7 +48,34 @@ pub enum InterpretStatus { BLOCKED, } +impl std::fmt::Display for InterpretStatus { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let msg = match self { + InterpretStatus::SUCCESS => "SUCCESS", + InterpretStatus::FAILURE => "FAILURE", + InterpretStatus::RUNNING => "RUNNING", + InterpretStatus::QUEUED => "QUEUED", + InterpretStatus::BLOCKED => "BLOCKED", + }; + f.write_str(msg) + } +} + + #[derive(Debug)] pub struct InterpretError { msg: String, } + +impl std::fmt::Display for InterpretError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.msg) + } +} +impl Error for InterpretError {} + +impl From for InterpretError{ + fn from(value: ExecutorError) -> Self { + Self { msg: format!("InterpretError : {value}") } + } +} diff --git a/harmony-rs/harmony/src/domain/maestro/mod.rs b/harmony-rs/harmony/src/domain/maestro/mod.rs index 48b65dc..d71a9af 100644 --- a/harmony-rs/harmony/src/domain/maestro/mod.rs +++ b/harmony-rs/harmony/src/domain/maestro/mod.rs @@ -1,7 +1,7 @@ use derive_new::new; use log::info; -use super::{interpret::Interpret, inventory::Inventory, score::Score}; +use super::{interpret::{Interpret, InterpretError, Outcome}, inventory::Inventory, score::Score}; #[derive(new)] pub struct Maestro { @@ -28,11 +28,12 @@ impl Maestro { todo!() } - pub fn interpret(&self, score: S) { + pub async fn interpret(&self, score: S) -> Result { info!("Running score {score:?}"); let interpret: S::InterpretType = score.create_interpret(); info!("Launching interpret {interpret:?}"); - let result = interpret.execute(&self.inventory); + let result = interpret.execute(&self.inventory).await; info!("Got result {result:?}"); + result } } diff --git a/harmony-rs/harmony/src/infra/executors/russh/mod.rs b/harmony-rs/harmony/src/infra/executors/russh/mod.rs index d6d1845..b61c227 100644 --- a/harmony-rs/harmony/src/infra/executors/russh/mod.rs +++ b/harmony-rs/harmony/src/infra/executors/russh/mod.rs @@ -1,6 +1,7 @@ use std::sync::Arc; use async_trait::async_trait; +use log::info; use russh::{client, keys::key}; use crate::domain::executors::{ExecutorError, SshClient}; @@ -9,11 +10,14 @@ pub struct RusshClient; #[async_trait] impl SshClient for RusshClient { - async fn test_connection(&self, _username: String, _password: String) -> Result<(), crate::domain::executors::ExecutorError> { + async fn test_connection(&self, _username: &str, _password: &str) -> Result<(), crate::domain::executors::ExecutorError> { let config = client::Config::default(); let c = Client{}; - let _client = client::connect(Arc::new(config), ("192.168.12.1", 22), c).await?; - Ok(()) + let mut client = client::connect(Arc::new(config), ("192.168.1.1", 22), c).await?; + match client.authenticate_password("nationtech", "opnsense").await? { + true => Ok(()), + false => Err(ExecutorError::AuthenticationError("ssh authentication failed".to_string())), + } } } @@ -36,6 +40,7 @@ impl client::Handler for Client { impl From for ExecutorError { fn from(_value: russh::Error) -> Self { - todo!() + // TODO handle various russh errors properly + ExecutorError::NetworkError("Russh client error".to_string()) } } diff --git a/harmony-rs/harmony/src/main.rs b/harmony-rs/harmony/src/main.rs deleted file mode 100644 index a04c1d3..0000000 --- a/harmony-rs/harmony/src/main.rs +++ /dev/null @@ -1,19 +0,0 @@ -use harmony::{ - domain::{ - inventory::{Inventory, InventoryFilter}, - maestro::Maestro, - }, - modules::opnsense_dhcp::OPNSenseDhcpScore, -}; - -pub fn main() { - env_logger::init(); - - let maestro = Maestro::new(get_inventory()); - let score = OPNSenseDhcpScore::new(InventoryFilter::new(vec![])); - maestro.interpret(score); -} - -fn get_inventory() -> Inventory { - todo!() -} diff --git a/harmony-rs/harmony/src/modules/opnsense_dhcp.rs b/harmony-rs/harmony/src/modules/opnsense_dhcp.rs index 7b72a5d..ca21dc1 100644 --- a/harmony-rs/harmony/src/modules/opnsense_dhcp.rs +++ b/harmony-rs/harmony/src/modules/opnsense_dhcp.rs @@ -1,8 +1,9 @@ +use async_trait::async_trait; use derive_new::new; use log::info; use crate::{domain::{ - data::{Id, Version}, hardware::NetworkInterface, interpret::{InterpretError, InterpretStatus, Outcome}, inventory::Inventory, topology::IpAddress + data::{Id, Version}, executors::SshClient, hardware::NetworkInterface, interpret::{InterpretError, InterpretStatus, Outcome}, inventory::Inventory, topology::IpAddress }, infra::executors::russh::RusshClient}; use crate::domain::{ @@ -54,6 +55,7 @@ impl OPNSenseDhcpInterpret { } } +#[async_trait] impl Interpret for OPNSenseDhcpInterpret { fn get_name(&self) -> InterpretName { InterpretName::OPNSenseDHCP @@ -71,11 +73,15 @@ impl Interpret for OPNSenseDhcpInterpret { todo!() } - fn execute(&self, _inventory: &Inventory) -> Result { + async fn execute(&self, _inventory: &Inventory) -> Result { info!("Executing {} on inventory {_inventory:?}", self.get_name()); - let _ssh_client = RusshClient{}; - // ssh_client.test_connection("username", "password"); - todo!() + let ssh_client = RusshClient{}; + + info!("RusshClient initiated"); + ssh_client.test_connection("paul", "paul").await?; + info!("Connection test complete"); + + Ok(Outcome::new(InterpretStatus::SUCCESS, "Connection test successful".to_string())) } } From 87a9ec3ec468e5a591d9a650274957fc5a2eff84 Mon Sep 17 00:00:00 2001 From: Jean-Gabriel Gill-Couture Date: Sun, 8 Sep 2024 11:32:19 -0400 Subject: [PATCH 3/5] wip: FQM topology with OKDHaCluster, not satisfied yet with the cluster topology data structure --- harmony-rs/fqm/src/lib.rs | 1 + harmony-rs/fqm/src/main.rs | 2 +- harmony-rs/fqm/src/topology.rs | 86 +++++++++++++++++ harmony-rs/harmony/src/domain/hardware/mod.rs | 7 +- harmony-rs/harmony/src/domain/topology/mod.rs | 51 ++++++++-- .../harmony/src/domain/topology/network.rs | 94 +++++++++++++++++++ harmony-rs/harmony/src/lib.rs | 3 +- 7 files changed, 231 insertions(+), 13 deletions(-) create mode 100644 harmony-rs/fqm/src/topology.rs create mode 100644 harmony-rs/harmony/src/domain/topology/network.rs diff --git a/harmony-rs/fqm/src/lib.rs b/harmony-rs/fqm/src/lib.rs index e39d3a9..266b60e 100644 --- a/harmony-rs/fqm/src/lib.rs +++ b/harmony-rs/fqm/src/lib.rs @@ -1,4 +1,5 @@ pub mod inventory; +pub mod topology; pub fn add(left: usize, right: usize) -> usize { left + right } diff --git a/harmony-rs/fqm/src/main.rs b/harmony-rs/fqm/src/main.rs index 99b8082..86df6fb 100644 --- a/harmony-rs/fqm/src/main.rs +++ b/harmony-rs/fqm/src/main.rs @@ -18,5 +18,5 @@ async fn main() { let score = OPNSenseDhcpScore::new(InventoryFilter::new(vec![])); let result = maestro.interpret(score).await.unwrap(); info!("{result}"); - }).await; + }).await.unwrap(); } diff --git a/harmony-rs/fqm/src/topology.rs b/harmony-rs/fqm/src/topology.rs new file mode 100644 index 0000000..94638ca --- /dev/null +++ b/harmony-rs/fqm/src/topology.rs @@ -0,0 +1,86 @@ +use std::net::{IpAddr, Ipv4Addr}; + +use harmony::{ + hardware::*, + topology::{ClusterMember, HAClusterTopology, IpAddress, OPNSenseManagement}, +}; + +pub fn fqm_topology() -> HAClusterTopology { + HAClusterTopology { + firewall: vec![ClusterMember { + management: Box::new(OPNSenseManagement::new( + "user".to_string(), + "password".to_string(), + )), + host: Host { + category: HostCategory::Firewall, + network: vec![ + NetworkInterface::new( + "igb0".to_string(), + "00:90:7f:df:2c:1f".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb1".to_string(), + "00:90:7f:df:2c:20".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb2".to_string(), + "00:90:7f:df:2c:21".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb3".to_string(), + "00:90:7f:df:2c:22".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb4".to_string(), + "00:90:7f:df:2c:23".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb5".to_string(), + "00:90:7f:df:2c:24".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb6".to_string(), + "00:90:7f:df:2c:25".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb7".to_string(), + "00:90:7f:df:2c:26".to_string(), + 1_000_000_000, + true, + ), + ], + storage: vec![Storage::new( + StorageConnectionType::Sata6g, + StorageKind::SSD, + 240_000_000_000, + "TODO".to_string(), + )], + labels: vec![Label::new( + "operatingSystem".to_string(), + "opnsense".to_string(), + )], + }, + }], + control_plane: todo!(), + workers: todo!(), + ceph_hosts: todo!(), + switch: todo!(), + gateway: IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), + load_balancer: IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), + } +} diff --git a/harmony-rs/harmony/src/domain/hardware/mod.rs b/harmony-rs/harmony/src/domain/hardware/mod.rs index 32de3e1..f6a4e20 100644 --- a/harmony-rs/harmony/src/domain/hardware/mod.rs +++ b/harmony-rs/harmony/src/domain/hardware/mod.rs @@ -20,8 +20,9 @@ pub enum HostCategory { #[derive(Debug, new)] pub struct NetworkInterface { - speed: u64, + name: String, mac_address: MacAddress, + speed: u64, plugged_in: bool, } type MacAddress = String; @@ -40,7 +41,7 @@ pub enum StorageKind { NVME, HDD, } -#[derive(Debug)] +#[derive(Debug, new)] pub struct Storage { connection: StorageConnectionType, kind: StorageKind, @@ -56,7 +57,7 @@ pub struct Switch { #[derive(Debug)] pub struct Firewall {} -#[derive(Debug)] +#[derive(Debug, new)] pub struct Label { name: String, value: String, diff --git a/harmony-rs/harmony/src/domain/topology/mod.rs b/harmony-rs/harmony/src/domain/topology/mod.rs index a8013b1..4ab5c9d 100644 --- a/harmony-rs/harmony/src/domain/topology/mod.rs +++ b/harmony-rs/harmony/src/domain/topology/mod.rs @@ -1,13 +1,48 @@ +mod network; +pub use network::*; + use std::net::IpAddr; -use super::hardware::HostGroup; +use derive_new::new; -pub struct OKDHACluster { - firewall: HostGroup, - control_plane: HostGroup, - workers: HostGroup, - ceph_hosts: HostGroup, - switch: HostGroup, +use super::hardware::{Host, HostGroup}; + +pub struct HAClusterTopology { + pub gateway: IpAddress, + pub load_balancer: IpAddress, + pub firewall: Box, + pub dhcp_server: Box, + pub dns_server: Box, + pub control_plane: Vec, + pub workers: Vec, + pub ceph_hosts: Vec, + pub switch: Vec, } -pub struct IpAddress(IpAddr); +pub type IpAddress = IpAddr; + +pub struct ClusterMember { + pub management: Box, + pub host: Host, +} + +pub trait ManagementInterface { + fn boot_to_pxe(&self); + fn get_ip(&self) -> IpAddress; +} + +#[derive(new)] +pub struct OPNSenseManagement { + username: String, + password: String, +} + +impl ManagementInterface for OPNSenseManagement { + fn boot_to_pxe(&self) { + todo!() + } + + fn get_ip(&self) -> IpAddress { + todo!() + } +} diff --git a/harmony-rs/harmony/src/domain/topology/network.rs b/harmony-rs/harmony/src/domain/topology/network.rs new file mode 100644 index 0000000..abae511 --- /dev/null +++ b/harmony-rs/harmony/src/domain/topology/network.rs @@ -0,0 +1,94 @@ +use std::net::{IpAddr, Ipv4Addr}; + +pub trait Firewall { + fn add_rule(&mut self, rule: FirewallRule) -> Result<(), FirewallError>; + fn remove_rule(&mut self, rule_id: &str) -> Result<(), FirewallError>; + fn list_rules(&self) -> Vec; +} + +pub trait DhcpServer { + fn add_static_mapping(&mut self, mac: MacAddress, ip: Ipv4Addr) -> Result<(), DhcpError>; + fn remove_static_mapping(&mut self, mac: &MacAddress) -> Result<(), DhcpError>; + fn list_static_mappings(&self) -> Vec<(MacAddress, Ipv4Addr)>; +} + +pub trait DnsServer { + fn add_record(&mut self, name: &str, record_type: DnsRecordType, value: &str) -> Result<(), DnsError>; + fn remove_record(&mut self, name: &str, record_type: DnsRecordType) -> Result<(), DnsError>; + fn list_records(&self) -> Vec; +} + +pub trait LoadBalancer { + fn add_backend(&mut self, backend: Backend) -> Result<(), LoadBalancerError>; + fn remove_backend(&mut self, backend_id: &str) -> Result<(), LoadBalancerError>; + fn add_frontend(&mut self, frontend: Frontend) -> Result<(), LoadBalancerError>; + fn remove_frontend(&mut self, frontend_id: &str) -> Result<(), LoadBalancerError>; + fn list_backends(&self) -> Vec; + fn list_frontends(&self) -> Vec; +} + +// Supporting types + +#[derive(Clone, Debug)] +pub struct FirewallRule { + pub id: String, + pub source: IpAddr, + pub destination: IpAddr, + pub port: u16, + pub protocol: Protocol, + pub action: Action, +} + +#[derive(Clone, Debug)] +pub enum Protocol { + TCP, + UDP, + ICMP, +} + +#[derive(Clone, Debug)] +pub enum Action { + Allow, + Deny, +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub struct MacAddress([u8; 6]); + +#[derive(Clone, Debug)] +pub enum DnsRecordType { + A, + AAAA, + CNAME, + MX, + TXT, +} + +#[derive(Clone, Debug)] +pub struct DnsRecord { + pub name: String, + pub record_type: DnsRecordType, + pub value: String, +} + +#[derive(Clone, Debug)] +pub struct Backend { + pub id: String, + pub ip: IpAddr, + pub port: u16, + pub weight: u8, +} + +#[derive(Clone, Debug)] +pub struct Frontend { + pub id: String, + pub ip: IpAddr, + pub port: u16, + pub backend_ids: Vec, +} + +// Error types +pub struct FirewallError; +pub struct DhcpError; +pub struct DnsError; +pub struct LoadBalancerError; diff --git a/harmony-rs/harmony/src/lib.rs b/harmony-rs/harmony/src/lib.rs index 8c3d0f6..be55110 100644 --- a/harmony-rs/harmony/src/lib.rs +++ b/harmony-rs/harmony/src/lib.rs @@ -1,3 +1,4 @@ -pub mod domain; +mod domain; +pub use domain::*; pub mod infra; pub mod modules; From ff3d53c70449344edcd61471079b862a8b0e4a35 Mon Sep 17 00:00:00 2001 From: Jean-Gabriel Gill-Couture Date: Sun, 8 Sep 2024 19:06:21 -0400 Subject: [PATCH 4/5] wip: Working hard on topology, seems to have something that may work, next step is put the building blocks together for real --- harmony-rs/Cargo.lock | 8 ++ harmony-rs/Cargo.toml | 1 + harmony-rs/fqm/Cargo.toml | 1 + harmony-rs/fqm/src/inventory.rs | 23 ----- harmony-rs/fqm/src/inventory/mod.rs | 82 ++++++++++++++++ harmony-rs/fqm/src/main.rs | 7 +- harmony-rs/fqm/src/topology.rs | 98 ++++--------------- harmony-rs/harmony/Cargo.toml | 1 + harmony-rs/harmony/src/domain/hardware/mod.rs | 4 +- .../src/domain/topology/load_balancer.rs | 27 +++++ harmony-rs/harmony/src/domain/topology/mod.rs | 35 +++---- .../harmony/src/domain/topology/network.rs | 43 ++------ .../harmony/src/domain/topology/router.rs | 25 +++++ harmony-rs/harmony/src/infra/mod.rs | 1 + harmony-rs/harmony/src/infra/opnsense/mod.rs | 78 +++++++++++++++ 15 files changed, 267 insertions(+), 167 deletions(-) delete mode 100644 harmony-rs/fqm/src/inventory.rs create mode 100644 harmony-rs/fqm/src/inventory/mod.rs create mode 100644 harmony-rs/harmony/src/domain/topology/load_balancer.rs create mode 100644 harmony-rs/harmony/src/domain/topology/router.rs create mode 100644 harmony-rs/harmony/src/infra/opnsense/mod.rs diff --git a/harmony-rs/Cargo.lock b/harmony-rs/Cargo.lock index db8e801..241c91c 100644 --- a/harmony-rs/Cargo.lock +++ b/harmony-rs/Cargo.lock @@ -282,6 +282,12 @@ dependencies = [ "cpufeatures", ] +[[package]] +name = "cidr" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6bdf600c45bd958cf2945c445264471cca8b6c8e67bc87b71affd6d7e5682621" + [[package]] name = "cipher" version = "0.4.4" @@ -620,6 +626,7 @@ dependencies = [ name = "fqm" version = "0.1.0" dependencies = [ + "cidr", "env_logger", "harmony", "log", @@ -794,6 +801,7 @@ name = "harmony" version = "0.1.0" dependencies = [ "async-trait", + "cidr", "derive-new", "env_logger", "libredfish", diff --git a/harmony-rs/Cargo.toml b/harmony-rs/Cargo.toml index 3b9fa25..44002db 100644 --- a/harmony-rs/Cargo.toml +++ b/harmony-rs/Cargo.toml @@ -16,3 +16,4 @@ env_logger = "0.11.5" derive-new = "0.7.0" async-trait = "0.1.82" tokio = { version = "1.40.0", features = ["io-std"] } +cidr = "0.2.3" diff --git a/harmony-rs/fqm/Cargo.toml b/harmony-rs/fqm/Cargo.toml index 3a9ebdc..c04bebb 100644 --- a/harmony-rs/fqm/Cargo.toml +++ b/harmony-rs/fqm/Cargo.toml @@ -8,4 +8,5 @@ harmony = { path = "../harmony" } log = { workspace = true } env_logger = { workspace = true } tokio = { workspace = true } +cidr = { workspace = true } diff --git a/harmony-rs/fqm/src/inventory.rs b/harmony-rs/fqm/src/inventory.rs deleted file mode 100644 index 9efcefd..0000000 --- a/harmony-rs/fqm/src/inventory.rs +++ /dev/null @@ -1,23 +0,0 @@ -use harmony::domain::{ - hardware::{Host, HostCategory, Location, NetworkInterface}, - inventory::Inventory, -}; - -pub fn get_inventory() -> Inventory { - let network = vec![NetworkInterface::new(1_000_000_000, "TODO MAC ADDRESS".into(), true ) ]; - let storage = vec![]; - Inventory { - location: Location::new( - "1134 Grande Allée Ouest 1er étage, Québec, Qc".into(), - "FQM 1134 1er étage".into(), - ), - host: vec![Host { - category: HostCategory::Server, - network, - storage, - labels: vec![], - }], - switch: vec![], - firewall: vec![], - } -} diff --git a/harmony-rs/fqm/src/inventory/mod.rs b/harmony-rs/fqm/src/inventory/mod.rs new file mode 100644 index 0000000..5f0bd53 --- /dev/null +++ b/harmony-rs/fqm/src/inventory/mod.rs @@ -0,0 +1,82 @@ +use harmony::{ + hardware::{Host, HostCategory, Label, Location, NetworkInterface, Storage, StorageConnectionType, StorageKind}, + inventory::Inventory, +}; + +pub fn get_inventory() -> Inventory { + Inventory { + location: Location::new( + "1134 Grande Allée Ouest 1er étage, Québec, Qc".into(), + "FQM 1134 1er étage".into(), + ), + host: vec![], + switch: vec![], + firewall: vec![get_firewall_1()], + } +} + +fn get_firewall_1() -> Host { + Host { + category: HostCategory::Firewall, + network: vec![ + NetworkInterface::new( + "igb0".to_string(), + "00:90:7f:df:2c:1f".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb1".to_string(), + "00:90:7f:df:2c:20".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb2".to_string(), + "00:90:7f:df:2c:21".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb3".to_string(), + "00:90:7f:df:2c:22".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb4".to_string(), + "00:90:7f:df:2c:23".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb5".to_string(), + "00:90:7f:df:2c:24".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb6".to_string(), + "00:90:7f:df:2c:25".to_string(), + 1_000_000_000, + true, + ), + NetworkInterface::new( + "igb7".to_string(), + "00:90:7f:df:2c:26".to_string(), + 1_000_000_000, + true, + ), + ], + storage: vec![Storage::new( + StorageConnectionType::Sata6g, + StorageKind::SSD, + 240_000_000_000, + "TODO".to_string(), + )], + labels: vec![Label::new( + "operatingSystem".to_string(), + "opnsense".to_string(), + )], + } +} diff --git a/harmony-rs/fqm/src/main.rs b/harmony-rs/fqm/src/main.rs index 86df6fb..26f0579 100644 --- a/harmony-rs/fqm/src/main.rs +++ b/harmony-rs/fqm/src/main.rs @@ -1,9 +1,7 @@ -use fqm::inventory::get_inventory; +use fqm::{inventory::get_inventory, topology::fqm_topology}; use harmony::{ - domain::{ - inventory::{Inventory, InventoryFilter}, + inventory::InventoryFilter, maestro::Maestro, - }, modules::opnsense_dhcp::OPNSenseDhcpScore, }; use log::info; @@ -15,6 +13,7 @@ async fn main() { tokio::spawn(async move { info!("FQM Harmony Starting"); let maestro = Maestro::new(get_inventory()); + let topology = fqm_topology(); let score = OPNSenseDhcpScore::new(InventoryFilter::new(vec![])); let result = maestro.interpret(score).await.unwrap(); info!("{result}"); diff --git a/harmony-rs/fqm/src/topology.rs b/harmony-rs/fqm/src/topology.rs index 94638ca..abcc112 100644 --- a/harmony-rs/fqm/src/topology.rs +++ b/harmony-rs/fqm/src/topology.rs @@ -1,86 +1,24 @@ -use std::net::{IpAddr, Ipv4Addr}; +use std::net::Ipv4Addr; -use harmony::{ - hardware::*, - topology::{ClusterMember, HAClusterTopology, IpAddress, OPNSenseManagement}, -}; +use cidr::Ipv4Cidr; +use harmony::infra::opnsense::OPNSenseFirewall; +use harmony::topology::{HAClusterTopology, IpAddress, UnmanagedRouter}; pub fn fqm_topology() -> HAClusterTopology { + let opnsense_firewall = Box::new(OPNSenseFirewall::new(IpAddress::V4(Ipv4Addr::new(10, 10, 8, 2)))); + HAClusterTopology { - firewall: vec![ClusterMember { - management: Box::new(OPNSenseManagement::new( - "user".to_string(), - "password".to_string(), - )), - host: Host { - category: HostCategory::Firewall, - network: vec![ - NetworkInterface::new( - "igb0".to_string(), - "00:90:7f:df:2c:1f".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb1".to_string(), - "00:90:7f:df:2c:20".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb2".to_string(), - "00:90:7f:df:2c:21".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb3".to_string(), - "00:90:7f:df:2c:22".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb4".to_string(), - "00:90:7f:df:2c:23".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb5".to_string(), - "00:90:7f:df:2c:24".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb6".to_string(), - "00:90:7f:df:2c:25".to_string(), - 1_000_000_000, - true, - ), - NetworkInterface::new( - "igb7".to_string(), - "00:90:7f:df:2c:26".to_string(), - 1_000_000_000, - true, - ), - ], - storage: vec![Storage::new( - StorageConnectionType::Sata6g, - StorageKind::SSD, - 240_000_000_000, - "TODO".to_string(), - )], - labels: vec![Label::new( - "operatingSystem".to_string(), - "opnsense".to_string(), - )], - }, - }], - control_plane: todo!(), - workers: todo!(), - ceph_hosts: todo!(), - switch: todo!(), - gateway: IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), - load_balancer: IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), + firewall: opnsense_firewall.clone(), + control_plane: vec![], + ceph_hosts: vec![], + switch: vec![], + router: Box::new(UnmanagedRouter::new( + IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), + Ipv4Cidr::new(Ipv4Addr::new(10, 10, 8, 0), 22).expect("Subnet is valid"), + )), + load_balancer: opnsense_firewall.clone(), + dhcp_server: opnsense_firewall.clone(), + dns_server: opnsense_firewall.clone(), + workers: vec![], } } diff --git a/harmony-rs/harmony/Cargo.toml b/harmony-rs/harmony/Cargo.toml index 0108040..17b07da 100644 --- a/harmony-rs/harmony/Cargo.toml +++ b/harmony-rs/harmony/Cargo.toml @@ -16,3 +16,4 @@ derive-new = { workspace = true } log = { workspace = true } env_logger = { workspace = true } async-trait = { workspace = true } +cidr = { workspace = true } diff --git a/harmony-rs/harmony/src/domain/hardware/mod.rs b/harmony-rs/harmony/src/domain/hardware/mod.rs index f6a4e20..ef03260 100644 --- a/harmony-rs/harmony/src/domain/hardware/mod.rs +++ b/harmony-rs/harmony/src/domain/hardware/mod.rs @@ -2,7 +2,7 @@ use derive_new::new; pub type HostGroup = Vec; pub type SwitchGroup = Vec; -pub type FirewallGroup = Vec; +pub type FirewallGroup = Vec; #[derive(Debug)] pub struct Host { pub category: HostCategory, @@ -55,8 +55,6 @@ pub struct Switch { management_interface: NetworkInterface, } -#[derive(Debug)] -pub struct Firewall {} #[derive(Debug, new)] pub struct Label { name: String, diff --git a/harmony-rs/harmony/src/domain/topology/load_balancer.rs b/harmony-rs/harmony/src/domain/topology/load_balancer.rs new file mode 100644 index 0000000..0259072 --- /dev/null +++ b/harmony-rs/harmony/src/domain/topology/load_balancer.rs @@ -0,0 +1,27 @@ +use super::IpAddress; + +pub trait LoadBalancer { + fn add_backend(&mut self, backend: Backend) -> Result<(), LoadBalancerError>; + fn remove_backend(&mut self, backend_id: &str) -> Result<(), LoadBalancerError>; + fn add_frontend(&mut self, frontend: Frontend) -> Result<(), LoadBalancerError>; + fn remove_frontend(&mut self, frontend_id: &str) -> Result<(), LoadBalancerError>; + fn list_backends(&self) -> Vec; + fn list_frontends(&self) -> Vec; +} +pub struct LoadBalancerError; + +#[derive(Clone, Debug)] +pub struct Backend { + pub id: String, + pub ip: IpAddress, + pub port: u16, + pub weight: u8, +} + +#[derive(Clone, Debug)] +pub struct Frontend { + pub id: String, + pub ip: IpAddress, + pub port: u16, + pub backend_ids: Vec, +} diff --git a/harmony-rs/harmony/src/domain/topology/mod.rs b/harmony-rs/harmony/src/domain/topology/mod.rs index 4ab5c9d..27507dd 100644 --- a/harmony-rs/harmony/src/domain/topology/mod.rs +++ b/harmony-rs/harmony/src/domain/topology/mod.rs @@ -1,18 +1,20 @@ +mod router; +mod load_balancer; +pub use router::*; +pub use load_balancer::*; mod network; pub use network::*; use std::net::IpAddr; -use derive_new::new; - -use super::hardware::{Host, HostGroup}; +use super::hardware::Host; pub struct HAClusterTopology { - pub gateway: IpAddress, - pub load_balancer: IpAddress, - pub firewall: Box, - pub dhcp_server: Box, - pub dns_server: Box, + pub router: Box, + pub load_balancer: Box, + pub firewall: Box, + pub dhcp_server: Box, + pub dns_server: Box, pub control_plane: Vec, pub workers: Vec, pub ceph_hosts: Vec, @@ -22,7 +24,7 @@ pub struct HAClusterTopology { pub type IpAddress = IpAddr; pub struct ClusterMember { - pub management: Box, + pub management: Box, pub host: Host, } @@ -31,18 +33,3 @@ pub trait ManagementInterface { fn get_ip(&self) -> IpAddress; } -#[derive(new)] -pub struct OPNSenseManagement { - username: String, - password: String, -} - -impl ManagementInterface for OPNSenseManagement { - fn boot_to_pxe(&self) { - todo!() - } - - fn get_ip(&self) -> IpAddress { - todo!() - } -} diff --git a/harmony-rs/harmony/src/domain/topology/network.rs b/harmony-rs/harmony/src/domain/topology/network.rs index abae511..4bc8cf2 100644 --- a/harmony-rs/harmony/src/domain/topology/network.rs +++ b/harmony-rs/harmony/src/domain/topology/network.rs @@ -1,15 +1,20 @@ -use std::net::{IpAddr, Ipv4Addr}; +use super::IpAddress; pub trait Firewall { fn add_rule(&mut self, rule: FirewallRule) -> Result<(), FirewallError>; fn remove_rule(&mut self, rule_id: &str) -> Result<(), FirewallError>; fn list_rules(&self) -> Vec; + fn get_ip(&self) -> IpAddress; +} + +pub struct NetworkDomain { + pub name: String } pub trait DhcpServer { - fn add_static_mapping(&mut self, mac: MacAddress, ip: Ipv4Addr) -> Result<(), DhcpError>; + fn add_static_mapping(&mut self, mac: MacAddress, ip: IpAddress) -> Result<(), DhcpError>; fn remove_static_mapping(&mut self, mac: &MacAddress) -> Result<(), DhcpError>; - fn list_static_mappings(&self) -> Vec<(MacAddress, Ipv4Addr)>; + fn list_static_mappings(&self) -> Vec<(MacAddress, IpAddress)>; } pub trait DnsServer { @@ -18,22 +23,11 @@ pub trait DnsServer { fn list_records(&self) -> Vec; } -pub trait LoadBalancer { - fn add_backend(&mut self, backend: Backend) -> Result<(), LoadBalancerError>; - fn remove_backend(&mut self, backend_id: &str) -> Result<(), LoadBalancerError>; - fn add_frontend(&mut self, frontend: Frontend) -> Result<(), LoadBalancerError>; - fn remove_frontend(&mut self, frontend_id: &str) -> Result<(), LoadBalancerError>; - fn list_backends(&self) -> Vec; - fn list_frontends(&self) -> Vec; -} - -// Supporting types - #[derive(Clone, Debug)] pub struct FirewallRule { pub id: String, - pub source: IpAddr, - pub destination: IpAddr, + pub source: IpAddress, + pub destination: IpAddress, pub port: u16, pub protocol: Protocol, pub action: Action, @@ -71,24 +65,7 @@ pub struct DnsRecord { pub value: String, } -#[derive(Clone, Debug)] -pub struct Backend { - pub id: String, - pub ip: IpAddr, - pub port: u16, - pub weight: u8, -} - -#[derive(Clone, Debug)] -pub struct Frontend { - pub id: String, - pub ip: IpAddr, - pub port: u16, - pub backend_ids: Vec, -} - // Error types pub struct FirewallError; pub struct DhcpError; pub struct DnsError; -pub struct LoadBalancerError; diff --git a/harmony-rs/harmony/src/domain/topology/router.rs b/harmony-rs/harmony/src/domain/topology/router.rs new file mode 100644 index 0000000..8e82503 --- /dev/null +++ b/harmony-rs/harmony/src/domain/topology/router.rs @@ -0,0 +1,25 @@ +use cidr::Ipv4Cidr; +use derive_new::new; + +use super::IpAddress; + +pub trait Router { + fn get_gateway(&self) -> IpAddress; + fn get_cidr(&self) -> Ipv4Cidr; +} + +#[derive(new)] +pub struct UnmanagedRouter { + gateway: IpAddress, + cidr: Ipv4Cidr, +} + +impl Router for UnmanagedRouter { + fn get_gateway(&self) -> IpAddress { + self.gateway.clone() + } + + fn get_cidr(&self) -> Ipv4Cidr { + self.cidr.clone() + } +} diff --git a/harmony-rs/harmony/src/infra/mod.rs b/harmony-rs/harmony/src/infra/mod.rs index 7c47003..e6d5fbf 100644 --- a/harmony-rs/harmony/src/infra/mod.rs +++ b/harmony-rs/harmony/src/infra/mod.rs @@ -1 +1,2 @@ pub mod executors; +pub mod opnsense; diff --git a/harmony-rs/harmony/src/infra/opnsense/mod.rs b/harmony-rs/harmony/src/infra/opnsense/mod.rs new file mode 100644 index 0000000..3def185 --- /dev/null +++ b/harmony-rs/harmony/src/infra/opnsense/mod.rs @@ -0,0 +1,78 @@ +use derive_new::new; +use crate::topology::{Backend, DhcpServer, DnsServer, Firewall, FirewallError, FirewallRule, Frontend, IpAddress, LoadBalancer, LoadBalancerError}; + +#[derive(new, Clone)] +pub struct OPNSenseFirewall { + ip_address: IpAddress, +} + +impl Firewall for OPNSenseFirewall { + fn add_rule(&mut self, _rule: FirewallRule) -> Result<(), FirewallError> { + todo!() + } + + fn remove_rule(&mut self, _rule_id: &str) -> Result<(), FirewallError> { + todo!() + } + + fn list_rules(&self) -> Vec { + todo!() + } + + fn get_ip(&self) -> IpAddress { + self.ip_address.clone() + } +} + +impl LoadBalancer for OPNSenseFirewall { + fn add_backend(&mut self, _backend: Backend) -> Result<(), LoadBalancerError> { + todo!() + } + + fn remove_backend(&mut self, _backend_id: &str) -> Result<(), LoadBalancerError> { + todo!() + } + + fn add_frontend(&mut self, _frontend: Frontend) -> Result<(), LoadBalancerError> { + todo!() + } + + fn remove_frontend(&mut self, _frontend_id: &str) -> Result<(), LoadBalancerError> { + todo!() + } + + fn list_backends(&self) -> Vec { + todo!() + } + + fn list_frontends(&self) -> Vec { + todo!() + } +} + +impl DhcpServer for OPNSenseFirewall { + fn add_static_mapping(&mut self, mac: crate::topology::MacAddress, ip: IpAddress) -> Result<(), crate::topology::DhcpError> { + todo!() + } + + fn remove_static_mapping(&mut self, mac: &crate::topology::MacAddress) -> Result<(), crate::topology::DhcpError> { + todo!() + } + + fn list_static_mappings(&self) -> Vec<(crate::topology::MacAddress, IpAddress)> { + todo!() + } +} +impl DnsServer for OPNSenseFirewall { + fn add_record(&mut self, name: &str, record_type: crate::topology::DnsRecordType, value: &str) -> Result<(), crate::topology::DnsError> { + todo!() + } + + fn remove_record(&mut self, name: &str, record_type: crate::topology::DnsRecordType) -> Result<(), crate::topology::DnsError> { + todo!() + } + + fn list_records(&self) -> Vec { + todo!() + } +} From df714e216a8b2f328d6f19e785a7a285be667201 Mon Sep 17 00:00:00 2001 From: Jean-Gabriel Gill-Couture Date: Sun, 8 Sep 2024 22:42:29 -0400 Subject: [PATCH 5/5] feat: Topology, inventory, score, its all coming together and compiles. I think its very usable as a first alpha version. Game on --- harmony-rs/fqm/src/main.rs | 7 ++--- harmony-rs/fqm/src/topology.rs | 5 ++-- harmony-rs/harmony/src/domain/hardware/mod.rs | 16 +++++----- .../harmony/src/domain/interpret/mod.rs | 4 +-- harmony-rs/harmony/src/domain/maestro/mod.rs | 5 ++-- harmony-rs/harmony/src/domain/score.rs | 2 +- .../src/domain/topology/load_balancer.rs | 10 ++++++- harmony-rs/harmony/src/domain/topology/mod.rs | 30 ++++++++++++------- .../harmony/src/domain/topology/network.rs | 25 ++++++++++++++-- .../harmony/src/domain/topology/router.rs | 10 ++++++- .../harmony/src/infra/executors/russh/mod.rs | 1 - harmony-rs/harmony/src/infra/opnsense/mod.rs | 20 ++++++++++--- .../harmony/src/modules/opnsense_dhcp.rs | 18 +++++------ 13 files changed, 105 insertions(+), 48 deletions(-) diff --git a/harmony-rs/fqm/src/main.rs b/harmony-rs/fqm/src/main.rs index 26f0579..76b679a 100644 --- a/harmony-rs/fqm/src/main.rs +++ b/harmony-rs/fqm/src/main.rs @@ -1,7 +1,6 @@ use fqm::{inventory::get_inventory, topology::fqm_topology}; use harmony::{ - inventory::InventoryFilter, - maestro::Maestro, + maestro::Maestro, modules::opnsense_dhcp::OPNSenseDhcpScore, }; use log::info; @@ -12,9 +11,9 @@ async fn main() { tokio::spawn(async move { info!("FQM Harmony Starting"); - let maestro = Maestro::new(get_inventory()); let topology = fqm_topology(); - let score = OPNSenseDhcpScore::new(InventoryFilter::new(vec![])); + let maestro = Maestro::new(get_inventory(), topology.clone()); + let score = OPNSenseDhcpScore::new(topology); let result = maestro.interpret(score).await.unwrap(); info!("{result}"); }).await.unwrap(); diff --git a/harmony-rs/fqm/src/topology.rs b/harmony-rs/fqm/src/topology.rs index abcc112..520a375 100644 --- a/harmony-rs/fqm/src/topology.rs +++ b/harmony-rs/fqm/src/topology.rs @@ -1,18 +1,19 @@ use std::net::Ipv4Addr; +use std::sync::Arc; use cidr::Ipv4Cidr; use harmony::infra::opnsense::OPNSenseFirewall; use harmony::topology::{HAClusterTopology, IpAddress, UnmanagedRouter}; pub fn fqm_topology() -> HAClusterTopology { - let opnsense_firewall = Box::new(OPNSenseFirewall::new(IpAddress::V4(Ipv4Addr::new(10, 10, 8, 2)))); + let opnsense_firewall = Arc::new(OPNSenseFirewall::new(IpAddress::V4(Ipv4Addr::new(10, 10, 8, 2)))); HAClusterTopology { firewall: opnsense_firewall.clone(), control_plane: vec![], ceph_hosts: vec![], switch: vec![], - router: Box::new(UnmanagedRouter::new( + router: Arc::new(UnmanagedRouter::new( IpAddress::V4(Ipv4Addr::new(10, 10, 8, 1)), Ipv4Cidr::new(Ipv4Addr::new(10, 10, 8, 0), 22).expect("Subnet is valid"), )), diff --git a/harmony-rs/harmony/src/domain/hardware/mod.rs b/harmony-rs/harmony/src/domain/hardware/mod.rs index ef03260..4072946 100644 --- a/harmony-rs/harmony/src/domain/hardware/mod.rs +++ b/harmony-rs/harmony/src/domain/hardware/mod.rs @@ -3,7 +3,7 @@ use derive_new::new; pub type HostGroup = Vec; pub type SwitchGroup = Vec; pub type FirewallGroup = Vec; -#[derive(Debug)] +#[derive(Debug, Clone)] pub struct Host { pub category: HostCategory, pub network: Vec, @@ -11,14 +11,14 @@ pub struct Host { pub labels: Vec