wifi-watch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 697446ea552c7a3457679d63683eca662ffb8f3a
+  data.tar.gz: cbb35fe686254583710005731b65469fb9118eaf
+SHA512:
+  metadata.gz: ba64b8fa9cb33a576390acaaf3807c12b3a47a6b23a2a7babe9dd1527412a4d80033c7e86b5f6f9fa457701f8ff3597740e6c13d38b11d649343945a607cbba3
+  data.tar.gz: 426294ddb194941801ff65d1ca5969595b9b8311d4d67e866ec1febcd38054ac6e3817cf6e623f6b79aa4663398e64373162eb61605708373e72f421f08698d5

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wifi-watch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 John Gorman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,206 @@
+# wifi-watch
+
+Continuously monitor your network speed and quality!
+
+```
+$ wifi-watch
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+16:55  300  298 good   0.7%  250.83 ms
+17:00  300  296 good   1.3%  219.14 ms
+17:03  136   67 good   1.5%  676.17 ms
+```
+
+Run wifi-watch in a terminal so that you can easily check
+your network quality at this moment and how it has been
+holding up since you began recording hours or days ago.
+
+wifi-watch will run ping every second and refresh the
+current line with the current counts. At the end of
+an accounting period the current counts are saved
+as a history line and a new accounting period begins.
+
+This can be invaluable in monitoring your home internet
+for systematic service degradation. Service technicians
+pay attention when you can give them exact ping times
+and packet loss history!
+
+It is also a very helpful in public wifi environments
+to be able to see how the shared bandwidth is holding up
+on a moment to moment basis.
+
+### Installation
+
+wifi-watch is a stand alone ruby script which will run with
+any ruby version and has no dependencies. Clone the repository
+and copy wifi-watch into your path.
+
+```
+git clone https://github.com/jgorman/wifi-watch.git
+sudo cp wifi-watch/bin/wifi-watch /usr/local/bin
+```
+
+### Usage: wifi-watch [options]
+
+```
+-h, --host host         Host to ping [ns.google.com].
+-c, --count seconds     Accounting period [600].
+    --debug-to file     Write ping output to a file for debugging.
+    --debug-from file   Read ping input from a file for testing.
+-v, --version           Version.
+    --help              This message.
+```
+
+### Current Period Status Counts
+
+The current output line shows counts for the current period.
+
+```
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+17:03  136   67 good   1.5%  676.17 ms
+```
+
+- Current time.
+- 136 pings attempted so far in the current period.
+- Run of 67 good pings in a row!
+- Status of the last ping: "good" or "fail".
+- Packet loss percentage so far.
+- Round trip time of the last successful ping.
+
+### History Lines
+
+Here is the past half hour of my network quality history.
+
+In this example things were going great, then my
+connection slowed down over the last 15 minutes.
+I am working in a crowded coffee shop right now
+and perhaps a few of us are watching videos.
+
+```
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+16:30  300  298 good   0.7%   63.84 ms
+16:35  300  300 good   0.0%   76.28 ms
+16:40  300  300 good   0.0%   74.45 ms
+16:45  300  297 good   1.0%  129.55 ms
+16:50  300  296 good   1.3%  233.94 ms
+16:55  300  298 good   0.7%  250.83 ms
+17:00  300  296 good   1.3%  219.14 ms
+17:03  136   67 good   1.5%  676.17 ms
+```
+
+- History lines show the end time for each period.
+- Count of good pings over the period.
+- Packet loss percentage.
+- Average round trip time over the entire period.
+
+### Failure Reporting
+
+#### Ping success or failure run length.
+
+On the current bottom line the run length count resets to 1
+on every transition between "good" and "fail" modes. This way
+we can tell at a glance how long we have been in the current
+state. In a still connected high packet loss environment
+the runs will be short and switch modes often.
+
+Here we have lost our internet connection for the last 39 seconds.
+
+```
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+17:59  207   39 fail  19.3%   62.55 ms
+```
+
+#### Slow DNS lookup.
+
+At the beginning of an accounting period ping does a DNS lookup
+to find your target host ip address. Sometimes this can take
+quite a while to either succeed or fail. If the wait is more
+than one second you will see a status message.
+
+```
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+14:38   10    4 good  60.0%   35.69 ms
+14:38:52 Waiting for dns lookup of ns.google.com ...
+14:39   10   10 good   0.0%   49.52 ms
+```
+
+#### Failing DNS lookup.
+
+When the network is not connected at the beginning of an
+accounting period the host DNS lookup will fail to resolve.
+
+```
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+08:40  300   51 good  83.0%   68.65 ms
+08:41:06 ping: cannot resolve ns.google.com: Unknown host
+08:42   62   17 fail  27.4%  187.30 ms
+```
+
+#### Wifi login timeout.
+
+Sometimes your coffee shop wifi login will time out and you will
+need to login again. Wifi-watch will let you know by showing the
+response message.
+
+```
+10:45:43 92 bytes from 10.128.128.128: Communication prohibited by filter
+```
+
+## Testing and Debugging
+
+It is easy to capture the raw ping output to a file for later
+replay and testing.
+
+```
+wifi-watch --count 10 --debug-to test1.log
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:06   10   10 good   0.0%  127.41 ms
+10:06   10    3 good  70.0%   34.28 ms
+10:06:34 ping: cannot resolve ns.google.com: Unknown host
+10:06    5    1 fail  20.0%   55.16 ms^C
+```
+
+The ping output file includes the timestamp for each line
+so replaying the file later on should result in
+identical appearing output.
+
+```
+wifi-watch --debug-from test1.log
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:06   10   10 good   0.0%  127.41 ms
+10:06   10    3 good  70.0%   34.28 ms
+10:06:34 ping: cannot resolve ns.google.com: Unknown host
+10:06    5    1 fail  20.0%   55.16 ms
+```
+
+Although the --debug-from output should appear to be the same
+as live ping monitoring there is a difference. Instead of emitting
+every intermediate count on the current line, only the final
+line is printed. This helps keep test cases short and readable.
+
+You can run the current test suite with rake test.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jgorman/wifi-watch.
+
+If you discover a shortcoming capture the ping output
+using --debug-to and open an issue. Thanks!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+desc "Run tests"
+task :test do
+  sh %{ test/run_tests }
+end

data/bin/wifi-watch

@@ -0,0 +1,396 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'pty'
+
+class WifiWatch
+
+  Default_host    = "ns.google.com" # Ping target host.
+  Default_count   = 600             # Accounting period in seconds.
+  Program         = "wifi-watch"
+  Version         = "1.0.0"
+
+  def run
+    @shown_header = false # Have we shown the column headers yet?
+    @dns_failing  = false # Are DNS lookups currently failing?
+    @display_line = nil   # The current display line.
+    @debug_to     = nil   # Save timestamped ping output here.
+    @debug_from   = nil   # Read timestamped ping input here.
+    @options      = get_options()
+
+    if @options.debug_to
+      begin
+        @debug_to = File.open(@options.debug_to, "w")
+      rescue => e
+        puts
+        puts "debug_to=#{@options.debug_to}: #{e}"
+        puts
+        exit
+      end
+    end
+
+    if @options.debug_from
+
+      # Debug mode simulates ping output from a captured --debug-to file.
+      begin
+        @debug_from = File.open(@options.debug_from, "r")
+      rescue => e
+        puts
+        puts "debug_from=#{@options.debug_from}: #{e}"
+        puts
+        exit
+      end
+
+      # Call ping_period() for each ping run section.
+      until @debug_from.eof?
+        ping_period(@debug_from) # Reads up to next "END_OF_PING" line.
+      end
+      if @dns_failing
+        commit_line() # Show that we ended up in dns failure mode.
+      end
+
+    else
+
+      # Run ping multiple times.
+      while true
+        count = beautiful_times()
+        cmd = "ping -c #{count} #{@options.host}"
+        stdin, stdout, pid = PTY.spawn( cmd )
+        ping_period(stdin)    # Run one accounting period.
+        Process.waitall()     # Soak up any zombie pings.
+      end
+
+    end
+
+  rescue Interrupt
+    commit_line()
+  ensure
+    if @debug_to
+      @debug_to.close
+    end
+  end
+
+  def get_options
+    options       = OpenStruct.new
+    options.host  = Default_host
+    options.count = Default_count
+
+    opt_parser = OptionParser.new do |opt|
+      opt.banner = "Usage: #{Program} [OPTIONS]"
+      opt.separator ""
+
+      opt.on("-h", "--host host", "Host to ping [#{options.host}].") do |host|
+        options.host = host
+      end
+
+      opt.on("-c", "--count seconds", Integer,
+             "Accounting period [#{options.count}].") do |count|
+        options.count = count
+      end
+
+      opt.on("--debug-to file",
+             "Write ping output to a file for debugging.") do |debug_to|
+        options.debug_to = debug_to
+      end
+
+      opt.on("--debug-from file",
+             "Read ping input from a file for testing.") do |debug_from|
+        options.debug_from = debug_from
+      end
+
+      opt.on("-v", "--version", "Version.") do
+        puts Version
+        exit
+      end
+
+      opt.on("--help", "This message.") do
+        puts
+        puts opt_parser
+        puts
+        exit
+      end
+
+      opt.separator ""
+      opt.separator "Documentation at https://github.com/jgorman/wifi-watch"
+
+    end
+
+    begin
+      opt_parser.parse!
+    rescue => e
+      puts
+      puts e
+      puts
+      puts opt_parser
+      puts
+      exit
+    end
+
+    return options
+  end
+
+  # Run ping for one accounting period.
+  def ping_period(stdin)
+
+    current_mode    = nil   # Are we currently "good" or "fail"?
+    mode_count      = 0     # For how long in a row?
+    total_count     = 0     # Pings so far.
+    totally_good    = 0     # Successful pings.
+    ping_ms         = 0.0   # Latest successful ping time in milliseconds.
+    packets_line    = ''    # Ping packets received summary line.
+    round_trip_line = ''    # Ping round-trip milliseconds summary line.
+    filter_mode     = false # Wifi login filter is active.
+    line_time       = nil   # Latest line timestamp.
+    first_byte      = nil   # DNS lookup complete read test byte.
+
+    # Long DNS lookups can effectively freeze ping for a while.
+    # To reproduce: turn VPN off and then on, then turn WiFi off.
+    # This logic is impractical to simulate in a meaningful way
+    # so we just pass the messages on for later debugging display.
+    waiting_start = Time.now
+    last_notified = waiting_start
+    until first_byte
+      begin
+        first_byte = stdin.read_nonblock(1)
+      rescue IO::EAGAINWaitReadable
+        now = Time.now
+        if now - last_notified >= 1
+          hhmmss_line(now, "Waiting for dns lookup of #{@options.host} ...")
+          if @debug_to
+            @debug_to.puts "#{now.to_i} DNS_LOOKUP #{@display_line}"
+            @debug_to.flush
+          end
+          last_notified = now
+        end
+        sleep 0.2 # Be nice to the cpu.
+      end
+    end
+    if last_notified > waiting_start
+      commit_line()
+    end
+
+    # Process each line of ping output.
+    stdin.each do |line|
+
+      line.chomp!
+      if first_byte
+        line = first_byte + line
+        first_byte = nil
+      end
+
+      if @debug_from
+        # Read from the debugging source file up to the end of this ping run.
+        if line == "END_OF_PING"
+          break # End this ping accounting period run.
+        end
+        # Simulate the past by loading the effective time for this line.
+        time, line = line.split(" ", 2)
+        line_time = Time.at(time.to_i)
+      else
+        line_time = Time.now
+      end
+
+      if @debug_to
+        # Capture this ping output line with the timestamp for later debugging.
+        @debug_to.puts "#{line_time.to_i} #{line}"
+        @debug_to.flush
+      end
+
+      # DNS failure modes.
+      if line =~ /cannot resolve/
+        # ping: cannot resolve ns.google.com: Unknown host
+        hhmmss_line(line_time, line)
+        sleep 1 unless @debug_from # Speed up testing.
+        @dns_failing = true
+      elsif line =~ /DNS_LOOKUP (.*)/
+        # Waiting for dns lookup of ns.google.com ...
+        display_line($1)
+        @dns_failing = true
+      elsif @dns_failing
+        # If DNS was previously failing, pop to a fresh line.
+        commit_line()
+        @dns_failing = false
+      end
+
+      # This indicates a ping success or failure line. Nil means neither.
+      new_mode = nil
+
+      # Parse the line.
+      if line =~ /PING/
+        #
+        # The first ping output line shows the destination host and ip.
+        #
+        # PING ns.google.com (216.239.32.10): 56 data bytes
+        #
+        unless @shown_header
+          puts line # Show the destination name and ip.
+          puts
+          puts "Time  Ping  Run Mode Failed Round Trip"
+          puts "----- ---- ---- ---- ------ ----------"
+          @shown_header = true # Only show these once per wifi-watch.
+        end
+
+      elsif line =~ /bytes from/
+        if line =~ /time=(\S+)/
+          #
+          # Success! Record the round trip time.
+          #
+          # 64 bytes from 104.27.146.148: icmp_seq=48 ttl=61 time=24.780 ms
+          #
+          ping_ms = $1.to_f
+          new_mode  = 'good'
+          if filter_mode
+            commit_line() # Keep the filter message line.
+            filter_mode = false
+          end
+        else
+          #
+          # Here the wifi login has timed out and is blocking packets.
+          # Multi line ping output shows both the timeout and filter message
+          # lines plus some additional diagnostic lines that we ignore.
+          #
+          # Request timeout for icmp_seq 5
+          # 92 bytes from 10.128.128.128: Communication prohibited by filter
+          # Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
+          # 4 5 00 5400 6dea 0 0000 40 01 21dd 10.57.228.249 104.27.147.148
+          #
+          unless filter_mode
+            commit_line() # Keep the last unfiltered status line.
+            filter_mode = true
+          end
+          hhmmss_line(line_time, line)
+        end
+
+      elsif line =~ /timeout/
+        # Request timeout for icmp_seq 3
+        new_mode  = 'fail'
+
+      elsif line =~ /transmitted/
+        # 5 packets transmitted, 5 packets received, 0.0% packet loss
+        packets_line = line
+
+      elsif line =~ /round-trip/
+        # round-trip min/avg/max/stddev = 0.063/0.082/0.122/0.022 ms
+        round_trip_line = line
+      end
+
+      if new_mode
+        # Update the counts with success or failure.
+        if new_mode != current_mode
+          current_mode  = new_mode
+          mode_count    = 0
+        end
+        mode_count    += 1
+        totally_good  += 1 if current_mode == 'good'
+        total_count   += 1
+        unless filter_mode
+          show_stats(line_time, total_count, totally_good,
+                    current_mode, mode_count, ping_ms)
+        end
+      end
+
+    end
+
+    if @debug_to
+      # Insert a ping run separator line into the debugging file.
+      @debug_to.puts "END_OF_PING"
+      @debug_to.flush
+    end
+
+    # Final summary line.
+    if packets_line =~ /(\d+) packets transmitted, (\d+) packets received/
+        total_count   = $1.to_i
+        totally_good  = $2.to_i
+        if round_trip_line =~ / (\S+) ms/
+          avg_ms = $1.split('/')[1].to_f  # Extract the average time.
+        end
+        show_stats(line_time, total_count, totally_good,
+                 'good', totally_good, avg_ms)
+    end
+
+    unless @dns_failing
+      commit_line() # Leave this summary line as history.
+    end
+  end
+
+  # Show the statistics.
+  def show_stats(line_time, total_count, totally_good,
+                 current_mode, mode_count, ms)
+    loss = ((total_count - totally_good) * 100.0) / total_count
+    line = sprintf("%4d %4d %s %5.1f%% %7.2f ms",
+                   total_count, mode_count, current_mode, loss, ms)
+    hhmm_line(line_time, line)
+  end
+
+  # Make history lines pretty.
+  # We want the history minutes to be modulo the accounting minutes.
+  # Where possible we want to let the ping counts to be the same.
+  # Ping can drift backward by one second and forward by a few seconds each run.
+  # Overall the drift is usually forward so when we need to make an adjustment
+  # we aim for 10 seconds into the next aligned minute.
+  def beautiful_times()
+    count = @options.count
+
+    # Is the target count minute aligned?
+    if count % 60 != 0
+      return count # Not minute aligned.
+    end
+
+    # Is the target count hour aligned?
+    minutes = count / 60
+    if 60 % minutes != 0 || minutes < 2
+      return count # Not hour aligned and multiple minutes.
+    end
+
+    # See if we are already suitable aligned right now.
+    now = Time.now
+    mm = now.min
+    ss = now.sec
+    if mm % minutes == 0 && 1 <= ss && ss <= 50
+      return count # Now is minute aligned and within minute drift limits.
+    end
+
+    # Target 10 seconds into the next aligned minute.
+    short_mm = minutes - (mm % minutes)
+    count = (short_mm * 60) + 10 - ss
+    return count
+  end
+
+  def hhmm_line(time, line)
+    line = "#{time.strftime('%H:%M')} #{line}"
+    display_line(line)
+  end
+
+  def hhmmss_line(time, line)
+    line = "#{time.strftime('%H:%M:%S')} #{line}"
+    display_line(line)
+  end
+
+  # Rewrite the current display line or save it for final debugging result.
+  def display_line(line)
+    @display_line = line
+    unless @debug_from
+      # Display this current line.
+      STDOUT.write "\r"   # Move to the start of this line.
+      STDOUT.write line   # Write over it.
+    end
+  end
+
+  # If there is a current display line, commit it to history.
+  def commit_line()
+    if @display_line
+      if @debug_from
+        # Debug mode show final line value as history.
+        puts @display_line
+      else
+        # Normal mode advance to the next line leaving this line as history.
+        puts
+      end
+      @display_line = nil
+    end
+  end
+
+end
+
+WifiWatch.new.run

data/test/expected/dns-down.out

@@ -0,0 +1,11 @@
+09:47:38 ping: cannot resolve ns.google.com: Unknown host
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+09:47   10   10 good   0.0%   54.45 ms
+09:47   10    5 good  50.0%   76.66 ms
+09:48:06 ping: cannot resolve ns.google.com: Unknown host
+09:48   10   10 good   0.0%   72.06 ms
+09:48   10    3 good  70.0%   82.17 ms
+09:48:34 ping: cannot resolve ns.google.com: Unknown host

data/test/expected/dns-slow.out

@@ -0,0 +1,9 @@
+17:42:00 Waiting for dns lookup of ns.google.com ...
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+17:42   10    6 good  40.0%   76.50 ms
+17:42:18 Waiting for dns lookup of ns.google.com ...
+17:42   10    4 good  60.0%   76.68 ms
+17:42:33 Waiting for dns lookup of ns.google.com ...

data/test/expected/fail-mode.out

@@ -0,0 +1,6 @@
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:31   10   10 good   0.0%   80.47 ms
+10:31    8    5 fail  62.5%   32.70 ms

data/test/expected/wifi-login.out

@@ -0,0 +1,7 @@
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:45    5    1 fail  20.0%   68.06 ms
+10:45:43 92 bytes from 10.128.128.128: Communication prohibited by filter
+10:45   11    3 good  36.4%   61.58 ms

data/test/ping_logs/dns-down.log

@@ -0,0 +1,129 @@
+1520606847 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606848 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606849 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606850 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606851 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606852 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606853 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606854 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606855 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606856 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606857 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606858 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606859 PING ns.google.com (216.239.32.10): 56 data bytes
+1520606859 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=36.533 ms
+1520606860 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=47.722 ms
+1520606861 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=35.427 ms
+1520606862 64 bytes from 216.239.32.10: icmp_seq=3 ttl=44 time=64.084 ms
+1520606863 64 bytes from 216.239.32.10: icmp_seq=4 ttl=44 time=69.815 ms
+1520606864 64 bytes from 216.239.32.10: icmp_seq=5 ttl=44 time=40.960 ms
+1520606865 64 bytes from 216.239.32.10: icmp_seq=6 ttl=44 time=106.540 ms
+1520606866 64 bytes from 216.239.32.10: icmp_seq=7 ttl=44 time=34.226 ms
+1520606867 64 bytes from 216.239.32.10: icmp_seq=8 ttl=44 time=39.930 ms
+1520606868 64 bytes from 216.239.32.10: icmp_seq=9 ttl=44 time=69.299 ms
+1520606868 
+1520606868 --- ns.google.com ping statistics ---
+1520606868 10 packets transmitted, 10 packets received, 0.0% packet loss
+1520606868 round-trip min/avg/max/stddev = 34.226/54.454/106.540/21.892 ms
+END_OF_PING
+1520606868 PING ns.google.com (216.239.32.10): 56 data bytes
+1520606868 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=35.391 ms
+1520606869 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=141.665 ms
+1520606870 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=131.141 ms
+1520606871 64 bytes from 216.239.32.10: icmp_seq=3 ttl=44 time=35.320 ms
+1520606872 64 bytes from 216.239.32.10: icmp_seq=4 ttl=44 time=39.757 ms
+1520606873 ping: sendto: No route to host
+1520606874 ping: sendto: No route to host
+1520606874 Request timeout for icmp_seq 5
+1520606875 ping: sendto: No route to host
+1520606875 Request timeout for icmp_seq 6
+1520606876 ping: sendto: No route to host
+1520606876 Request timeout for icmp_seq 7
+1520606877 ping: sendto: No route to host
+1520606877 Request timeout for icmp_seq 8
+1520606879 
+1520606879 --- ns.google.com ping statistics ---
+1520606879 10 packets transmitted, 5 packets received, 50.0% packet loss
+1520606879 round-trip min/avg/max/stddev = 35.320/76.655/141.665/48.924 ms
+END_OF_PING
+1520606879 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606880 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606881 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606882 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606883 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606884 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606885 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606886 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606887 PING ns.google.com (216.239.32.10): 56 data bytes
+1520606887 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=40.028 ms
+1520606888 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=44.796 ms
+1520606889 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=43.484 ms
+1520606890 64 bytes from 216.239.32.10: icmp_seq=3 ttl=44 time=238.342 ms
+1520606891 64 bytes from 216.239.32.10: icmp_seq=4 ttl=44 time=161.573 ms
+1520606892 64 bytes from 216.239.32.10: icmp_seq=5 ttl=44 time=57.327 ms
+1520606893 64 bytes from 216.239.32.10: icmp_seq=6 ttl=44 time=36.289 ms
+1520606894 64 bytes from 216.239.32.10: icmp_seq=7 ttl=44 time=31.354 ms
+1520606895 64 bytes from 216.239.32.10: icmp_seq=8 ttl=44 time=32.630 ms
+1520606896 64 bytes from 216.239.32.10: icmp_seq=9 ttl=44 time=34.819 ms
+1520606896 
+1520606896 --- ns.google.com ping statistics ---
+1520606896 10 packets transmitted, 10 packets received, 0.0% packet loss
+1520606896 round-trip min/avg/max/stddev = 31.354/72.064/238.342/66.591 ms
+END_OF_PING
+1520606896 PING ns.google.com (216.239.32.10): 56 data bytes
+1520606896 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=38.382 ms
+1520606897 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=120.228 ms
+1520606898 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=87.912 ms
+1520606899 ping: sendto: No route to host
+1520606900 ping: sendto: No route to host
+1520606900 Request timeout for icmp_seq 3
+1520606901 ping: sendto: No route to host
+1520606901 Request timeout for icmp_seq 4
+1520606902 ping: sendto: No route to host
+1520606902 Request timeout for icmp_seq 5
+1520606903 ping: sendto: No route to host
+1520606903 Request timeout for icmp_seq 6
+1520606904 ping: sendto: No route to host
+1520606904 Request timeout for icmp_seq 7
+1520606905 ping: sendto: No route to host
+1520606905 Request timeout for icmp_seq 8
+1520606907 
+1520606907 --- ns.google.com ping statistics ---
+1520606907 10 packets transmitted, 3 packets received, 70.0% packet loss
+1520606907 round-trip min/avg/max/stddev = 38.382/82.174/120.228/33.659 ms
+END_OF_PING
+1520606907 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606908 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606909 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606910 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606911 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606912 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606913 ping: cannot resolve ns.google.com: Unknown host
+END_OF_PING
+1520606914 ping: cannot resolve ns.google.com: Unknown host

data/test/ping_logs/dns-slow.log

@@ -0,0 +1,47 @@
+1520635313 DNS_LOOKUP 17:41:53 Waiting for dns lookup of ns.google.com ...
+1520635314 DNS_LOOKUP 17:41:54 Waiting for dns lookup of ns.google.com ...
+1520635315 DNS_LOOKUP 17:41:55 Waiting for dns lookup of ns.google.com ...
+1520635317 DNS_LOOKUP 17:41:57 Waiting for dns lookup of ns.google.com ...
+1520635318 DNS_LOOKUP 17:41:58 Waiting for dns lookup of ns.google.com ...
+1520635319 DNS_LOOKUP 17:41:59 Waiting for dns lookup of ns.google.com ...
+1520635320 DNS_LOOKUP 17:42:00 Waiting for dns lookup of ns.google.com ...
+1520635320 PING ns.google.com (216.239.32.10): 56 data bytes
+1520635320 64 bytes from 216.239.32.10: icmp_seq=0 ttl=46 time=34.544 ms
+1520635321 64 bytes from 216.239.32.10: icmp_seq=1 ttl=46 time=31.144 ms
+1520635322 64 bytes from 216.239.32.10: icmp_seq=2 ttl=46 time=61.392 ms
+1520635323 64 bytes from 216.239.32.10: icmp_seq=3 ttl=46 time=29.985 ms
+1520635324 64 bytes from 216.239.32.10: icmp_seq=4 ttl=46 time=152.010 ms
+1520635325 64 bytes from 216.239.32.10: icmp_seq=5 ttl=46 time=149.945 ms
+1520635327 Request timeout for icmp_seq 6
+1520635328 Request timeout for icmp_seq 7
+1520635329 Request timeout for icmp_seq 8
+1520635331 
+1520635331 --- ns.google.com ping statistics ---
+1520635331 10 packets transmitted, 6 packets received, 40.0% packet loss
+1520635331 round-trip min/avg/max/stddev = 29.985/76.503/152.010/53.705 ms
+END_OF_PING
+1520635332 DNS_LOOKUP 17:42:12 Waiting for dns lookup of ns.google.com ...
+1520635333 DNS_LOOKUP 17:42:13 Waiting for dns lookup of ns.google.com ...
+1520635334 DNS_LOOKUP 17:42:14 Waiting for dns lookup of ns.google.com ...
+1520635335 DNS_LOOKUP 17:42:15 Waiting for dns lookup of ns.google.com ...
+1520635336 DNS_LOOKUP 17:42:16 Waiting for dns lookup of ns.google.com ...
+1520635337 DNS_LOOKUP 17:42:17 Waiting for dns lookup of ns.google.com ...
+1520635338 DNS_LOOKUP 17:42:18 Waiting for dns lookup of ns.google.com ...
+1520635339 PING ns.google.com (216.239.32.10): 56 data bytes
+1520635339 64 bytes from 216.239.32.10: icmp_seq=0 ttl=46 time=36.815 ms
+1520635340 64 bytes from 216.239.32.10: icmp_seq=1 ttl=46 time=26.418 ms
+1520635341 64 bytes from 216.239.32.10: icmp_seq=2 ttl=46 time=92.105 ms
+1520635342 64 bytes from 216.239.32.10: icmp_seq=3 ttl=46 time=151.393 ms
+1520635344 Request timeout for icmp_seq 4
+1520635345 Request timeout for icmp_seq 5
+1520635346 Request timeout for icmp_seq 6
+1520635347 Request timeout for icmp_seq 7
+1520635348 Request timeout for icmp_seq 8
+1520635350 
+1520635350 --- ns.google.com ping statistics ---
+1520635350 10 packets transmitted, 4 packets received, 60.0% packet loss
+1520635350 round-trip min/avg/max/stddev = 26.418/76.683/151.393/49.838 ms
+END_OF_PING
+1520635351 DNS_LOOKUP 17:42:31 Waiting for dns lookup of ns.google.com ...
+1520635352 DNS_LOOKUP 17:42:32 Waiting for dns lookup of ns.google.com ...
+1520635353 DNS_LOOKUP 17:42:33 Waiting for dns lookup of ns.google.com ...

data/test/ping_logs/fail-mode.log

@@ -0,0 +1,30 @@
+1520609460 PING ns.google.com (216.239.32.10): 56 data bytes
+1520609460 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=36.094 ms
+1520609461 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=28.811 ms
+1520609462 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=51.550 ms
+1520609463 64 bytes from 216.239.32.10: icmp_seq=3 ttl=44 time=43.548 ms
+1520609464 64 bytes from 216.239.32.10: icmp_seq=4 ttl=44 time=137.129 ms
+1520609465 64 bytes from 216.239.32.10: icmp_seq=5 ttl=44 time=55.223 ms
+1520609466 64 bytes from 216.239.32.10: icmp_seq=6 ttl=44 time=157.352 ms
+1520609467 64 bytes from 216.239.32.10: icmp_seq=7 ttl=44 time=32.181 ms
+1520609468 64 bytes from 216.239.32.10: icmp_seq=8 ttl=44 time=215.623 ms
+1520609469 64 bytes from 216.239.32.10: icmp_seq=9 ttl=44 time=47.139 ms
+1520609469 
+1520609469 --- ns.google.com ping statistics ---
+1520609469 10 packets transmitted, 10 packets received, 0.0% packet loss
+1520609469 round-trip min/avg/max/stddev = 28.811/80.465/215.623/61.891 ms
+END_OF_PING
+1520609469 PING ns.google.com (216.239.32.10): 56 data bytes
+1520609469 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=124.769 ms
+1520609470 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=121.649 ms
+1520609471 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=32.698 ms
+1520609473 ping: sendto: No route to host
+1520609473 Request timeout for icmp_seq 3
+1520609474 ping: sendto: No route to host
+1520609474 Request timeout for icmp_seq 4
+1520609475 ping: sendto: No route to host
+1520609475 Request timeout for icmp_seq 5
+1520609476 ping: sendto: No route to host
+1520609476 Request timeout for icmp_seq 6
+1520609477 ping: sendto: No route to host
+1520609477 Request timeout for icmp_seq 7

data/test/ping_logs/wifi-login.log

@@ -0,0 +1,24 @@
+1520610336 PING ns.google.com (216.239.32.10): 56 data bytes
+1520610336 64 bytes from 216.239.32.10: icmp_seq=0 ttl=44 time=45.126 ms
+1520610337 64 bytes from 216.239.32.10: icmp_seq=1 ttl=44 time=142.804 ms
+1520610338 64 bytes from 216.239.32.10: icmp_seq=2 ttl=44 time=34.206 ms
+1520610339 64 bytes from 216.239.32.10: icmp_seq=3 ttl=44 time=68.064 ms
+1520610340 Request timeout for icmp_seq 4
+1520610340 92 bytes from 10.128.128.128: Communication prohibited by filter
+1520610340 Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
+1520610340 4 5 00 5400 6dea 0 0000 40 01 21dd 10.57.228.249 104.27.147.148
+1520610341 Request timeout for icmp_seq 5
+1520610341 92 bytes from 10.128.128.128: Communication prohibited by filter
+1520610341 Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
+1520610341 4 5 00 5400 6dea 0 0000 40 01 21dd 10.57.228.249 104.27.147.148
+1520610342 Request timeout for icmp_seq 6
+1520610342 92 bytes from 10.128.128.128: Communication prohibited by filter
+1520610342 Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
+1520610342 4 5 00 5400 6dea 0 0000 40 01 21dd 10.57.228.249 104.27.147.148
+1520610343 Request timeout for icmp_seq 7
+1520610343 92 bytes from 10.128.128.128: Communication prohibited by filter
+1520610343 Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
+1520610343 4 5 00 5400 6dea 0 0000 40 01 21dd 10.57.228.249 104.27.147.148
+1520610344 64 bytes from 216.239.32.10: icmp_seq=8 ttl=44 time=184.792 ms
+1520610345 64 bytes from 216.239.32.10: icmp_seq=9 ttl=44 time=103.312 ms
+1520610346 64 bytes from 216.239.32.10: icmp_seq=10 ttl=44 time=61.582 ms

data/test/results/dns-down.out

@@ -0,0 +1,11 @@
+09:47:38 ping: cannot resolve ns.google.com: Unknown host
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+09:47   10   10 good   0.0%   54.45 ms
+09:47   10    5 good  50.0%   76.66 ms
+09:48:06 ping: cannot resolve ns.google.com: Unknown host
+09:48   10   10 good   0.0%   72.06 ms
+09:48   10    3 good  70.0%   82.17 ms
+09:48:34 ping: cannot resolve ns.google.com: Unknown host

data/test/results/fail-mode.out

@@ -0,0 +1,6 @@
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:31   10   10 good   0.0%   80.47 ms
+10:31    8    5 fail  62.5%   32.70 ms

data/test/results/wifi-login.out

@@ -0,0 +1,7 @@
+PING ns.google.com (216.239.32.10): 56 data bytes
+
+Time  Ping  Run Mode Failed Round Trip
+----- ---- ---- ---- ------ ----------
+10:45    5    1 fail  20.0%   68.06 ms
+10:45:43 92 bytes from 10.128.128.128: Communication prohibited by filter
+10:45   11    3 good  36.4%   61.58 ms

data/test/run_tests

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+dir=`dirname $0`
+wifiwatch="$dir/../bin/wifi-watch"
+ping_logs="$dir/ping_logs"
+expected="$dir/expected"
+results="$dir/results"
+
+tests=0
+fail=0
+mkdir -p $results
+rm -f $results/*
+
+echo
+for test_path in $ping_logs/*.log; do
+  test_name=`basename $test_path .log`
+
+  echo -n "Running $test_name ... "
+  $wifiwatch --debug-from $test_path >$results/$test_name.out
+  tests=$(expr $tests + 1)
+
+  if cmp -s $expected/$test_name.out $results/$test_name.out; then
+    echo "Success!"
+  else
+    fail=$(expr $fail + 1)
+    echo "Failed!"
+    echo "diff $expected/$test_name.out $results/$test_name.out"
+    diff $expected/$test_name.out $results/$test_name.out
+    echo
+  fi
+
+done
+
+echo
+echo "$tests tests, $fail errors"
+echo
+
+[ "$fail" = 0 ]
+

data/wifi-watch.gemspec

@@ -0,0 +1,17 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "wifi-watch"
+  spec.version       = "1.0.0"
+  spec.authors       = ["John Gorman"]
+  spec.email         = ["johngorman2@gmail.com"]
+
+  spec.summary       = %q{Continuously monitor your network speed and quality!}
+  spec.description   = %q{Run wifi-watch in a terminal so that you can easily check your network quality at this moment and how it has been holding up since you began recording hours or days ago.}
+  spec.homepage      = "https://github.com/jgorman/wifi-watch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split
+  spec.bindir        = "bin"
+  spec.executables   = ["wifi-watch"]
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: wifi-watch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Gorman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-09 00:00:00.000000000 Z
+dependencies: []
+description: Run wifi-watch in a terminal so that you can easily check your network
+  quality at this moment and how it has been holding up since you began recording
+  hours or days ago.
+email:
+- johngorman2@gmail.com
+executables:
+- wifi-watch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/wifi-watch
+- test/expected/dns-down.out
+- test/expected/dns-slow.out
+- test/expected/fail-mode.out
+- test/expected/wifi-login.out
+- test/ping_logs/dns-down.log
+- test/ping_logs/dns-slow.log
+- test/ping_logs/fail-mode.log
+- test/ping_logs/wifi-login.log
+- test/results/dns-down.out
+- test/results/fail-mode.out
+- test/results/wifi-login.out
+- test/run_tests
+- wifi-watch.gemspec
+homepage: https://github.com/jgorman/wifi-watch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.4
+signing_key: 
+specification_version: 4
+summary: Continuously monitor your network speed and quality!
+test_files: []