legion-extra (empty) → 0.1.0.0
raw patch · 5 files changed
+421/−0 lines, 5 filesdep +aesondep +basedep +bytestringsetup-changed
Dependencies added: aeson, base, bytestring, canteven-log, containers, data-default-class, legion, legion-extra, network, safe, split, yaml
Files
- LICENSE +202/−0
- Setup.hs +2/−0
- legion-extra.cabal +53/−0
- src/Network/Legion/Config.hs +162/−0
- test/Spec.hs +2/−0
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ legion-extra.cabal view
@@ -0,0 +1,53 @@+name: legion-extra+version: 0.1.0.0+synopsis: Extra non-essential utilities for building legion applications.+description: Please see README.md+homepage: https://github.com/owensmurray/legion-extra#readme+license: Apache-2.0+license-file: LICENSE+author: Rick Owens+maintainer: rick@owensmurray.comm+copyright: 2016 Rick Owens+category: value+build-type: Simple+-- extra-source-files:+cabal-version: >=1.10++library+ hs-source-dirs:+ src+ exposed-modules:+ Network.Legion.Config+ build-depends:+ aeson >= 0.11.2.1 && < 0.12,+ base >= 4.8 && < 4.9,+ bytestring >= 0.10.6.0 && < 0.11,+ canteven-log >= 1.0.0.0 && < 1.1,+ containers >= 0.5.6.2 && < 0.6,+ data-default-class >= 0.0.1 && < 0.1,+ legion >= 0.4 && < 0.5,+ network >= 2.6.3.1 && < 2.7,+ safe >= 0.3.9 && < 0.4,+ split >= 0.2.3.1 && < 0.3,+ yaml >= 0.8.18.6 && < 0.9+ default-language:+ Haskell2010++test-suite legion-extra-test+ type:+ exitcode-stdio-1.0+ hs-source-dirs:+ test+ main-is:+ Spec.hs+ build-depends:+ base,+ legion-extra+ ghc-options:+ -threaded -rtsopts -with-rtsopts=-N+ default-language:+ Haskell2010++source-repository head+ type: git+ location: https://github.com/owensmurray/legion-extra
+ src/Network/Legion/Config.hs view
@@ -0,0 +1,162 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{- |+ This module contains a common pattern for parsing the legion runtime+ settings and application-specific configuration from the command+ line. The intent of this module is to implement a very specific and+ simple pattern that some people find useful and to get them there+ with minimum effort; not to be a flexible solution to every problem+ in the domain of configuration, or even to endorse the use of this+ pattern if you think you might need something different.++ This 'parseArgs' function implements a command line parser that accepts+ the usage:++ > <your-program-name>+ > -c <file> --config=<file> REQUIRED - Specifies the config file.+ > -j <host>:<port> --joinTarget=<host>:<port> OPTIONAL - The address of a node in the cluster we want to join.++ The config file is a YAML file, which has the following format:++ > adminAddr: localhost:8080+ > peerAddr: localhost:8022+ > joinAddr: localhost:8023++ In addition to these bindings, an arbitrary set of additional bindings+ may be supplied, and which will be decoded into some 'FromJSON' instance+ type of your choosing. (Note that the @yaml@ package is implemented by+ transforming the YAML input to JSON and then delegating to @aeson@,+ which is why your custom config type must be 'FromJSON', even though+ the config file is YAML format.)++ After parsing the command line and config file, 'parseArgs' will then+ return a tuple containing the legionary runtime settings, the startup+ mode that should be used, and custom application configuration.+-}+module Network.Legion.Config (+ parseArgs+) where++import Data.Aeson (FromJSON, Value(Object), (.:), parseJSON, eitherDecode)+import Data.Default.Class (Default(def))+import Data.List (intercalate)+import Data.List.Split (splitOn)+import Data.String (fromString)+import Network.Legion (StartupMode(JoinCluster, NewCluster),+ RuntimeSettings(RuntimeSettings))+import Network.Socket (SockAddr, addrAddress, getAddrInfo)+import Safe (readMay)+import System.Console.GetOpt (OptDescr(Option), usageInfo, getOpt,+ ArgOrder(Permute), ArgDescr(ReqArg))+import System.Environment (getArgs, getProgName)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Lazy as LBS+++{- | Parse the command line arguments. -}+parseArgs :: (FromJSON userConfig)+ => IO (RuntimeSettings, StartupMode, userConfig)+parseArgs = do+ prog <- getProgName+ getOpt Permute options <$> getArgs >>= \case+ (opts, [], []) ->+ case foldr (.) id opts def of+ Opt Nothing _ ->+ {- No config file. -}+ fail $ "Missing config file: \n\n" ++ usageInfo prog options+ Opt (Just configFile) maybeJoinTarget -> do+ let+ configFail m = fail $+ "Couldn't decode YAML config from file "+ ++ configFile ++ ": " ++ show m+ c <- LBS.fromStrict <$> BS.readFile configFile+ case (eitherDecode c, eitherDecode c) of+ (Left errMsg, _) -> configFail errMsg+ (_, Left errMsg) -> configFail errMsg+ (Right runtimeConfig, Right userConfig) -> do+ mode <- case maybeJoinTarget of+ Nothing -> pure NewCluster+ Just jtDesc -> JoinCluster <$> resolveAddr (parseAddr jtDesc)+ let (adminHost, adminPort) = parseAddr (adminAddr runtimeConfig)+ settings <- RuntimeSettings + <$> (resolveAddr . parseAddr . peerAddr) runtimeConfig+ <*> (resolveAddr . parseAddr . joinAddr) runtimeConfig+ <*> pure (fromString adminHost)+ <*> pure adminPort+ return (settings, mode, userConfig)+ (_, [], errors) ->+ fail (intercalate "\n" (errors ++ [usageInfo prog options]))+ (_, unknown, _) ->+ fail+ $ "Unknown options: " ++ intercalate ", " unknown+ ++ "\n" ++ usageInfo prog options+ where+ options = [+ Option+ ['c']+ ["config"]+ (ReqArg+ (\name opt -> opt {oConfigFile = Just name})+ "<file>"+ )+ "REQUIRED - Specifies the config file.",+ Option+ ['j']+ ["joinTarget"]+ (ReqArg+ (\addr opt -> opt {oJoinTarget = Just addr})+ "<host>:<port>"+ )+ "OPTIONAL - The address of a node in the cluster we want to join."+ ]+++data Config = Config {+ peerAddr :: AddressDescription,+ joinAddr :: AddressDescription,+ adminAddr :: AddressDescription+ }++instance FromJSON Config where+ parseJSON (Object config) = Config+ <$> config .: "peerAddr"+ <*> config .: "joinAddr"+ <*> config .: "adminAddr"+ parseJSON value =+ fail $ "Couldn't parse legion runtime config from " ++ show value+++{- |+ An address description is really just an synonym for a formatted string.++ Examples: @"0.0.0.0:8080"@, @"www.google.com:80"@,+-}+type AddressDescription = String+++{- | Resolve an address description into an actual socket addr. -}+resolveAddr :: (String, Int) -> IO SockAddr+resolveAddr (host, port) =+ addrAddress . head <$> getAddrInfo Nothing (Just host) (Just (show port))+++{- | Parse a <host>:<port> string into its component parts. -}+{- TODO do this better, using a real parser technology, and supporting IPv6. -}+parseAddr :: AddressDescription -> (String, Int)+parseAddr desc = + case splitOn ":" desc of+ [host, portStr] ->+ case readMay portStr of+ Nothing -> error ("Invalid address description: " ++ show desc)+ Just port -> (host, port)+ _ -> error ("Invalid address description: " ++ show desc)+++data Opt = Opt {+ oConfigFile :: Maybe FilePath,+ oJoinTarget :: Maybe AddressDescription+ }+instance Default Opt where+ def = Opt Nothing Nothing++
+ test/Spec.hs view
@@ -0,0 +1,2 @@+main :: IO ()+main = putStrLn "Test suite not yet implemented"