module Mac::User

Public Instance Methods

gid_next() click to toggle source

Gives the next gid not used on the system

@return [Fixnum] The next gid not used on the system

# File lib/beaker/host/mac/user.rb, line 84
def gid_next
  gid_last = execute("dscl . -list /Users PrimaryGroupID | sort -k 2 -g | tail -1 | awk '{print $2}'")
  gid_last.to_i + 1
end
uid_next() click to toggle source

Gives the next uid not used on the system

@return [Fixnum] The next uid not used on the system

# File lib/beaker/host/mac/user.rb, line 76
def uid_next
  uid_last = execute("dscl . -list /Users UniqueID | sort -k 2 -g | tail -1 | awk '{print $2}'")
  uid_last.to_i + 1
end
user_absent(name, &block) click to toggle source

Makes sure the user is absent, deleting them if necessary

@param [String] name Name of the user @param [Proc] block Additional actions or insertions

# File lib/beaker/host/mac/user.rb, line 69
def user_absent(name, &block)
  execute("if dscl . -list /Users/#{name}; then dscl . -delete /Users/#{name}; fi", {}, &block)
end
user_get(name) { |result| ... } click to toggle source

Gets the user information in /etc/passwd format

@note Calls POSIX-compliant ‘$ id -P <user>` to get /etc/passwd-style output

@param [String] name Name of the user @param [Proc] block Additional actions or insertions

@yield [Result] User information in /etc/passwd format @return [Result] User information in /etc/passwd format @raise [FailTest] Raises an Assertion failure if it can’t find the name

queried for in the returned block
# File lib/beaker/host/mac/user.rb, line 34
def user_get(name)
  execute("id -P #{name}") do |result|
    fail_test "failed to get user #{name}" unless /^#{name}:/.match?(result.stdout)

    yield result if block_given?
    result
  end
end
user_list() { |result| ... } click to toggle source

Gets a list of user names on the system

@param [Proc] block Additional actions or insertions

@return [Array<String>] The list of user names on the system

# File lib/beaker/host/mac/user.rb, line 9
def user_list
  execute('dscacheutil -q user') do |result|
    users = []
    result.stdout.each_line do |line|
      users << line.split(': ')[1].strip if /^name:/.match?(line)
    end

    yield result if block_given?

    users
  end
end
user_present(name) click to toggle source

Makes sure the user is present, creating them if necessary

@param [String] name Name of the user @param [Proc] block Additional actions or insertions

# File lib/beaker/host/mac/user.rb, line 47
def user_present(name)
  user_exists = false
  execute("dscacheutil -q user -a name #{name}") do |result|
    user_exists = result.stdout.start_with?("name: #{name}")
  end

  return if user_exists

  uid = uid_next
  gid = gid_next
  create_cmd = "dscl . create /Users/#{name}"
  create_cmd << " && dscl . create /Users/#{name} NFSHomeDirectory /Users/#{name}"
  create_cmd << " && dscl . create /Users/#{name} UserShell /bin/bash"
  create_cmd << " && dscl . create /Users/#{name} UniqueID #{uid}"
  create_cmd << " && dscl . create /Users/#{name} PrimaryGroupID #{gid}"
  execute(create_cmd)
end