summaryrefslogtreecommitdiff
path: root/src/main/java/com/android/vts/entity/ApiCoverageEntity.java
blob: 0a417436645231551a20a2633e8881a0bf111423 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.android.vts.entity;

import static com.googlecode.objectify.ObjectifyService.ofy;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.googlecode.objectify.Key;
import com.googlecode.objectify.annotation.Cache;
import com.googlecode.objectify.annotation.Entity;
import com.googlecode.objectify.annotation.Id;
import com.googlecode.objectify.annotation.Index;
import com.googlecode.objectify.annotation.Parent;
import java.util.Date;
import java.util.List;
import java.util.UUID;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * Entity Class for ApiCoverageEntity
 */
@Cache
@Entity(name = "ApiCoverage")
@EqualsAndHashCode(of = "id")
@NoArgsConstructor
@JsonAutoDetect(fieldVisibility = Visibility.ANY)
@JsonIgnoreProperties({"id", "parent"})
public class ApiCoverageEntity {

  /**
   * ApiCoverageEntity id field
   */
  @Id
  @Getter
  @Setter
  String id;

  @Parent
  @Getter
  Key<?> parent;

  /**
   * HAL package name. e.g. android.hardware.foo.
   */
  @Index
  @Getter
  @Setter
  String halPackageName;

  /**
   * HAL (major) version. e.g. 1.
   */
  @Index
  @Getter
  @Setter
  int halMajorVersion;

  /**
   * HAL (minor) version. e.g. 0.
   */
  @Index
  @Getter
  @Setter
  int halMinorVersion;

  /**
   * HAL interface name. e.g. IFoo.
   */
  @Index
  @Getter
  @Setter
  String halInterfaceName;

  /**
   * List of HAL API
   */
  @Getter
  @Setter
  List<String> halApi;

  /**
   * List of HAL covered API
   */
  @Getter
  @Setter
  List<String> coveredHalApi;

  /**
   * When this record was created or updated
   */
  @Index
  Date updated;

  /**
   * Constructor function for ApiCoverageEntity Class
   */
  public ApiCoverageEntity(com.google.appengine.api.datastore.Key testRunKey, String halPackageName,
      int halVersionMajor, int halVersionMinor, String halInterfaceName, List<String> halApi,
      List<String> coveredHalApi) {

    this.parent = getParentKey(testRunKey);

    this.halPackageName = halPackageName;
    this.halMajorVersion = halVersionMajor;
    this.halMinorVersion = halVersionMinor;
    this.halInterfaceName = halInterfaceName;
    this.halApi = halApi;
    this.coveredHalApi = coveredHalApi;
  }

  /**
   * Constructor function for ApiCoverageEntity Class with objectify Key.
   */
  public ApiCoverageEntity(Key testRunKey, String halPackageName,
                           int halVersionMajor, int halVersionMinor, String halInterfaceName,
                           List<String> halApi, List<String> coveredHalApi) {
    this.parent = testRunKey;

    this.halPackageName = halPackageName;
    this.halMajorVersion = halVersionMajor;
    this.halMinorVersion = halVersionMinor;
    this.halInterfaceName = halInterfaceName;
    this.halApi = halApi;
    this.coveredHalApi = coveredHalApi;
  }

  /**
   * Get objectify Key from datastore Key type
   */
  private Key getParentKey(com.google.appengine.api.datastore.Key testRunKey) {
    Key testParentKey = Key.create(TestEntity.class, testRunKey.getParent().getName());
    return Key.create(testParentKey, TestRunEntity.class, testRunKey.getId());
  }

  /**
   * Get UrlSafeKey from ApiCoverageEntity Information
   */
  public String getUrlSafeKey() {
    Key uuidKey = Key.create(this.parent, ApiCoverageEntity.class, this.id);
    return uuidKey.toUrlSafe();
  }

  /**
   * Saving function for the instance of this class
   */
  public Key<ApiCoverageEntity> save() {
    this.id = UUID.randomUUID().toString();
    this.updated = new Date();
    return ofy().save().entity(this).now();
  }

  /**
   * Get List of ApiCoverageEntity by HAL interface name
   */
  public static ApiCoverageEntity getByUrlSafeKey(String urlSafeKey) {
    return ofy().load()
        .type(ApiCoverageEntity.class)
        .filterKey(com.google.cloud.datastore.Key.fromUrlSafe(urlSafeKey))
        .first()
        .now();
  }

  /**
   * Get List of ApiCoverageEntity by HAL interface name
   */
  public static List<ApiCoverageEntity> getByInterfaceNameList(String halInterfaceName) {
    return ofy().load()
        .type(ApiCoverageEntity.class)
        .filter("halInterfaceName", halInterfaceName)
        .list();
  }

  /**
   * Get List of ApiCoverageEntity by HAL package name
   */
  public static List<ApiCoverageEntity> getByPackageNameList(String packageName) {
    return ofy().load()
        .type(ApiCoverageEntity.class)
        .filter("halPackageName", packageName)
        .list();
  }
}