aboutsummaryrefslogtreecommitdiff
path: root/test/src/itest-common/src/main/groovy/com/cloudera/itest/pmanager/PackageInstance.groovy
blob: 4a68211a062ee2e56404e0c54cd632428a375453 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.cloudera.itest.pmanager

import com.cloudera.itest.posix.Service

abstract class PackageInstance {
  PackageManager mgr;

  String name;
  String version;
  String release;
  String arch;

  Map meta = [:];
  String installMessages;

  protected List<String> files;
  protected List<String> docs;
  protected List<String> configs;
  protected Map<String, Service> services;
  protected Map<String, String> deps;

  /**
   * Check if this package is installed on the system
   *
   * @return true if the package is installed and can be used, false otherwise
   */
  abstract public boolean isInstalled();
  /**
   * Install this package (from collection of all the packages available in all the repositories)
   *
   * @return int return code of the operation: o in case of success, non-zero otherwise
   */
  abstract public int install();
  /**
   * Remove this package from a system
   *
   * @return int return code of the operation: o in case of success, non-zero otherwise
   */
  abstract public int remove();
  /**
   * Re-sync metadata associated with this package with the underlying package management system
   *
   * @return int return code of the operation: o in case of success, non-zero otherwise
   */
  abstract public void refresh();
  /**
   * Get a list of services (System V init scripts) provided by this package
   *
   * @return list of Service instances
   */
  abstract public Map<String, Service> getServices();
  /**
   * Get a list of files provided by this package. This list will include ALL the files regardless
   * of whether they are also marked as configs or documentation.
   *
   * @return list file and directory names belong to the package.
   */
  abstract public List<String> getFiles();
  /**
   * Get a list of documentation files provided by this package (if the underlying package
   * management system doesn't support a notion of a documentation file -- empty list is expected
   * to be returned.
   *
   * @return list config file names that belong to the package.
   */
  abstract public List<String> getDocs();
  /**
   * Get a list of configuration files provided by this package (if the underlying package
   * management system doesn't support a notion of a configuration file -- empty list is expected
   * to be returned.
   *
   * @return list config file names that belong to the package.
   */
  abstract public List<String> getConfigs();
  /**
   * Get a list of dependencies for this package. Dependency information is stored in a map with
   * keys being names of the objects and values being version information in the following format:
   *     [version operator] version
   * E.g. >= 3.3.1+10
   *
   * @return map of objects (mostly packaged) this package depends on
   */
  abstract public Map<String, String> getDeps();

  /**
   * Factory method for creating an instance of a Package that can reside in
   * a particular instance of a PackageManager.
   * NOTE: For now only 'natural' pairing is supported (e.g. deb with apt, rpm
   * with yum/zypper)
   *
   * @param mgr package manager that is expected to manage this type of package
   * @param name package manager dependent name of a package
   */
  static public PackageInstance getPackageInstance(PackageManager mgr, String name) {
    PackageInstance pkg = (mgr.type == "apt" ) ? new DEBPackage() :
                                                 new RPMPackage();
    pkg.mgr = mgr;
    pkg.name = name;
    return pkg;
  }
}