depot3 0.0.0a1 → 3.0.7

data/lib/d3/basename.rb

@@ -0,0 +1,217 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+
+  ###
+  ### This mixin module provides attributes and methods for
+  ### dealing with d3 basenames, i.e. package families.
+  ### It's used by the {D3::Package}, {D3::Client::Receipt}, and {D3::Client::PendingPuppy} classes.
+  ###
+  module Basename
+    include Comparable
+
+    ### The status of D3::Package & D3::Client::Receipt objects, and the integers stored
+    ### in the DB for each D3::Package
+    ###
+    ###  - :unsaved
+    ###      D3::Package: a Ruby object that hasn't yet been created  on the server
+    ###      D3::Client::Receipt: a Ruby object that hasn't yet been saved to the local
+    ###        receipt datastore
+    ###
+    ###  - :pilot
+    ###      D3::Package: on the server, but not yet been made live,1
+    ###      D3::Client::Receipt: installed when the pkg was in that state.
+    ###
+    ###  - :live
+    ###      D3::Package: the currently active pkg for a given basename,
+    ###      D3::Client::Receipt: the matching pkg is current live on the server
+    ###
+    ###  - :deprecated
+    ###      D3::Package: was once live, now superseded by a new version, but
+    ###        still on the server
+    ###      D3::Client::Receipt: the rcpt is older than the currently live pkg &
+    ###        will be upgraded at sync unless it was installed as a pilot
+    ###
+    ###  - :skipped
+    ###      D3::Package: never made live, but older than the current live
+    ###        installer, still on the server, probably should be deleted
+    ###
+    ###  - :missing
+    ###      D3::Package: the data is in the D3 Packages table, but the pkg is
+    ###        not in the JSS
+    ###      D3::Client::Receipt: No matching :pilot, :live, or :deprecated pkg on
+    ###        the server
+    ###
+    ###  - :deleted
+    ###      D3::Package: the matching d3 data has been deleted from the server
+    ###      D3::Client::Receipt: the matching receipt has been deleted from the client
+    ###
+    STATUSES =  [
+      :unsaved,
+      :pilot,
+      :live,
+      :deprecated,
+      :skipped,
+      :missing,
+      :deleted
+    ]
+
+    ### When filtering lists of pkgs/rcpts, unsaved and deleted are meaningless, so use this list
+    STATUSES_FOR_FILTERS =  [
+      :pilot,
+      :live,
+      :deprecated,
+      :skipped,
+      :missing
+    ]
+
+    ################# Attributes #################
+
+    ### @return [String] the basname of the thing installed
+    attr_reader :basename
+
+    ### @return [String] the version of the thing installed
+    attr_reader :version
+
+    ### @return [Integer]  the d3 release number of the thing installed
+    attr_reader :revision
+
+    ### @return [String]  who's uploading, releasing, installing, or archiving this thing?
+    attr_reader :admin
+
+    ### @return [Integer] the JSS id of this package
+    attr_reader :id
+
+    ### @return [Symbol] whats the d3 status of this package? One of the values of D3::Basename::STATUSES
+    attr_reader :status
+
+    # @return [Symbol] Is this package a .dmg or .pkg?
+    attr_reader :package_type
+
+    ### @return [String] a string for matching to the output lines
+    ###   of '/bin/ps -A -c -o comm'. If there's a match, this pkg won't be
+    ###   installed or uninstalled
+    attr_reader :prohibiting_process
+
+    # @return [Integer] the days of disuse before an expirable edition expires. 0=never
+    attr_reader :expiration
+
+    # @return [String] the path to the executable that needs come to the foreground to prevent expiration
+    attr_reader :expiration_path
+
+
+    ################# Public Instance Methods #################
+
+    ### While several packages can have the same basename,
+    ### the combination of basename, version, and revision
+    ### (called the 'edition') must be unique
+    ### among the d3 packages.
+    ###
+    ### @return [String] the basename, version ,and revision of this package, joined with hyphens
+    ###
+    def edition
+      "#{@basename}-#{@version}-#{@revision}"
+    end
+
+    ### Use comparable to give sortability
+    ### and equality.
+    ###
+    ###
+    def <=> (other)
+     self.edition <=> other.edition
+    end # <=>
+
+    ### Is the status :saved?
+    ###
+    ### @return [Boolean]
+    ###
+    def saved?
+      @status != :unsaved
+    end
+
+    ### Is the status :pilot?
+    ###
+    ### @return [Boolean]
+    ###
+    def pilot?
+      @status == :pilot
+    end
+
+    ### Is the status :live?
+    ###
+    ### @return [Boolean]
+    ###
+    def live?
+      @status == :live
+    end
+
+    ### @return [Boolean] Is this pkg skipped?
+    ###   See {D3::Database::PACKAGE_STATUSES} for details
+    ###
+    def skipped?
+      @status == :skipped
+    end
+
+    ### Is the status :deprecated?
+    ###
+    ### @return [Boolean]
+    ###
+    def deprecated?
+      @status == :deprecated
+    end
+
+
+    ### Is the status :missing?
+    ###
+    ### @return [Boolean]
+    ###
+    def missing?
+      @status == :missing
+    end
+
+    ### Is the status :deleted?
+    ###
+    ### @return [Boolean]
+    ###
+    def deleted?
+      @status == :deleted
+    end
+
+    private
+
+    ### set the status
+    ###
+    ### @param new_status[Symnol]  one of the  valid STATUSES
+    ###
+    ### @return [Symbol] the new status
+    ###
+    def status= (new_status)
+      raise JSS::InvalidDataError, "status must be one of :#{STATUSES.join(', :')}" unless STATUSES.include? new_status
+      @status = new_status
+    end
+
+  end # module Basename
+end # module PixD3

data/lib/d3/client/auth.rb

@@ -0,0 +1,108 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+
+  class Client < JSS::Client
+
+
+    ################# Class Methods #################
+
+    ### Connect to the JSS and the DB with read-only connections
+    ### The connection details must be stored in the D3 and JSS
+    ### CONFIG data.
+    ###
+    def self.connect
+      jss_ro_user = D3::CONFIG.client_jss_ro_user
+      jss_ro_user ||= JSS::CONFIG.api_username
+
+      db_ro_user = D3::CONFIG.client_db_ro_user
+      db_ro_user ||= JSS::CONFIG.db_username
+
+      JSS::DB_CNX.connect :server => JSS::CONFIG.db_server_name, :user => db_ro_user, :pw => D3::Client.get_ro_pass(:db), :connect_timeout => 10
+      JSS::API.connect :server => JSS::CONFIG.api_server_name, :user => jss_ro_user, :pw => D3::Client.get_ro_pass(:jss), :open_timeout => 10
+
+      D3::Database.check_schema_version
+    end # connect
+
+    ### Disconnect from the JSS and DB
+    def self.disconnect
+      JSS::API.disconnect if JSS::API.connected?
+        JSS::DB_CNX.disconnect if JSS::DB_CNX.connected?
+    end # disconnect
+
+
+    ### Get a stored read-only password from a file or
+    ### an executable.
+    ###
+    ### Raises a JSS::UnsupportedError if the file isn't
+    ### owned by root with 0600 permissions.
+    ###
+    ### NOTE: for slightly better security, don't store the
+    ### result in a variable, use this method as needed to retrieve
+    ### the passwd every time you need it.
+    ###
+    ### See also D3::Configuration
+    ###
+    ### @param pw[Symbol] which pw to get, one of :jss, :db, :dist, :http
+    ###
+    ### @return [String, nil] the password, or nil if the file
+    ###   isn't defiend, or doesn't exist.
+    ###
+    def self.get_ro_pass (pw)
+      raise JSS::InvalidDataError, "Arg must be one of :jss, :db, :dist, :http" unless [:jss, :db, :dist, :http].include? pw
+
+      path = case pw
+      when :jss then  D3::CONFIG.client_jss_ropw_path
+      when :db then D3::CONFIG.client_db_ropw_path
+      when :dist then D3::CONFIG.client_distpoint_ropw_path
+      when :http then D3::CONFIG.client_http_ropw_path
+      end # path = case
+
+      return nil unless path
+
+      # if the path ends with a pipe, its a command that will
+      # return the desired password, so remove the pipe,
+      # execute it, and return stdout from it.
+      if path.end_with? "|"
+        return `#{path.chomp "|"}`.chomp
+      end
+
+      file = Pathname.new path
+      return nil unless file.file?
+      stat = file.stat
+      unless ("%o" % stat.mode).end_with? "0600" and stat.uid == 0
+        raise JSS::UnsupportedError, "Password file for '#{pw}' has insecure permissions, must be 0600."
+      end
+
+      # chomping an empty string removes all trailing \n's and \r\n's
+      file.read.chomp('')
+    end
+
+    ### Actions requiring an admin name
+
+  end # class Client
+end # module D3
+