wifi-watch 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfaa11569827201e5cfdbd4c2a12a6ae39821200
-  data.tar.gz: 2008abb7d60341ac78ae9795561dace06a88328b
+  metadata.gz: c9797d50586860cee6df38fdec51a3b14700bc21
+  data.tar.gz: b3b495a1b8ec39d7064493ffedff9995a0f79790
 SHA512:
-  metadata.gz: 647b3eda4408818db7cab2d11c50b414d9ba51310a2e4b006756f659e7bc92e5c7250044d4d7266b06366c7d289b326477fe3affae33be0fa4977e05de962f61
-  data.tar.gz: 95ae3066b5f008fa73aabfe372f729ca7ad625c6bdda2869fdae1fc9da4990546f44b11e1eeaaa69512b693c5ce48789a1ed397610f23cdb0c8b6847970ce538
+  metadata.gz: 6696aa3538b2673da41774062de6cd58dc3839e57bd337a56b8e07fe3b612df1fad66cb2021d89181d519f23b51d30caf8f750b085be321da741b8f2883e3b8d
+  data.tar.gz: a3759eafc8138bbaa6831326933cac144ba8aff3aab6e4004478300b38834b82a0ac141c7edbb0a07c5dca2bc554881b08ef2c86f7ff7f210f5902b93a33df53

data/README.md

@@ -60,9 +60,10 @@ sudo mv wifi-watch /usr/local/bin
 
 ```
 -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.
+-c, --count seconds     Accounting period length [600 seconds].
+-p, --periods periods   Accounting periods to run [infinite].
+    --ping-to file      Write ping output to a file for debugging.
+    --ping-from file    Read ping input from a file ('-' for stdin).
 -v, --version           Version.
     --help              This message.
 ```
@@ -173,7 +174,7 @@ 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
+wifi-watch --count 10 --ping-to test1.log
 PING ns.google.com (216.239.32.10): 56 data bytes
 
 Time  Ping  Run Mode Failed Round Trip
@@ -189,7 +190,7 @@ so replaying the file later on should result in
 identical appearing output.
 
 ```
-wifi-watch --debug-from test1.log
+wifi-watch --ping-from test1.log
 PING ns.google.com (216.239.32.10): 56 data bytes
 
 Time  Ping  Run Mode Failed Round Trip
@@ -200,7 +201,7 @@ Time  Ping  Run Mode Failed Round Trip
 10:06    5    1 fail  20.0%   55.16 ms
 ```
 
-Although the --debug-from output should appear to be the same
+Although the --ping-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.
@@ -213,7 +214,7 @@ 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!
+using --ping-to and open an issue. Thanks!
 
 ## License
 

data/bin/wifi-watch

@@ -9,42 +9,46 @@ class WifiWatch
   Default_host    = "ns.google.com" # Ping target host.
   Default_count   = 600             # Accounting period in seconds.
   Program         = "wifi-watch"
-  Version         = "1.0.1"
+  Version         = "1.0.2"
 
   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.
+    @ping_to      = nil   # Save timestamped ping output here.
+    @ping_from    = nil   # Read timestamped ping input here.
     @options      = get_options()
 
-    if @options.debug_to
+    if @options.ping_to
       begin
-        @debug_to = File.open(@options.debug_to, "w")
+        @ping_to = File.open(@options.ping_to, "w")
       rescue => e
         puts
-        puts "debug_to=#{@options.debug_to}: #{e}"
+        puts "ping_to=#{@options.ping_to}: #{e}"
         puts
         exit
       end
     end
 
-    if @options.debug_from
+    if @options.ping_from
 
-      # Debug mode simulates ping output from a captured --debug-to file.
+      # Debug mode simulates ping output from a captured --ping-to file.
       begin
-        @debug_from = File.open(@options.debug_from, "r")
+        if @options.ping_from == "-"
+          @ping_from = STDIN
+        else
+          @ping_from = File.open(@options.ping_from, "r")
+        end
       rescue => e
         puts
-        puts "debug_from=#{@options.debug_from}: #{e}"
+        puts "ping_from=#{@options.ping_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.
+      until @ping_from.eof?
+        ping_period(@ping_from) # Reads up to next "END_OF_PING" line.
       end
       if @dns_failing
         commit_line() # Show that we ended up in dns failure mode.
@@ -53,12 +57,19 @@ class WifiWatch
     else
 
       # Run ping multiple times.
+      periods = 0
       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.
+        if @options.periods > 0
+          periods += 1
+          if periods >= @options.periods
+            break
+          end
+        end
       end
 
     end
@@ -66,15 +77,16 @@ class WifiWatch
   rescue Interrupt
     commit_line()
   ensure
-    if @debug_to
-      @debug_to.close
+    if @ping_to
+      @ping_to.close
     end
   end
 
   def get_options
-    options       = OpenStruct.new
-    options.host  = Default_host
-    options.count = Default_count
+    options         = OpenStruct.new
+    options.host    = Default_host
+    options.count   = Default_count
+    options.periods = 0
 
     opt_parser = OptionParser.new do |opt|
       opt.banner = "Usage: #{Program} [OPTIONS]"
@@ -85,19 +97,24 @@ class WifiWatch
       end
 
       opt.on("-c", "--count seconds", Integer,
-             "Accounting period [#{options.count}].") do |count|
+             "Accounting period length [#{options.count} seconds].") do |count|
         raise "--count must be positive" unless count > 0
         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
+      opt.on("-p", "--periods periods", Integer,
+             "Accounting periods to run [infinite].") do |periods|
+        options.periods = periods
+      end
+
+      opt.on("--ping-to file",
+             "Write ping output to a file for debugging.") do |ping_to|
+        options.ping_to = ping_to
       end
 
-      opt.on("--debug-from file",
-             "Read ping input from a file for testing.") do |debug_from|
-        options.debug_from = debug_from
+      opt.on("--ping-from file",
+             "Read ping input from a file ('-' for stdin).") do |ping_from|
+        options.ping_from = ping_from
       end
 
       opt.on("-v", "--version", "Version.") do
@@ -158,9 +175,9 @@ class WifiWatch
         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
+          if @ping_to
+            @ping_to.puts "#{now.to_i} DNS_LOOKUP #{@display_line}"
+            @ping_to.flush
           end
           last_notified = now
         end
@@ -188,7 +205,7 @@ class WifiWatch
         first_byte = nil
       end
 
-      if @debug_from
+      if @ping_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.
@@ -200,17 +217,17 @@ class WifiWatch
         line_time = Time.now
       end
 
-      if @debug_to
+      if @ping_to
         # Capture this ping output line with the timestamp for later debugging.
-        @debug_to.puts "#{line_time.to_i} #{line}"
-        @debug_to.flush
+        @ping_to.puts "#{line_time.to_i} #{line}"
+        @ping_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.
+        sleep 1 unless @ping_from # Speed up testing.
         @dns_failing = true
       elsif line =~ /DNS_LOOKUP (.*)/
         # Waiting for dns lookup of ns.google.com ...
@@ -301,10 +318,10 @@ class WifiWatch
 
     end
 
-    if @debug_to
+    if @ping_to
       # Insert a ping run separator line into the debugging file.
-      @debug_to.puts "END_OF_PING"
-      @debug_to.flush
+      @ping_to.puts "END_OF_PING"
+      @ping_to.flush
     end
 
     # Final summary line.
@@ -379,7 +396,7 @@ class WifiWatch
   # Rewrite the current display line or save it for final debugging result.
   def display_line(line)
     @display_line = line
-    unless @debug_from
+    unless @ping_from
       # Display this current line.
       STDOUT.write "\r"   # Move to the start of this line.
       STDOUT.write line   # Write over it.
@@ -389,7 +406,7 @@ class WifiWatch
   # If there is a current display line, commit it to history.
   def commit_line()
     if @display_line
-      if @debug_from
+      if @ping_from
         # Debug mode show final line value as history.
         puts @display_line
       else

data/wifi-service/index.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const http = require("http");
+const Pinger = require("./pinger");
+
+const pinger = Pinger();
+pinger.start();
+
+const server = http.createServer();
+server.on("request", (req, res) => {
+  const start_time = Date.now();
+  if (req.url === "/summary") {
+    pinger.summary().pipe(res)
+  } else if (req.url === "/pings") {
+    pinger.pings().pipe(res)
+  } else if (req.url === "/stop") {
+    pinger.stop();
+    res.end("Stopped\n")
+  } else if (req.url === "/start") {
+    pinger.start();
+    res.end("Started\n")
+  } else {
+    res.end("Okay\n")
+  }
+  const end_time = Date.now();
+  console.log(`Ran ${req.url} in ${end_time - start_time} ms.`);
+});
+
+server.listen(3000);

data/wifi-service/pinger.js

@@ -0,0 +1,132 @@
+/*
+ * Gather ping logs.
+ *
+ * import Pinger from "./pinger";
+ * pinger = Pinger();
+ * pinger.start({ count: 600, logs: 6 });
+ * ping_stream = pinger.ping_stream();
+ * ping_stream.pipe(process.stdout);
+ * pinger.stop();
+ *
+ */
+
+const { spawn } = require("child_process");
+const { Readable } = require('stream');
+
+const Pinger = () => {
+
+  const default_options = {
+    host: "ns.google.com",
+    count: 600,
+    logs:  6
+  };
+  let options = default_options;
+  let ping_proc;
+  const ping_logs = [];
+
+  const start = (opts = {}) => {
+    if (!ping_proc) {
+      options = { ...default_options, ...opts};
+      run();
+    }
+  };
+
+  const stop = () => {
+    if (ping_proc) {
+      ping_proc.kill();
+      ping_proc = undefined;
+      ping_logs.splice(0, ping_logs.length);
+    }
+  };
+
+  const run = () => {
+    const ping_log = [];
+    let pushed = false;
+
+    // Spawn a ping process.
+    ping_proc = spawn("ping", [ "-c", options.count, options.host ]);
+
+    // Catch any errors and exit.
+    ping_proc.on("error", (err) => {
+      console.error("spawn ping:", err.code, err.path, err.spawnargs);
+      process.exit(2);
+    });
+
+    // On ping close start a new one.
+    ping_proc.on("close", () => {
+      ping_log.push("END_OF_PING\n");
+      if (ping_proc) {
+        run();
+      }
+    });
+
+    // Capture each new ping line.
+    ping_proc.stdout.on("data", (data) => {
+      now = Math.round(Date.now() / 1000);
+      data_s = data.toString().trim();
+      lines = data_s.split("\n");
+      lines.forEach( (line) => {
+        timed_line = `${now} ${line}\n`;
+        ping_log.push(timed_line);
+      });
+
+      // Now that we have some data remove old logs and append this log.
+      if (!pushed) {
+        while (ping_logs.length >= options.logs) {
+          ping_logs.shift();
+        }
+        ping_logs.push(ping_log);
+        pushed = true;
+      }
+    });
+  }
+
+  // Create a new ping log stream.
+  const pings = () => {
+    let next_log = 0;
+
+    const reader = new Readable({
+      read(size) {
+        // Get the next log.
+        ping_log = ping_logs[next_log];
+        if (ping_log == undefined) {
+          this.push(null);
+          return;
+        }
+        next_log += 1;
+
+        // If there are multiple lines, compact them.
+        if (ping_log.length > 0) {
+          compacted = ping_log.join('');
+          ping_log.splice(0, ping_log.length, compacted);
+        }
+
+        // Send out the log.
+        this.push(ping_log[0]);
+      }
+    });
+
+    return reader;
+  }
+
+  // Create a new ping summary stream.
+  const summary = () => {
+    const wifi_watch = spawn("wifi-watch", ["--ping-from=-"]);
+    wifi_watch.on("error", (err) => {
+      console.error("spawn wifi-watch:", err.code, err.path, err.spawnargs);
+      process.exit(2);
+    });
+
+    pings().pipe(wifi_watch.stdin);
+    return wifi_watch.stdout;
+  };
+
+  return {
+    start: start,
+    stop: stop,
+    pings: pings,
+    summary: summary
+  };
+};
+
+module.exports = Pinger;

data/wifi-watch.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "wifi-watch"
-  spec.version       = "1.0.1"
+  spec.version       = "1.0.2"
   spec.authors       = ["John Gorman"]
   spec.email         = ["johngorman2@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifi-watch
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - John Gorman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-03-13 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
@@ -35,6 +35,8 @@ files:
 - test/ping_logs/fail-mode.log
 - test/ping_logs/wifi-login.log
 - test/run_tests
+- wifi-service/index.js
+- wifi-service/pinger.js
 - wifi-watch.gemspec
 homepage: https://github.com/jgorman/wifi-watch
 licenses: