noms-client 1.10.0 → 1.12.0

data/ROADMAP.rst

@@ -0,0 +1,215 @@
+noms
+====
+
+This is the roadmap for a second-generation of the 'noms' general purpose interface.
+
+**noms** is a remote command-line interface interpreter. It's designed to be a stable runtime environment for interpreting server-defined command-line interfaces for (principally) rest-like data stores (or for commands that are side-effect free, but *not* commands that change any state on the system on which the command runs).
+
+The web browser is a platform in which the operator of a web service can implement a graphical user interface to data it controls. For example, it's a common pattern to offer access to services and data via a ReST or ReST-like interface, making http requests against a remote API understanding the HTTP verbs and returning results in the form of HTTP responses, header metadata and response bodies containing serialized data (e.g. JSON). Such interfaces are generally implemented in a combination of HTML documents and Javascript which modifies the document model of the HTML page(s).
+
+**noms** enables an author to offer a command-line interface designed along the same pattern: structured documents modified by javascript programs, interpreted and rendered on the client. **noms** has sandboxing similar to web browsers (no modifying of local storage outside of restricted, application-specific local storage and automatic caching of javascript files).
+
+**noms** is *not* a web browser and is not designed to offer terminal user interfaces like lynx or elinks. It is also *not* an interactive shell--it's designed to be used from a shell. It maintains authenticated sessions state when necessary.
+
+Syntax
+------
+
+The basic way of invoking an **noms** command is as follows::
+
+  noms *url* *options* *arguments*
+
+**noms** invokes the app at *url* with the given options and arguments, displaying the results.
+
+Special URLs
+~~~~~~~~~~~~
+
+Certain invalid "URLs" are interpreted specially:
+
+* ``noms login *url*``
+
+Normally **noms** handles user authentication implicitly. With this command, it does a HEAD request against the application URL, forcing login if required.
+
+* ``noms logout *url*``
+
+Causes **noms** to forget its session state for the given application URL.
+
+* ``noms *bookmark*[/arg] ...``
+
+The **noms** command itself has a configuration file (``~/.noms``, ``/usr/local/etc/noms.conf``, ``/etc/noms.conf`` in that order) which defines bookmarks to different URLs. For example, given the following in ``/etc/noms.conf``::
+
+  { 
+    "cmdb": "https://cmdb.noms-example.com/cmdb.json",
+    "instance": "https://ncc-api.noms-example.com/ncc-api.json",
+    "nagios": "https://nagios.noms-example.com/nagui.json",
+    "nag": "https://nagios.noms-exmaple.com/nagui.json"
+  }
+
+When invoked in the following ways, it's the equivalent to the command on the right:
+
+================================= ==================================================================
+Command given                     Equivalent command
+================================= ==================================================================
+``noms cmdb query fqdn~^m00``     ``noms https://cmdb.noms-example.com/cmdb.json query fqdn~^m00``
+                                  (``document.argv[0]`` set to ``cmdb``)
+``noms cmdb/env list``            ``noms https://cmdb.noms-example.com/cmdb.json list``
+                                  (``document.argv[0]`` set to ``cmdb/env``)
+``noms nag alerts``               ``noms https://cmdb.noms-example.com/nagui.json alerts``
+                                  (``document.argv[0]`` set to ``nag``)
+================================= ==================================================================
+
+Implementation
+--------------
+
+If the type is ``text/plain``, it's simply displayed.
+
+If the type is a recognized data serialization format (JSON or YAML):
+
+* application/json
+* application/x-json
+* text/json
+* application/yaml
+* application/x-yaml
+* text/yaml
+
+If the fetched content is a single object and the object has the top-level key '$doctype', it may be interpreted according to "Dynamic Doctypes", below. Otherwise, it is assumed to be either a single object to display or a list of such. Otherwise **noms** will render the object or array using its default format (usually YAML).
+
+Dynamic Doctypes
+~~~~~~~~~~~~~~~~
+
+The principle dynamic doctype is the ``noms-v2``, which is an object with the following top-level attributes:
+
+``$doctype``
+  Must be ``noms-v2``. In future, backwards-incompatible extensions may be implemented in ``noms-v3`` or higher doctypes.
+
+``$script``
+  An ordered array of scripts to fetch and evaluate.
+
+``$format-fields``
+  An array of objects, each having (at least) a ``name`` and ``width`` attribute. May also include a ``label`` attribute
+  for the column heading.
+
+``$body``
+  The body of the document is the data to display. See `Output Description Notation`_ below.
+
+Output Description Notation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following entities are allowed in the body of a **noms=2** document.
+
+* Arrays - Each item in the array is concatenated with a line-break between them.
+* Strings and numbers - A string or number is just displayed
+* Raw objects - Raw objects are rendered using **noms** default formatting (usually YAML)
+* Described objects - Described objects are data along with information on how to render them. A described object
+  has a top-level attribute called **$type** which defines how the described object is rendered.
+
+  * ``$type``: **object-list** An object list is a (usually) tabular list of objects with information on how
+    wide to make the fields or how to otherwise serialize the objects. It has the following attributes:
+
+    * **render**: The format in which to render, one of: **json**, **yaml**, **text** (default **text**)
+    * **fields**: Field names, headings and widths
+    * **objects**: The objects to render
+
+  * ``$type``: **object** An object described-object has the following attributes:
+
+    * **render**: The format in which to render, one of: **json**, **yaml**, **text** (default **yaml**)
+    * **object**: The object data
+
+Putting it all together
+-----------------------
+
+Example **noms** conversation::
+
+  bash$ noms https://cmdb.noms-example.com/cmdb.json --format=csv system fqdn~^m00
+
+  noms >> GET https://cmdb.noms-example.com/cmdb.json
+  noms << set 'document' to retrieved object:
+  { "$doctype": "appdoc",
+    "$script": ["lib/optconfig.js", "noms/cmdb.js", "noms/cli.js"],
+    "$body": null
+  }
+  noms << set 'document.argv' to ["https://cmdb.noms-example.com/cmdb.json", "--format=csv", "system", "fqdn~^m00"]
+  noms << set 'document.exitcode' to 0
+  noms >> GET https://cmdb.noms-example.com/lib/optconfig.js
+  noms << evaluate javascript option-parsing library optconfig.js
+  noms >> GET https://cmdb.noms-example.com/noms/cmdb.js
+  noms << evaluate noms cmdb client library
+  noms >> GET https://cmdb.noms-example.com/noms/cli.js
+  noms << evaluate noms cli library
+  cli.js << calls optconfig().parse with optspec
+  optconfig.js << sets document.argv to ["system", "fqdn~^m00"]
+  optconfig.js << sets document.options to { "format": "csv" }
+  cli.js << call noms_cmdb().query("system", "fqdn~^m00")
+  noms/cmdb.js << http.request("https://cmdb.noms-example.com/cmdb_api/v1/system/?fqdn~^m00")
+  cli.js << sets document.body to return objects to render
+  { "$doctype": "appdoc",
+    "$script": ["lib/optconfig.js", "noms/cmdb.js", "noms/cli.js"],
+    "$body": [{
+      "$type": "object-list",
+      "render": "csv",
+      "fields": [
+        { "name": "fqdn", "width": 36 },
+        { "name": "environment_name", "width": 16, "heading": "environment" },
+        { "name": "status", "width": 15 },
+        { "name": "roles", "width": 15 },
+        { "name": "ipaddress", "width": 15 },
+        { "name": "data_center_code": 11, "heading": "datacenter" } ],
+      "objects": [
+        { "fqdn": "m001.noms-example.com",
+          "environment_name": "production",
+          "status": "production",
+          "roles": "build",
+          "ipaddress": "10.8.9.10",
+          "data_center_code": "US2" },
+        { "fqdn": "m002.noms-example.com",
+          "environment_name": "testing",
+          "status": "allocated",
+          "roles": "webserver",
+          "ipaddress": "10.8.9.11",
+          "data_center_code": "US2" }
+        ]
+      }
+    ]
+  }
+
+  noms >> print output
+  fqdn,environment,status,roles,ipaddress,datacenter
+  "m001.noms-example.com",production,production,build,10.8.9.10,US2
+  "m002.noms-example.com",allocated,testing,webserver,10.8.9.11,US2
+
+  bash$ noms https://ncc-api.noms-example.com/ncc.json show m002.noms-example.com
+
+   { "$doctype": "appdoc",
+     "$script": ["noms/optconfig.js", 
+        { "name": "name", "width": 36 },
+        { "name": "status", "width": 10 },
+        { "name": "size", "width": 10 },
+        { "name": "image", "width": 15 },
+        { "name": "id", "width": 37 }
+     ]
+     "$body": null
+   }
+
+  name                                 status     size       image           id                                  
+  m0000291.noms-example.net            active     m1.small   deb6            d8c4c29e-785f-49ef-9d31-e4a71e9954fc
+  m0000290.noms-example.net            active     m1.small   deb7            33a88a1d-49a4-4c26-9a0c-b699703f5e64
+  m0000289.noms-example.net            active     m1.small   deb7            fd82f522-f305-4150-a969-1b8b9fd2d91d
+  m0000288.noms-example.net            error      m1.small   deb6            9d7f1c55-5f8f-4f98-9bf8-c1156a0506d2
+  m0000287.noms-example.net            active     m1.small   deb6            c4a6310d-4927-4e79-8170-443172eb9a7c
+  m0000286.noms-example.net            active     m1.small   centos6.2       88c654b6-77f2-4995-affb-c3a3bac16bd0
+  m0000277.noms-example.net            active     m1.small   deb6            e34e4a8f-81ef-42a3-a9c0-40933be7595f
+
+Invoked scripts have access to the following global objects:
+
+* **window** - This has information about the terminal environment in which **noms** is being invoked. It has the following attributes:
+  * **height** - Height (if known)
+  * **width**  - Width (if known)
+  * **isatty** - true if the output stream is a terminal
+  * **document** - The document global object
+* **document** - The document object is the current document being rendered by **noms**. In addition to the attributes of the document itself, it has the following:
+  * **argv** - The arguments being invoked. The first element of this array is the first argument passed to **noms** itself (not the script it ultimately fetches, but how it's invoked, similar to ``$1``
+  * **exitcode** - The numeric exit code with which **noms** will exit. Initially 0.
+
+Web 1.0 vs Web 2.0
+------------------
+
+Like the "real web", **noms** commands can choose to do some calculation on the server and some on the client: **noms** doesn't care. You can use no ``$script`` tag at all and just calculate the entire document to be rendered in the client (though this currently odoesn't allow for argument interpretation, in the future the arguments may be passed in request headers or **noms** may allow a way for them to show up in a query string or POST request--but **noms** is not really a command-line http client either). This is up to the application designer.

data/bin/noms

@@ -63,7 +63,13 @@
 #          show type name            - Show information for named type [hostgroup,host,service]
 #          detail host               - Show object detail for named host
 #          query type [condition [...]]   - Query for object by type [hostgroup,host,service]
-#          check <host> [<service>]  - Run service check for host (or host check) synchronously
+#          check host [service]      - Run service check for host (or host check) synchronously
+#          ack host [service] <comment  - acknowledge a warning or critical host/service
+#          comment host [service] comment - add a comment to a host or service
+#          downtime host [service] duration comment - put a host or service into maintenance
+#          undowntime host [service]  - Remove downtime from a host or service
+#          alerts                     - List all unacknowledged problems that are in a hard non-OK
+#                                       state and are not in a scheduled downtime period
 #
 #    Options:
 #       --names                      - Just print entity names, equivalent to
@@ -242,7 +248,7 @@ $opt = Optconfig.new('noms', {
                                     'state' => 5,
                                     'plugin_output' => 36
                                 }
-                             },                            
+                             },
                              'service' => {
                                 'fields' => [
                                     'host_name','description','state', 'plugin_output'
@@ -517,7 +523,7 @@ end
 
 def cmdb_show(args)
     fqdn = args.shift
-    system = $cmdb.query('system', 'fqdn=' + fqdn).first
+    system = $cmdb.system(fqdn)
     record = if ! args.empty?
         system.keys.inject({}) do |h, k|
             if args.include? k
@@ -618,6 +624,52 @@ def nagios(args)
         end
     when 'check'
         record_formatted_output(nagcheck(args),'nagcheck')
+    when 'ack'
+        host=args.shift
+        if args.length == 1 
+            comment=args.shift
+            $nagui.ack_host(host,get_username,comment)
+        else
+            service=args.shift
+            if(args.length > 1)
+                comment = args.join(' ')
+            else
+                comment = args.shift
+            end
+            $nagui.ack_service(host,service,get_username,comment)
+        end
+    when 'alerts'
+        formatted_output($nagui.query('service',['acknowledged=0','state!=0','state_type=1',"scheduled_downtime_depth=0","host_scheduled_downtime_depth=0"]),'service')
+    when 'comment'
+        host=args.shift
+        if args.length == 1 
+            comment=args.shift
+            $nagui.comment(host,nil,get_username,comment)
+        else
+            service=args.shift
+            if(args.length > 1)
+                comment = args.join(' ')
+            else
+                comment = args.shift
+            end
+            $nagui.comment(host,service,get_username,comment)
+        end        
+    when 'downtime','down'
+        host = args.shift
+        if args.length == 2
+            length = args.shift
+            comment = args.shift
+            $nagui.downtime_host(host,length,get_username,comment)
+        else
+            service = args.shift
+            length = args.shift
+            comment = args.join(' ')
+            $nagui.downtime_service(host,service,length,get_username,comment)
+        end
+    when 'undowntime','undown'
+        host = args.shift
+        service = args.shift if !args.empty? || nil
+        $nagui.undowntime(host,service)
     else
         $stderr.puts "Unknown nagios command '#{cmd}'"
         Process.exit(2)
@@ -640,6 +692,10 @@ def cmdb(args)
         fqdn = args.shift
         updated = $cmdb.update('system', opt, fqdn)
         ''
+    when 'add'
+        fqdn = args.shift
+        created = $cmdb.create('system', opt, fqdn)
+        ''
     else
         $stderr.puts "Unknown cmdb command '#{cmd}'"
         Process.exit(2)

data/lib/noms/client/version.rb

@@ -3,5 +3,5 @@ class NOMS
 end
 
 class NOMS::Client
-    VERSION = '1.10.0'
+    VERSION = '1.12.0'
 end

data/lib/noms/cmdb.rb

@@ -61,6 +61,20 @@ class NOMS::CMDB < NOMS::HttpClient
       do_request(:GET => "pcmsystemname/#{serial}")
   end
 
+  def create(type, obj, key=nil)
+      keyfield = key_field_of(type)
+      objkey = obj[keyfield]
+
+      if key.nil? and objkey.nil?
+          raise NOMS::Error, "Must specify a key value or imply it in the object's #{key_field_of(type)} value"
+      end
+      if (obj.has_key?(keyfield) and (! key.nil?) and obj[keyfield] != key)
+          raise NOMS::Error, "You specified different keys for a new #{type} object: #{objkey} in the object vs. #{key}"
+      end
+      newobj = { keyfield => (objkey || key) }.merge obj
+      do_request(:POST => type, :body => newobj)
+  end
+
   def update(type, obj, key=nil)
       key ||= obj[key_field_of(type)]
       do_request(:PUT => "#{type}/#{key}", :body => obj)
@@ -119,12 +133,25 @@ class NOMS::CMDB::Mock < NOMS::HttpClient::RestMock
 
     @@machine_id = 0
 
+    def allow_put_to_create
+        false
+    end
+
+    def id_field(path)
+        case path
+        when %r{system$}
+            'fqdn'
+        else
+            'id'
+        end
+    end
+
     def handle_mock(method, uri, opt)
         if m = Regexp.new('/pcmsystemname/([^/]+)').match(uri.path)
             serial = m[1]
             @@machine_id += 1
             name = "m-%03d.mock" % @@machine_id
-            do_request :PUT => "system/#{name}",
+            do_request :POST => "system",
                        :body => {
                            'serial' => serial,
                            'fqdn' => name

data/lib/noms/httpclient.rb

@@ -132,6 +132,10 @@ class NOMS::HttpClient
         false
     end
 
+    def allow_put_to_create
+        true
+    end
+
     def default_content_type
         'application/json'
     end
@@ -253,9 +257,14 @@ class NOMS::HttpClient::RestMock < NOMS::HttpClient
             object_index =
                 @data[url.host][collection_path].index { |el| el[id_field(collection_path)] == id }
             if object_index.nil?
-                object = opt[:body].merge({ id_field(collection_path) => id })
-                dbg "creating in collection #{collection_path}: #{object.inspect}"
-                @data[url.host][collection_path] << opt[:body].merge({ id_field(collection_path) => id })
+                if allow_put_to_create
+                    object = opt[:body].merge({ id_field(collection_path) => id })
+                    dbg "creating in collection #{collection_path}: #{object.inspect}"
+                    @data[url.host][collection_path] << opt[:body].merge({ id_field(collection_path) => id })
+                else
+                    dbg "not creating in collection #{collection_path}: #{id} (allow_put_to_create is false)"
+                    raise NOMS::Error, "There is no resource at this location"
+                end
             else
                 if allow_partial_updates
                     object = @data[url.host][collection_path][object_index].merge(opt[:body])

data/lib/noms/nagui.rb

@@ -16,7 +16,7 @@
 # */
 
 require 'noms/httpclient'
-require 'uri'
+require 'cgi'
 
 class NOMS
 
@@ -80,10 +80,11 @@ class NOMS::Nagui < NOMS::HttpClient
       Process.exit(1)
     end
     query_string = make_lql(type,queries)
-    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => URI.encode("query=#{query_string}"))
+    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => "query=#{CGI.escape(query_string)}")
   end
   def hostgroup(name)
-    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => URI.encode("query=GET hostgroups|Filter: name = #{name}"))
+    lql = "GET hostgroups|Filter: name = #{name}"
+    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => "query=#{CGI.escape(lql)}")
     if results.kind_of?(Array) && results.length > 0
       results[0]
     else
@@ -91,7 +92,8 @@ class NOMS::Nagui < NOMS::HttpClient
     end
   end
   def service(host,description)
-    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => URI.encode("query=GET services|Filter: host_name = #{host}|Filter: description = #{description}"))
+    lql = "GET services|Filter: host_name = #{host}|Filter: description = #{description}"
+    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => "query=#{CGI.escape(lql)}")
     if results.kind_of?(Array) && results.length > 0
       results[0]
     else
@@ -99,7 +101,8 @@ class NOMS::Nagui < NOMS::HttpClient
     end
   end
   def servicegroup(name)
-    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => URI.encode("query=GET hosts|Filter: name = #{name}"))
+    lql = "query=GET hosts|Filter: name = #{name}"
+    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => "query=#{CGI.escape(lql)}")
     if results.kind_of?(Array) && results.length > 0
       results[0]
     else
@@ -107,7 +110,8 @@ class NOMS::Nagui < NOMS::HttpClient
     end
   end
   def host(hostname)
-    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => URI.encode("query=GET hosts|Filter: name = #{hostname}"))
+    lql = "GET hosts|Filter: name = #{hostname}"
+    results = do_request(:GET => '/nagui/nagios_live.cgi', :query => "query=#{CGI.escape(lql)}")
     if results.kind_of?(Array) && results.length > 0
       results[0]
     else
@@ -115,6 +119,73 @@ class NOMS::Nagui < NOMS::HttpClient
     end
   end
 
+  def calc_time(str)
+    case str
+    when /(\d+)m/
+      #minutes
+      $1.to_i * 60
+    when /(\d+)h/
+      #hours
+      $1.to_i * 3600
+    when /(\d+)d/
+      #days
+      $1.to_i * 86400
+    else
+      str.to_i
+    end
+  end
+
+  def process_command(cmd)
+    do_request(:POST => '/nagui/nagios_live.cgi', :body => "query=#{CGI.escape(cmd)}", :content_type => 'application/x-www-form-urlencoded')
+  end
+
+  def downtime_host(host,length,user,comment)
+    starttime=Time.now.to_i
+    endtime = starttime + calc_time(length)
+    cmd="COMMAND [#{Time.now.to_i}] SCHEDULE_HOST_DOWNTIME;#{host};#{starttime};#{endtime};1;0;0;#{user};#{comment}"
+    process_command(cmd)
+  end
+  def downtime_service(host,service,length,user,comment)
+    starttime=Time.now.to_i
+    endtime = starttime + calc_time(length)
+    cmd="COMMAND [#{Time.now.to_i}] SCHEDULE_SVC_DOWNTIME;#{host};#{service};#{starttime};#{endtime};1;0;0;#{user};#{comment}"
+    process_command(cmd)
+  end
+  def undowntime(host,service=nil)
+    if service == nil
+      host_record = host(host)
+      host_record['downtimes'].each do |id|
+        cmd = "COMMAND [#{Time.now.to_i}] DEL_HOST_DOWNTIME;#{id}"
+        process_command(cmd)
+      end    
+    else
+      service_record = service(host,service)
+      service_record['downtimes'].each do |id|
+        cmd = "COMMAND [#{Time.now.to_i}] DEL_SVC_DOWNTIME;#{id}"  
+        process_command(cmd)
+      end  
+    end
+  end
+
+  def comment(host,service,user,comment)
+    if service == nil
+      cmd="COMMAND [#{Time.now.to_i}] ADD_HOST_COMMENT;#{host};1;#{user};#{comment}"
+    else
+      cmd="COMMAND [#{Time.now.to_i}] ADD_SVC_COMMENT;#{host};#{service};1;#{user};#{comment}"
+    end
+    process_command(cmd)
+  end
+
+  def ack_host(host,user,comment)
+    cmd="COMMAND [#{Time.now.to_i}] ACKNOWLEDGE_HOST_PROBLEM;#{host};0;1;1;#{user};#{comment}"
+    process_command(cmd)
+  end
+
+  def ack_service(host,service,user,comment)
+    cmd="COMMAND [#{Time.now.to_i}] ACKNOWLEDGE_SVC_PROBLEM;#{host};#{service};0;1;1;#{user};#{comment}"
+    process_command(cmd)
+  end
+
   def nagcheck_host(host)
     url = "/nagcheck/host/#{host}"
     dbg("nagcheck url= #{url}")

data/spec/01nomscmdb_spec.rb

@@ -5,7 +5,11 @@ require 'spec_helper'
 
 describe NOMS::CMDB do
 
-    before(:all) { init_test }
+    before(:all) do
+        init_test
+
+        NOMS::CMDB.mock! nil
+    end
 
     describe "#new" do
 
@@ -18,4 +22,41 @@ describe NOMS::CMDB do
 
     end
 
+    describe "#create" do
+
+        before(:each) { @cmdb = NOMS::CMDB.new $opt }
+
+        it 'creates an entry' do
+            obj = @cmdb.create('system', { 'fqdn' => 'test0', 'inventory_component_type' => 'system'})
+            expect(obj).to have_key 'fqdn'
+            expect(obj).to have_key 'inventory_component_type'
+            expect(obj['fqdn']).to eq 'test0'
+        end
+
+        it 'finds the same entry' do
+            @cmdb.create('system', { 'fqdn' => 'test2', 'inventory_component_type' => 'system'})
+            obj = @cmdb.system('test2')
+            expect(obj).to have_key 'fqdn'
+            expect(obj).to include 'inventory_component_type' => 'system'
+        end
+
+        it 'creates an entry under the specified key' do
+            @cmdb.create('system', { 'inventory_component_type' => 'system' }, 'test3')
+            obj = @cmdb.system('test3')
+            expect(obj).to include 'fqdn' => 'test3'
+            expect(obj).to include 'inventory_component_type' => 'system'
+        end
+
+        it 'fails to create a keyless entry' do
+            expect { @cmdb.create('system', { 'environment_name' => 'random' }) }.to raise_error(NOMS::Error)
+        end
+
+        it 'fails when different keys are specified' do
+            expect { @cmdb.create('system',
+                                  { 'fqdn' => 'test3', 'environment_name' => 'random' },
+                                  'test4') }.to raise_error(NOMS::Error)
+        end
+
+    end
+
 end

data/spec/04cmdb-mock_spec.rb

@@ -3,6 +3,8 @@
 require 'noms/cmdb'
 require 'spec_helper'
 
+# The NOMS::CMDB::RestMock has
+# a non-upserting PUT
 describe NOMS::CMDB::RestMock do
 
     before(:all) do
@@ -62,39 +64,28 @@ describe NOMS::CMDB::RestMock do
             it 'synthesizes an id' do
                 result = @cmdb.do_request :POST => '/environments', :body => { 'name' => 'production' }
                 expect(result).to have_key 'id'
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to include { |o| o['id'] = result['id'] }
+                expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to include { |o| o['id'] == result['id'] }
+            end
+
+            it 'understands alternate id fields' do
+                result = @cmdb.do_request :POST => '/system', :body => {
+                    'fqdn' => 'test0',
+                    'environment_name' => 'production' }
+                expect(result).to have_key 'fqdn'
+                expect(@cmdb.all_data[$server][$cmdbapi + '/system']).to include { |o| o['fqdn'] == 'test0' }
             end
 
         end
 
         context :PUT do
 
-            it 'creates a new entry' do
-                @cmdb.do_request :PUT => '/environments/1', :body => {
-                    'name' => 'production', 'environment_name' => 'production' }
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to include { |o| o['name'] == 'production' }
-            end
-
-            it 'creates several new entries' do
-                @cmdb.do_request :PUT => '/environments/1', :body => {
-                    'name' => 'production', 'environment_name' => 'production' }
-                10.times do |i|
-                    @cmdb.do_request :PUT => "/environments/#{100 + i}", :body => {
-                        'name' => "environment-#{i}", 'environment_name' => 'production' }
-                end
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to have(11).items
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to include { |o| o['name'] == 'production' }
-            end
-
-            it 'infers the id' do
-                result = @cmdb.do_request :PUT => '/environments/1', :body => { 'name' => 'production' }
-                expect(result).to have_key 'id'
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments'][0]).to have_key 'id'
-                expect(@cmdb.all_data[$server][$cmdbapi + '/environments'][0]['id']).to eq '1'
+            it 'fails to create a new entry' do
+                expect { @cmdb.do_request(:PUT => '/environments/1', :body => {
+                                          'name' => 'production', 'environment_name' => 'production' }) }.to raise_error(NOMS::Error)
             end
 
             it 'replaces an existing object' do
-                @cmdb.do_request :PUT => '/environments/1', :body => {
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1',
                     'name' => 'production', 'environment_name' => 'production' }
                 @cmdb.do_request :PUT => '/environments/1', :body => {
                     'name' => 'testing', 'note' => 'testing environment' }
@@ -110,7 +101,7 @@ describe NOMS::CMDB::RestMock do
                 def @cmdb.allow_partial_updates
                     true
                 end
-                @cmdb.do_request :PUT => '/environments/1', :body => {
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1',
                     'name' => 'production', 'environment_name' => 'production' }
                 @cmdb.do_request :PUT => '/environments/1', :body => {
                     'name' => 'testing', 'note' => 'testing environment' }
@@ -134,6 +125,16 @@ describe NOMS::CMDB::RestMock do
                 expect(result).to include 'name' => 'production'
             end
 
+            it 'finds an existing entry by alternate id' do
+                @cmdb.do_request :POST => '/system', :body => {
+                    'fqdn' => 'test0', 'environment_name' => 'production'
+                }
+                result = @cmdb.do_request :GET => '/system/test0'
+                expect(result).to be_a Hash
+                expect(result).to include 'fqdn' => 'test0'
+                expect(result).to include 'environment_name' => 'production'
+            end
+
             it 'retrieves all entries' do
                 @cmdb.do_request :POST => '/environments', :body => {
                     'name' => 'production', 'environment_name' => 'production'
@@ -151,7 +152,7 @@ describe NOMS::CMDB::RestMock do
 
             it 'raises an exception for missing entries' do
                 expect { @cmdb.do_request :GET => '/environments/1' }.to raise_error
-                @cmdb.do_request :PUT => '/environments/1', :body => { 'name' => 'production' }
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1', 'name' => 'production' }
                 expect { @cmdb.do_request :GET => '/chorizo' }.to raise_error
                 expect { @cmdb.do_request :GET => '/environments/2' }.to raise_error
             end
@@ -161,16 +162,16 @@ describe NOMS::CMDB::RestMock do
         context :DELETE do
 
             it 'deletes an existing entry' do
-                @cmdb.do_request :PUT => '/environments/1', :body => { 'name' => 'production' }
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1', 'name' => 'production' }
                 result = @cmdb.do_request :DELETE => '/environments/1'
                 expect(result).to be true
                 expect(@cmdb.all_data[$server][$cmdbapi + '/environments']).to have(0).items
             end
 
             it 'deletes an existing entry among many' do
-                @cmdb.do_request :PUT => '/environments/1', :body => { 'name' => 'production' }
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1', 'name' => 'production' }
                 10.times do |i|
-                    @cmdb.do_request :PUT => "/environments/#{100 + i}", :body => {
+                    @cmdb.do_request :POST => "/environments", :body => { 'id' => "#{100 + i}",
                         'name' => "environment-#{i}", 'environment_name' => 'production' }
                 end
                 @cmdb.do_request :DELETE => '/environments/103'
@@ -180,14 +181,14 @@ describe NOMS::CMDB::RestMock do
             end
 
             it 'deletes a whole collection' do
-                @cmdb.do_request :PUT => '/environments/1', :body => {'name' => 'production' }
+                @cmdb.do_request :POST => '/environments', :body => {'id' => '1', 'name' => 'production' }
                 @cmdb.do_request :DELETE => '/environments'
                 expect(@cmdb.all_data[$server]).not_to have_key '/environments'
             end
 
             it 'raises an exception for nonexistent entries' do
                 expect { @cmdb.do_request :DELETE => '/environments/2' }.to raise_error
-                @cmdb.do_request :PUT => '/environments/1', :body => { 'name' => 'production' }
+                @cmdb.do_request :POST => '/environments', :body => { 'id' => '1', 'name' => 'production' }
                 expect { @cmdb.do_request :DELETE => '/environments/2' }.to raise_error
                 expect { @cmdb.do_request :DELETE => '/chorizo' }.to raise_error
             end

data/spec/05restmock-persist_spec.rb

@@ -42,10 +42,11 @@ describe NOMS::CMDB::RestMock do
             end
         end
 
-        context :PUT do
+        context :POST do
 
             it 'creates a new entry' do
-                @cmdb.do_request :PUT => '/environments/production', :body => {
+                @cmdb.do_request :POST => '/environments', :body => {
+                    'id' => 'production',
                     'name' => 'production', 'environment_name' => 'production' }
                 expect(File.exist? $datafile).to be true
             end

data/spec/06noms-mock.sh

@@ -33,3 +33,22 @@ teardown() {
 EOF
     noms --config=test/etc/noms.conf --mock=test/data.json cmdb show test1.example.com
 }
+
+@test "noms-mock cmdb add" {
+    cat >test/data.json <<EOF
+{ "cmdb": {
+  "/cmdb_api/v1/system": [
+     { "id": "test1.example.com",
+       "fqdn": "test1.example.com",
+       "status": "idle",
+       "environment": "testing",
+       "data_center_code": "DC1",
+       "ip_address": "10.0.0.1" }
+    ]
+  }
+}
+EOF
+    noms --config=test/etc/noms.conf --mock=test/data.json cmdb add test2.example.com inventory_component_type=system
+    type=$(noms --config=test/etc/noms.conf --mock=test/data.json --nolabel cmdb show test2.example.com inventory_component_type)
+    [ "$type" = 'system' ]
+}

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: noms-client
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
+  prerelease: 
 platform: ruby
 authors:
 - Jeremy Brinkley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,43 +46,49 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: optconfig
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -93,11 +104,11 @@ files:
 - Gemfile
 - LICENSE
 - README.rst
+- ROADMAP.rst
 - Rakefile
 - TODO
 - bin/ansible-cmdb
 - bin/noms
-- control.m4
 - etc/noms.conf
 - lib/ncc/client.rb
 - lib/noms/client/version.rb
@@ -117,26 +128,27 @@ files:
 homepage: http://github.com/evernote/noms-client
 licenses:
 - Apache-2
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Client libraries and command-line tool for NOMS components
 test_files:
 - spec/01nomscmdb_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9e24aa514edf837a8d6d263ffe707e86aefcc76f
-  data.tar.gz: 09e54474d3b41a4a257fa1cf98a248ad16b66cd5
-SHA512:
-  metadata.gz: c6707f63d16653725c7d9e00be5421e282db4a7195a932bd793643021f70ef8da14a04d698bcd940c1fc41ffa3d11613ec24180bb54b59e357ccb9970fb7bc1e
-  data.tar.gz: 35bf1ffa2984e3f338927060d46f1021b8c2b21b09d8656f70cd965468c920800aaf4752995cc3435f9cc7679767781d3f224a1cd32aac131946042e3c0f523f

data/control.m4

@@ -1,8 +0,0 @@
-Package: noms-client
-Version: __VERSION__-__RELEASE__
-Architecture: all
-Section: Miscellaneous
-Priority: optional
-Maintainer: Evernote Operations <ops@evernote.com>
-Description: This package is the Evernote-specific noms-client build
-