4793773343

Build Type

github

Committed by GitHub

Commit Message

Merge 1c53df345 into d865fa096

Pull Request Pull Request #1169: Populating secret ownership via join rather than subquery

Run Details

104 of 104 new or added lines in 3 files covered. (100.0%)

5406 of 7198 relevant lines covered (75.1%)

0.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.4

/server/src/main/java/keywhiz/service/daos/GroupDAO.java

/*
 * Copyright (C) 2015 Square, Inc.
 *
 * 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 keywhiz.service.daos;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import java.time.OffsetDateTime;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import javax.inject.Inject;
import keywhiz.api.model.Group;
import keywhiz.jooq.tables.Groups;
import keywhiz.jooq.tables.records.GroupsRecord;
import keywhiz.service.config.Readonly;
import org.jooq.Condition;
import org.jooq.Configuration;
import org.jooq.DSLContext;
import org.jooq.Record;
import org.jooq.Result;
import org.jooq.impl.DSL;

import static com.google.common.base.Preconditions.checkNotNull;
import static keywhiz.jooq.Tables.CLIENTS;
import static keywhiz.jooq.tables.Accessgrants.ACCESSGRANTS;
import static keywhiz.jooq.tables.DeletedSecrets.DELETED_SECRETS;
import static keywhiz.jooq.tables.Groups.GROUPS;
import static keywhiz.jooq.tables.Memberships.MEMBERSHIPS;
import static keywhiz.jooq.tables.Secrets.SECRETS;

public class GroupDAO {
  private static final Long NO_OWNER = null;

  private static final Groups GROUP_OWNERS = GROUPS.as("owners");

  private final DSLContext dslContext;
  private final GroupMapper groupMapper;
  private final ObjectMapper mapper;

  private GroupDAO(DSLContext dslContext, GroupMapper groupMapper, ObjectMapper mapper) {
    this.dslContext = dslContext;
    this.groupMapper = groupMapper;
    this.mapper = mapper;
  }

  public long createGroup(
      String name,
      String creator,
      String description,
      ImmutableMap<String, String> metadata) {
    return createGroup(
        name,
        creator,
        description,
        metadata,
        NO_OWNER);
  }

  public long createGroup(
      String name,
      String creator,
      String description,
      ImmutableMap<String, String> metadata,
      Long ownerId) {
    GroupsRecord r = dslContext.newRecord(GROUPS);

    String jsonMetadata;
    try {
      jsonMetadata = mapper.writeValueAsString(metadata);
    } catch (JsonProcessingException e) {
      // Serialization of a Map<String, String> can never fail.
      throw Throwables.propagate(e);
    }

    long now = OffsetDateTime.now().toEpochSecond();

    r.setName(name);
    r.setCreatedby(creator);
    r.setCreatedat(now);
    r.setUpdatedby(creator);
    r.setUpdatedat(now);
    r.setDescription(description);
    r.setMetadata(jsonMetadata);
    r.setOwner(ownerId);
    r.store();

    return r.getId();
  }

  public void deleteGroup(Group group) {
    dslContext.transaction(configuration -> {
      DSL.using(configuration)
              .delete(GROUPS)
              .where(GROUPS.ID.eq(group.getId()))
              .execute();
      DSL.using(configuration)
              .delete(MEMBERSHIPS)
              .where(MEMBERSHIPS.GROUPID.eq(group.getId()))
              .execute();
      DSL.using(configuration)
              .delete(ACCESSGRANTS)
              .where(ACCESSGRANTS.GROUPID.eq(group.getId()))
              .execute();
      DSL.using(configuration)
          .update(SECRETS)
          .set(SECRETS.OWNER, (Long) null)
          .where(SECRETS.OWNER.eq(group.getId()))
          .execute();
      DSL.using(configuration)
          .update(DELETED_SECRETS)
          .set(DELETED_SECRETS.OWNER, (Long) null)
          .where(DELETED_SECRETS.OWNER.eq(group.getId()))
          .execute();
      DSL.using(configuration)
          .update(GROUPS)
          .set(GROUPS.OWNER, (Long) null)
          .where(GROUPS.OWNER.eq(group.getId()))
          .execute();
      DSL.using(configuration)
          .update(CLIENTS)
          .set(CLIENTS.OWNER, (Long) null)
          .where(CLIENTS.OWNER.eq(group.getId()))
          .execute();
    });
  }

  public Optional<Group> getGroup(String name) {
    return getGroup(GROUPS.NAME.eq(name));
  }

  public Optional<Group> getGroupById(long id) {
    return getGroup(GROUPS.ID.eq(id));
  }

  private Optional<Group> getGroup(Condition condition) {
    Record record = dslContext
        .select(GROUPS.fields())
        .select(GROUP_OWNERS.ID, GROUP_OWNERS.NAME)
        .from(GROUPS)
        .leftJoin(GROUP_OWNERS)
        .on(GROUPS.OWNER.eq(GROUP_OWNERS.ID))
        .where(condition)
        .fetchOne();

    return Optional.ofNullable(recordToGroup(record));
  }

  private Group recordToGroup(Record record) {
    if (record == null) {
      return null;
    }

    GroupsRecord groupRecord = record.into(GROUPS);
    GroupsRecord ownerRecord = record.into(GROUP_OWNERS);

    boolean danglingOwner = groupRecord.getOwner() != null && ownerRecord.getId() == null;
    if (danglingOwner) {
      throw new IllegalStateException(
          String.format(
              "Owner %s for group %s is missing.",
              groupRecord.getOwner(),
              groupRecord.getName()));
    }

    Group group = groupMapper.map(groupRecord);
    if (ownerRecord != null) {
      group.setOwner(ownerRecord.getName());
    }

    return group;
  }

  public ImmutableSet<Group> getGroups() {
    Result<Record> results = dslContext
        .select(GROUPS.fields())
        .select(GROUP_OWNERS.NAME)
        .from(GROUPS)
        .leftJoin(GROUP_OWNERS)
        .on(GROUPS.OWNER.eq(GROUP_OWNERS.ID))
        .fetch();

    Set<Group> groups = results.stream()
        .map(this::recordToGroup)
        .collect(Collectors.toSet());

    return ImmutableSet.copyOf(groups);
  }

  public static class GroupDAOFactory implements DAOFactory<GroupDAO> {
    private final DSLContext jooq;
    private final DSLContext readonlyJooq;
    private final GroupMapper groupMapper;
    private final ObjectMapper mapper;

    @Inject public GroupDAOFactory(DSLContext jooq, @Readonly DSLContext readonlyJooq,
        GroupMapper groupMapper, ObjectMapper mapper) {
      this.jooq = jooq;
      this.readonlyJooq = readonlyJooq;
      this.groupMapper = groupMapper;
      this.mapper = mapper;
    }

    @Override public GroupDAO readwrite() {
      return new GroupDAO(jooq, groupMapper, mapper);
    }

    @Override public GroupDAO readonly() {
      return new GroupDAO(readonlyJooq, groupMapper, mapper);
    }

    @Override public GroupDAO using(Configuration configuration) {
      DSLContext dslContext = DSL.using(checkNotNull(configuration));
      return new GroupDAO(dslContext, groupMapper, mapper);
    }

    public GroupDAO using(DSLContext dslContext) {
      return new GroupDAO(dslContext, groupMapper, mapper);
    }
  }
}

1	/*
2	* Copyright (C) 2015 Square, Inc.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package keywhiz.service.daos;
18
19	import com.fasterxml.jackson.core.JsonProcessingException;
20	import com.fasterxml.jackson.databind.ObjectMapper;
21	import com.google.common.base.Throwables;
22	import com.google.common.collect.ImmutableMap;
23	import com.google.common.collect.ImmutableSet;
24	import java.time.OffsetDateTime;
25	import java.util.Optional;
26	import java.util.Set;
27	import java.util.stream.Collectors;
28	import javax.inject.Inject;
29	import keywhiz.api.model.Group;
30	import keywhiz.jooq.tables.Groups;
31	import keywhiz.jooq.tables.records.GroupsRecord;
32	import keywhiz.service.config.Readonly;
33	import org.jooq.Condition;
34	import org.jooq.Configuration;
35	import org.jooq.DSLContext;
36	import org.jooq.Record;
37	import org.jooq.Result;
38	import org.jooq.impl.DSL;
39
40	import static com.google.common.base.Preconditions.checkNotNull;
41	import static keywhiz.jooq.Tables.CLIENTS;
42	import static keywhiz.jooq.tables.Accessgrants.ACCESSGRANTS;
43	import static keywhiz.jooq.tables.DeletedSecrets.DELETED_SECRETS;
44	import static keywhiz.jooq.tables.Groups.GROUPS;
45	import static keywhiz.jooq.tables.Memberships.MEMBERSHIPS;
46	import static keywhiz.jooq.tables.Secrets.SECRETS;
47
48	public class GroupDAO {
49	private static final Long NO_OWNER = null;	1✔
50
51	private static final Groups GROUP_OWNERS = GROUPS.as("owners");	1✔
52
53	private final DSLContext dslContext;
54	private final GroupMapper groupMapper;
55	private final ObjectMapper mapper;
56
57	private GroupDAO(DSLContext dslContext, GroupMapper groupMapper, ObjectMapper mapper) {	1✔
58	this.dslContext = dslContext;	1✔
59	this.groupMapper = groupMapper;	1✔
60	this.mapper = mapper;	1✔
61	}	1✔
62
63	public long createGroup(
64	String name,
65	String creator,
66	String description,
67	ImmutableMap<String, String> metadata) {
68	return createGroup(	1✔
69	name,
70	creator,
71	description,
72	metadata,
73	NO_OWNER);
74	}
75
76	public long createGroup(
77	String name,
78	String creator,
79	String description,
80	ImmutableMap<String, String> metadata,
81	Long ownerId) {
82	GroupsRecord r = dslContext.newRecord(GROUPS);	1✔
83
84	String jsonMetadata;
85	try {
86	jsonMetadata = mapper.writeValueAsString(metadata);	1✔
87	} catch (JsonProcessingException e) {	×
88	// Serialization of a Map<String, String> can never fail.
89	throw Throwables.propagate(e);	×
90	}	1✔
91
92	long now = OffsetDateTime.now().toEpochSecond();	1✔
93
94	r.setName(name);	1✔
95	r.setCreatedby(creator);	1✔
96	r.setCreatedat(now);	1✔
97	r.setUpdatedby(creator);	1✔
98	r.setUpdatedat(now);	1✔
99	r.setDescription(description);	1✔
100	r.setMetadata(jsonMetadata);	1✔
101	r.setOwner(ownerId);	1✔
102	r.store();	1✔
103
104	return r.getId();	1✔
105	}
106
107	public void deleteGroup(Group group) {
108	dslContext.transaction(configuration -> {	1✔
109	DSL.using(configuration)	1✔
110	.delete(GROUPS)	1✔
111	.where(GROUPS.ID.eq(group.getId()))	1✔
112	.execute();	1✔
113	DSL.using(configuration)	1✔
114	.delete(MEMBERSHIPS)	1✔
115	.where(MEMBERSHIPS.GROUPID.eq(group.getId()))	1✔
116	.execute();	1✔
117	DSL.using(configuration)	1✔
118	.delete(ACCESSGRANTS)	1✔
119	.where(ACCESSGRANTS.GROUPID.eq(group.getId()))	1✔
120	.execute();	1✔
121	DSL.using(configuration)	1✔
122	.update(SECRETS)	1✔
123	.set(SECRETS.OWNER, (Long) null)	1✔
124	.where(SECRETS.OWNER.eq(group.getId()))	1✔
125	.execute();	1✔
126	DSL.using(configuration)	1✔
127	.update(DELETED_SECRETS)	1✔
128	.set(DELETED_SECRETS.OWNER, (Long) null)	1✔
129	.where(DELETED_SECRETS.OWNER.eq(group.getId()))	1✔
130	.execute();	1✔
131	DSL.using(configuration)	1✔
132	.update(GROUPS)	1✔
133	.set(GROUPS.OWNER, (Long) null)	1✔
134	.where(GROUPS.OWNER.eq(group.getId()))	1✔
135	.execute();	1✔
136	DSL.using(configuration)	1✔
137	.update(CLIENTS)	1✔
138	.set(CLIENTS.OWNER, (Long) null)	1✔
139	.where(CLIENTS.OWNER.eq(group.getId()))	1✔
140	.execute();	1✔
141	});	1✔
142	}	1✔
143
144	public Optional<Group> getGroup(String name) {
145	return getGroup(GROUPS.NAME.eq(name));	1✔
146	}
147
148	public Optional<Group> getGroupById(long id) {
149	return getGroup(GROUPS.ID.eq(id));	1✔
150	}
151
152	private Optional<Group> getGroup(Condition condition) {
153	Record record = dslContext	1✔
154	.select(GROUPS.fields())	1✔
155	.select(GROUP_OWNERS.ID, GROUP_OWNERS.NAME)	1✔
156	.from(GROUPS)	1✔
157	.leftJoin(GROUP_OWNERS)	1✔
158	.on(GROUPS.OWNER.eq(GROUP_OWNERS.ID))	1✔
159	.where(condition)	1✔
160	.fetchOne();	1✔
161
162	return Optional.ofNullable(recordToGroup(record));	1✔
163	}
164
165	private Group recordToGroup(Record record) {
166	if (record == null) {	1✔
167	return null;	1✔
168	}
169
170	GroupsRecord groupRecord = record.into(GROUPS);	1✔
171	GroupsRecord ownerRecord = record.into(GROUP_OWNERS);	1✔
172
173	boolean danglingOwner = groupRecord.getOwner() != null && ownerRecord.getId() == null;	1✔
174	if (danglingOwner) {	1✔
175	throw new IllegalStateException(	×
176	String.format(	×
177	"Owner %s for group %s is missing.",
178	groupRecord.getOwner(),	×
179	groupRecord.getName()));	×
180	}
181
182	Group group = groupMapper.map(groupRecord);	1✔
183	if (ownerRecord != null) {	1✔
184	group.setOwner(ownerRecord.getName());	1✔
185	}
186
187	return group;	1✔
188	}
189
190	public ImmutableSet<Group> getGroups() {
191	Result<Record> results = dslContext	1✔
192	.select(GROUPS.fields())	1✔
193	.select(GROUP_OWNERS.NAME)	1✔
194	.from(GROUPS)	1✔
195	.leftJoin(GROUP_OWNERS)	1✔
196	.on(GROUPS.OWNER.eq(GROUP_OWNERS.ID))	1✔
197	.fetch();	1✔
198
199	Set<Group> groups = results.stream()	1✔
200	.map(this::recordToGroup)	1✔
201	.collect(Collectors.toSet());	1✔
202
203	return ImmutableSet.copyOf(groups);	1✔
204	}
205
206	public static class GroupDAOFactory implements DAOFactory<GroupDAO> {
207	private final DSLContext jooq;
208	private final DSLContext readonlyJooq;
209	private final GroupMapper groupMapper;
210	private final ObjectMapper mapper;
211
212	@Inject public GroupDAOFactory(DSLContext jooq, @Readonly DSLContext readonlyJooq,
213	GroupMapper groupMapper, ObjectMapper mapper) {	1✔
214	this.jooq = jooq;	1✔
215	this.readonlyJooq = readonlyJooq;	1✔
216	this.groupMapper = groupMapper;	1✔
217	this.mapper = mapper;	1✔
218	}	1✔
219
220	@Override public GroupDAO readwrite() {
221	return new GroupDAO(jooq, groupMapper, mapper);	1✔
222	}
223
224	@Override public GroupDAO readonly() {
225	return new GroupDAO(readonlyJooq, groupMapper, mapper);	1✔
226	}
227
228	@Override public GroupDAO using(Configuration configuration) {
229	DSLContext dslContext = DSL.using(checkNotNull(configuration));	1✔
230	return new GroupDAO(dslContext, groupMapper, mapper);	1✔
231	}
232
233	public GroupDAO using(DSLContext dslContext) {
234	return new GroupDAO(dslContext, groupMapper, mapper);	×
235	}
236	}
237	}

square / keywhiz / 4793773343

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous