workEnv 0.1.0

data/lib/WorkEnvs/Common/Dependencies.rb

@@ -0,0 +1,206 @@
+# coding: utf-8
+module WorkEnvs
+    # Class to store all the dependencies of an env
+    #
+    # It provides helpers to convert between version names and sha1
+    #
+    # Dependencies can come from multiple sources
+    # - rev_files
+    # - --sha1, --sub-sha1 options
+    # - --version option
+    # - Package (RPM, Deb) dependencies
+    #
+    # Dependencies from env to its version (and its subEnv versions) are stored
+    # as depInfo hash:
+    #
+    #  { :sha1 => <sha1>, :version => <version> }
+    class Dependencies
+        # Mark the environment as partial. (default = false)
+        #
+        # It means that it is OK for some environment class
+        # from the env dependency tree to not have any dep_info to them
+        attr_accessor :partialEnv
+
+        # Flag enable by setting WENV_IGNORE_CONFLICTS (default = nil)
+        #
+        # Ignore if a dep_info is pushed to an envClass is different from
+        # a previous dep_info pushed for the same envClass
+        # In this case, the first on is kept.
+        #
+        # SEROUSLY DANGEROUS ! DON'T USE IT UNLESS YOU KNOW WHAT YOU'RE DOING !!!
+        attr_reader :ignore_conflicts
+
+        # Pointer to a PackageDownloader used to convert version and SHA1 (default = nil)
+        attr_accessor :downloader
+
+        # Hash of dep_infos (default = {})
+        attr_reader :deps
+
+        # Array of fields to query in the package DB
+        FIELDS = [ :sha1, :version ]
+
+        # Default constructor
+        def initialize
+            @deps = {}
+            @partialEnv = false
+            @ignore_conflicts = nil
+            @ignore_conflicts = true if ENV["WENV_IGNORE_CONFLICTS"].to_s != ""
+            @downloader = nil
+        end
+
+        # Internal function to add a dependency to deps
+        #
+        # - env is either the envType or an envClass
+        # - dInfos is a dep_info hash generated by PackageDownloader
+        #
+        # Returns:
+        # - true on success
+        # - false on failure if @ignore_conflicts == true
+        # Throws an exception on failure if @ignore_conflicts != true
+        def _push(env, dInfos)
+            name = (env.kind_of? Symbol) ? env : WorkEnvs::getEnvType(env)
+
+            WorkEnvs::dputs("Deps[#{name}] <= (#{dInfos.to_s})")
+
+            FIELDS.each(){|f|
+                raise("Incomplete dependency #{dInfos}. '#{f.to_s}' field is missing") if dInfos[f] == nil
+            }
+
+            if @deps[name] != nil then
+                if @deps[name] != dInfos then
+                     return false if @ignore_conflicts == true
+
+                     raise("Invalid dependencies for #{name}.\nRequire for #{name.to_s} both:\n"+
+                           "\t* '#{@deps[name].to_s}'\n\t* '#{dInfos.to_s}' ")
+                end
+            end
+            @deps[name] = dInfos
+            return true
+        end
+        private :_push
+
+        # Convert an (envType, sha1) couple to a dep_info and add it to deps using #_push
+        #
+        # env is either the envType or an envClass
+        #
+        # Return _push result or false if required == false and no matching SHA1 was found
+        # in the DB
+        #
+        # Throws EmptyQueryException if required == true and no match was found
+        def push_sha1(env, sha1, required = true)
+            return false if sha1.to_s == ""
+            #SHA1 but no version
+            dInfos = @downloader.queryDepInfosFromSHA1(env, sha1, required)
+            return false if dInfos == nil
+            return _push(env, dInfos)
+        end
+
+        # Convert an (envType, version) couple to a dep_info and add it to deps using #_push
+        #
+        # env is either the envType or an envClass
+        #
+        # Return _push result or false if required == false and no matching version was found
+        # in the DB
+        #
+        # Throws EmptyQueryException if required == true and no match was found
+        def push_version(env, version, required = true)
+            return false if version.to_s == ""
+
+            #SHA1 but no version
+            dInfos = @downloader.queryDepInfosFromVersion(env, version, required)
+            return false if dInfos == nil
+            return _push(env, dInfos)
+        end
+
+        # Convert an (envType, package full name) couple to a dep_info and add it to deps using #_push
+        #
+        # env is either the envType or an envClass
+        #
+        # Return _push result or false if required == false and no matching package was found
+        # in the DB
+        #
+        # Throws EmptyQueryException if required == true and no match was found
+        def push_name(env, pName, required = true)
+            dInfos = @downloader.queryDepInfosFromName(env, pName, required)
+            return false if dInfos == nil
+            return _push(env, dInfos)
+        end
+
+        # Return if there is a dep_into to the envType name
+        def exists?(name)
+            return @deps[name] != nil
+        end
+
+        # Remove (if any) the dep_into to the envType name
+        def del(name)
+            return @deps[name] = nil
+        end
+
+        # Get the required version string for envType name
+        def get_version(name)
+            return nil if @deps[name] == nil
+            return @deps[name][:version]
+        end
+
+        # Get the required SHA1 string for envType name
+        def get_sha1(name)
+            return nil if @deps[name] == nil
+            return @deps[name][:sha1]
+        end
+
+        # Iterator on dep_infos
+        #
+        # Block args are (envType, dep_info)
+        def each()
+            @deps.each(){|name, h|
+                yield name, h
+            }
+        end
+
+        # Generates a string with a human reable list of all dep_infos
+        def to_s
+            str = ""
+            @deps.each(){|name, h|
+                str+= "\t" + name.to_s.ljust(20) + "=> " + h[:version].to_s + " (" + h[:sha1].to_s + ")\n"
+            }
+            return str
+        end
+
+        # Returns true if there is no dep_info
+        def empty?
+            return @deps.empty?
+        end
+
+        # Compare two Dependencies
+        #
+        # This make sure all dep_infos are the sames in the two
+        def ==(another)
+            begin
+                @deps.each(){|name, h|
+                    return false if another.deps[name] != h
+                }
+                another.each(){|name, h|
+                    return false if @deps[name] != h
+                }
+                return true
+            rescue => e
+                return false
+            end
+        end
+
+        # Concat another Dependencies object into this one
+        #
+        # Throws exception if both are incompatible
+        def concat(another)
+            if another != nil then
+                another.each(){|name, h|
+                    _push(name, h)
+                }
+                if another.partialEnv == true
+                    @partialEnv = true
+                end
+            end
+            return self
+        end
+    end
+end

data/lib/WorkEnvs/Common/EnvOpts.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+
+module WorkEnvs
+
+    # Name of the no dkms options
+    WENV_OPTS_NODKMS = "nodkms"
+    # Help string for the no dkms options
+    WENV_OPTS_NODKMS_STRING =
+        "\t#{WENV_OPTS_NODKMS}=false                                             Build DKMS modules"
+
+    # Name of the no eclipse options
+    WENV_OPTS_NOECLIPSE = "noeclipse"
+    # Help string for the no eclipse options
+    WENV_OPTS_NOECLIPSE_STRING =
+        "\t#{WENV_OPTS_NOECLIPSE}=true                                           Do not install eclipse plugins"
+
+    # Name of the external options
+    WENV_OPTS_EXTERNAL = "external"
+    # Help string for the external options
+    WENV_OPTS_EXTERNAL_STRING =
+        "\t#{WENV_OPTS_EXTERNAL}=true                                            Do not install internal packages "
+
+    # Name of the partial options
+    WENV_OPTS_PARTIAL = "partial"
+    # Help string for the partial options
+    WENV_OPTS_PARTIAL_STRING =
+        "\t#{WENV_OPTS_PARTIAL}=true                                             Support partially checked out environment "
+
+    # Name of the remote install options
+    WENV_OPTS_REMOTE_INSTALL = "remote-install"
+    # Help string for the remote install options
+    WENV_OPTS_REMOTE_INSTALL_STRING =
+        "\t#{WENV_OPTS_REMOTE_INSTALL}=false                                     Disable install of packages on remote "
+
+    # Name of the remote host options
+    WENV_OPTS_REMOTE_HOST_INSTALL = "remote-host"
+    # Help string for the remote host options
+    WENV_OPTS_REMOTE_HOST_INSTALL_STRING =
+        "\t#{WENV_OPTS_REMOTE_HOST_INSTALL}=<host>                                       Install of packages on the specified remote host "
+
+    # Name of the const options
+    WENV_OPTS_CONST = "const"
+    # Help string for the const options
+    WENV_OPTS_CONST_STRING =
+        "\t#{WENV_OPTS_CONST}=true                                               Remove all write rights to environment so it cannot be modified"
+
+    # Name of the sparse options
+    WENV_OPTS_SPARSE = "sparse"
+    # Help string for the sparse options
+    WENV_OPTS_SPARSE_STRING =
+        "\t#{WENV_OPTS_SPARSE}=true                                              Sparse update of the env (skip some unneeded packages"
+
+    # Class to store envClass options
+    class EnvOpts
+        # Default constructor
+        def initialize
+            @opts = {}
+        end
+
+        # Iterates on all options set
+        #
+        # Block args are (option name, option val)
+        def each()
+            @opts.each(){|name, val|
+                yield name, val
+            }
+        end
+
+        # Returns true if there are no options set
+        def empty?
+            return @opts.empty?
+        end
+
+        # Returns the value of the option "name"
+        #
+        # Returns "" if the option was not set
+        def [](name)
+            return "" if @opts[name] == nil
+            return @opts[name]
+        end
+
+
+        # Set the value of the option "name"
+        #
+        # Returns its value
+        def []=(name, val)
+            @opts[name] = val
+            return val
+        end
+
+        # Parse an option string and add it to self
+        #
+        # String format is name=val
+        #
+        # val cannot contain an "=" symbol
+        def <<(string)
+            args = string.split("=")
+            raise("Unsupported option #{string}") if args.length != 2
+            @opts[args[0]] = args[1];
+        end
+
+        # Compare two EnvOpts
+        def ==(another)
+            begin
+                @opts.each(){|name, val|
+                    return false if another[name] != val
+                }
+                another.each(){|name, val|
+                    return false if @opts[name] != val
+                }
+                return true
+            rescue
+                return false
+            end
+        end
+
+        # Concat another EnvOpts into this one
+        #
+        # Value set in this one are NOT overwritten by the other one
+        def concat(another)
+            if another != nil then
+                another.each(){|name, val|
+                    @opts[name] =  val if @opts[name] == nil || @opts[name] == ""
+                }
+            end
+            return self
+        end
+	end
+end

data/lib/WorkEnvs/Common/Package.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+module WorkEnvs
+    # Class to briefly describe a MAIN_PACKAGE of an envClass
+    #
+    # This is only used to get a list of possible MAIN_PACKAGE version
+    # of a given class to provide a human readable list of accessible package
+    class EnvPackage
+        # Full name of the package
+        attr_reader :name
+        # SHA1 that generated the package
+        attr_reader :sha1
+        # Package the branch was generated on
+        attr_reader :branch
+        # Additional info (timestamp usually) on the package
+        attr_reader :info
+
+        # Default Constructor
+        def initialize(name, sha1, branch, info)
+            @name = name
+            @sha1 = sha1
+            @branch = branch
+            @info = info
+        end
+
+        # Returns a human readable string of the package data
+        def to_s()
+            return "\t" + @name.to_s.ljust(65) + "\t" +
+                @sha1.to_s + "\t" +
+                @branch.to_s.ljust(40) +
+                @info.to_s
+        end
+    end
+
+    # Class to describe a package
+    class Package
+
+        # Package name (without version/release/etc)
+        #
+        # Also known as "project" in de DB
+        attr_accessor :name
+        # Package attributes (default = {}
+        #
+        # Currently supported attributes:
+        # - :install
+        #   - :dkms : Packet is installed during an env update when --install-dkms is set
+        #   - :install: Packet is always installed during an env update. SHOULD NOT BE SET
+        # - :keep : Package is kept after download/extraction event if keep-packages is not set
+        attr_accessor :attributes
+        # Full package name (ie name-version-release.rpm)
+        attr_accessor :pack
+        # Full path to the package
+        attr_accessor :path
+
+        # Default constructor
+        def initialize(name, attributes = {}, pack=nil)
+            @name = name
+            @attributes = attributes
+            @pack = pack
+            @path = nil
+        end
+
+        # Returns the package name
+        def to_s()
+            return @name
+        end
+
+        # Compare two Package objects themselves (not the content)
+        #
+        # Used for sorting
+        def eql?(other)
+            return self == other
+        end
+
+        # Compare two Package objects values
+        def ==(other)
+            return false if other == nil
+            return self.hash() == other.hash()
+        end
+
+        # Spaceship operation
+        #
+        # Calls <=> on full package names
+        #
+        # Used for sorting
+        def <=>(other)
+            return @pack <=> other.pack()
+        end
+
+        # Returns a Package hash
+        #
+        # Used for sorting
+        def hash()
+            return { :name => @name, :attributes => @attributes, :pack => @pack, :path => @path }.hash()
+        end
+
+        # Returns true if the package should be installed
+        #
+        # A package should be installed if:
+        # - it has the attribute :install == true
+        # - it has the attribute :install == :dkms and :installDKMS options is set
+        def shouldInstall(opts)
+            return @attributes[:install] == true ||
+                ( @attributes[:install] == :dkms && opts[:installDKMS] == true)
+        end
+
+        # Returns true if the package should be kept after download/extraction
+        #
+        # A package should be kept if:
+        # - it has the attribute :keep == true
+        # - it the :keepPackages options is set
+        def shouldKeep(opts)
+            return @attributes[:keep] == true || opts[:keepPackages] == true
+        end
+    end
+end