]> gitweb.michael.orlitzky.com - hath.git/blobdiff - hath.cabal
Switch from test-framework to tasty.
[hath.git] / hath.cabal
index 4431b842b625a9f285f88933bbbae73679c319e1..9f2d972dcdaefd217b10ecca5f97eb5c90143bc5 100644 (file)
@@ -1,9 +1,16 @@
 name:           hath
-version:        0.0.1
+version:        0.1.3
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>
+category:       Utils
+license:        GPL-3
+license-file:   doc/LICENSE
 build-type:     Simple
+extra-source-files:
+  doc/man1/hath.1
+  test/shell/*.test
+  test/shell-net/*.test
 synopsis:
   Hath manipulates network blocks in CIDR notation.
 description:
@@ -19,7 +26,11 @@ description:
   .
     * View the result of block combination in a useful way.
   .
-  Hath has four modes to perform these functions:
+    * List them.
+  .
+    * Find their associated PTR records.
+  .
+  Hath has several modes to perform these functions:
   .
     [@Regexed@]
     This computes a (Perl-compatible) regular expression matching
@@ -38,9 +49,24 @@ description:
     [@Diffed@]
     Shows what would change if you used reduce. Uses diff-like
     notation.
+  .
+    [@Listed@]
+    List the IP addresses contained within the given CIDRs.
+  .
+    [@Reversed@]
+    Perform reverse DNS (PTR) lookups on the IP addresses contained
+    within the given CIDRs.
   .
   /Examples/:
   .
+  Compute a (Perl-compatible) regular expression matching
+  the input CIDR blocks. It's the default mode of operation.
+  .
+  @
+  $ hath <<< \"10.0.0.0\/29 10.0.0.8\/29\"
+  ((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0))
+  @
+  .
   Combine two \/24s into a \/23:
   .
   @
@@ -48,22 +74,48 @@ description:
   10.0.0.0/23
   @
   .
-  Create a perl-compatible regex to be fed to grep:
+  List the addresses in 192.168.0.240\/29:
+  .
+  @
+  $ hath listed <<< 192.168.0.240\/29
+  192.168.0.240
+  192.168.0.241
+  192.168.0.242
+  192.168.0.243
+  192.168.0.244
+  192.168.0.245
+  192.168.0.246
+  192.168.0.247
+  @
+  .
+  Perform PTR lookups on all of 198.41.0.4\/30:
+  .
+  @
+  $ hath reversed <<< 198.41.0.4\/30
+  198.41.0.4: a.root-servers.net.
+  198.41.0.5:
+  198.41.0.6: rs.internic.net.
+  198.41.0.7:
+  @
+  .
+  The DNS lookups are usually the bottleneck for this mode, but we can
+  perform them in parallel. Simply pass the number of threads to the
+  GHC runtime on the command line; for example, the following will
+  perform 25 lookups in parallel:
   .
   @
-  $ grep -P `hath regexed -i cidrs.txt` mail.log
+  $ hath reversed +RTS -N25 <<< 198.41.0.4\/24
+  198.41.0.4: a.root-servers.net.
+  198.41.0.5:
+  198.41.0.6: rs.internic.net.
+  ...
   @
+  .
+  The command-line syntax and complete set of options are documented in
+  the man page.
+
 
 executable hath
-  build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
-    MissingH                    == 1.2.*,
-    split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
 
   main-is:
     Main.hs
@@ -71,6 +123,30 @@ executable hath
   hs-source-dirs:
     src/
 
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    DNS
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
+  build-depends:
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    cmdargs                     == 0.10.*,
+    dns                         >= 1.2,
+    MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
+    QuickCheck                  == 2.7.*,
+    split                       == 0.2.*,
+    tasty                       == 0.8.*,
+    tasty-hunit                 == 0.8.*,
+    tasty-quickcheck            == 0.8.*
+
   ghc-options:
     -Wall
     -fwarn-hi-shadowing
@@ -98,15 +174,20 @@ test-suite testsuite
   type: exitcode-stdio-1.0
   hs-source-dirs: src test
   main-is: TestSuite.hs
+
   build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    cmdargs                     == 0.10.*,
+    dns                         >= 1.2,
     MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
+    QuickCheck                  == 2.7.*,
     split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
+    tasty                       == 0.8.*,
+    tasty-hunit                 == 0.8.*,
+    tasty-quickcheck            == 0.8.*
+
 
   -- It's not entirely clear to me why I have to reproduce all of this.
   ghc-options:
@@ -126,6 +207,85 @@ test-suite testsuite
     -optc-march=native
     -O2
 
+
+-- These won't work without shelltestrunner installed in your
+-- $PATH. Maybe there is some way to tell Cabal that.
+test-suite shelltests
+  type: exitcode-stdio-1.0
+  hs-source-dirs: test
+  main-is: ShellTests.hs
+
+  build-depends:
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    cmdargs                     == 0.10.*,
+    dns                         >= 1.2,
+    MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
+    process                     == 1.1.*,
+    QuickCheck                  == 2.7.*,
+    split                       == 0.2.*,
+    tasty                       == 0.8.*,
+    tasty-hunit                 == 0.8.*,
+    tasty-quickcheck            == 0.8.*
+
+  -- It's not entirely clear to me why I have to reproduce all of this.
+  ghc-options:
+    -Wall
+    -fwarn-hi-shadowing
+    -fwarn-missing-signatures
+    -fwarn-name-shadowing
+    -fwarn-orphans
+    -fwarn-type-defaults
+    -fwarn-tabs
+    -fwarn-incomplete-record-updates
+    -fwarn-monomorphism-restriction
+    -fwarn-unused-do-bind
+    -rtsopts
+    -threaded
+    -optc-O3
+    -optc-march=native
+    -O2
+
+
+test-suite shelltests-net
+  type: exitcode-stdio-1.0
+  hs-source-dirs: test
+  main-is: ShellTestsNet.hs
+
+  build-depends:
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    cmdargs                     == 0.10.*,
+    dns                         >= 1.2,
+    MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
+    process                     == 1.1.*,
+    QuickCheck                  == 2.7.*,
+    split                       == 0.2.*,
+    tasty                       == 0.8.*,
+    tasty-hunit                 == 0.8.*,
+    tasty-quickcheck            == 0.8.*
+
+  -- It's not entirely clear to me why I have to reproduce all of this.
+  ghc-options:
+    -Wall
+    -fwarn-hi-shadowing
+    -fwarn-missing-signatures
+    -fwarn-name-shadowing
+    -fwarn-orphans
+    -fwarn-type-defaults
+    -fwarn-tabs
+    -fwarn-incomplete-record-updates
+    -fwarn-monomorphism-restriction
+    -fwarn-unused-do-bind
+    -rtsopts
+    -threaded
+    -optc-O3
+    -optc-march=native
+    -O2
+
+
 source-repository head
   type: git
   location: http://michael.orlitzky.com/git/hath.git