Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extend the project name format to include by default the separator, this is useful to narrow down optimized acls to be more secure #515

Merged
merged 1 commit into from
Aug 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,10 @@ private String patternBasedProjectPrefix() {

private String namePrefix(String topologyPrefix) {
StringBuilder sb = new StringBuilder();
sb.append(topologyPrefix).append(config.getTopicPrefixSeparator()).append(name);
sb.append(topologyPrefix)
.append(config.getTopicPrefixSeparator())
.append(name)
.append(config.getTopicPrefixSeparator());
return sb.toString();
}

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/purbon/kafka/topology/model/Topic.java
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ private String patternBasedTopicNameStructureString() {
private String defaultTopicStructureString(String projectPrefix) {
StringBuilder sb = new StringBuilder();
if (projectPrefix != null && !projectPrefix.isBlank()) {
sb.append(projectPrefix).append(appConfig.getTopicPrefixSeparator());
sb.append(projectPrefix);
}
sb.append(getName());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ public class MinInSyncReplicasValidation implements TopicValidation {

@Override
public void valid(Topic topic) throws ValidationException {
if (topic.replicationFactor().isPresent()
&& !validateMinInsyncReplicas(topic)) {
if (topic.replicationFactor().isPresent() && !validateMinInsyncReplicas(topic)) {
String msg =
String.format(
"Topic %s has an unexpected min.insync.replicas config vs it's replication factor: %s value",
Expand All @@ -21,9 +20,9 @@ public void valid(Topic topic) throws ValidationException {
}

private boolean validateMinInsyncReplicas(Topic topic) {
short replicationFactor = topic.replicationFactor().orElse((short)-1);
short replicationFactor = topic.replicationFactor().orElse((short) -1);
String minInSyncReplicas = topic.getConfig().get(MIN_INSYNC_REPLICAS);
return minInSyncReplicas == null || (Integer.parseInt(minInSyncReplicas) <= replicationFactor - 1);
return minInSyncReplicas == null
|| (Integer.parseInt(minInSyncReplicas) <= replicationFactor - 1);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public void newConsumerOptimisedACLsCreation() throws IOException {
.buildBindingsForConsumers(users, builder.getProject().namePrefix(), true);
accessControlManager.updatePlan(builder.buildTopology(), plan);
verify(aclsBuilder, times(1))
.buildBindingsForConsumers(eq(users), eq(builder.getProject().namePrefix()), eq(true));
.buildBindingsForConsumers(eq(users), eq("ctx.project."), eq(true));
}

@Test
Expand Down Expand Up @@ -177,7 +177,7 @@ public void newProducerOptimizedACLsCreation() throws IOException {
.buildBindingsForProducers(producers, builder.getProject().namePrefix(), true);
accessControlManager.updatePlan(builder.buildTopology(), plan);
verify(aclsBuilder, times(1))
.buildBindingsForProducers(eq(producers), eq(builder.getProject().namePrefix()), eq(true));
.buildBindingsForProducers(eq(producers), eq("ctx.project."), eq(true));
}

@Test
Expand Down Expand Up @@ -273,7 +273,7 @@ public void newKSqlApplicationCreation() throws IOException {
.when(aclsBuilder)
.buildBindingsForKSqlApp(any(KSqlApp.class), anyString());

verify(aclsBuilder, times(1)).buildBindingsForKSqlApp(app, "default.default");
verify(aclsBuilder, times(1)).buildBindingsForKSqlApp(app, "default.default.");
}

@Test(expected = IOException.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ public void shouldAddStreamsProjectPrefixAsInternalTopics() {
var topology = TestTopologyBuilder.createProject().addKStream("foo").buildTopology();

var internals = config.getKafkaInternalTopicPrefixes(Collections.singletonList(topology));
assertThat(internals).contains("ctx.project");
assertThat(internals).contains("ctx.project.");
assertThat(internals).contains("_");
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ public void buildOutOfMultipleTopos() throws IOException {

var projects =
Arrays.asList(
"context2.source2.foo.bar.projectFoo",
"context2.source2.foo.bar.projectBar",
"context2.source2.foo.bar.projectZet",
"context2.source2.foo.bar.projectBear");
"context2.source2.foo.bar.projectFoo.",
"context2.source2.foo.bar.projectBar.",
"context2.source2.foo.bar.projectZet.",
"context2.source2.foo.bar.projectBear.");
assertThat(context.getProjects()).hasSize(4);
for (Project proj : context.getProjects()) {
assertThat(projects).contains(proj.namePrefix());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public void testDynamicFirstLevelAttributes() {
Topology anotherTopology = parser.deserialise(TestUtils.getResourceFile("/descriptor.yaml"));
Project anotherProject = anotherTopology.getProjects().get(0);

assertEquals("contextOrg.source.foo", anotherProject.namePrefix());
assertEquals("contextOrg.source.foo.", anotherProject.namePrefix());
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.purbon.kafka.topology.TestTopologyBuilder;
import com.purbon.kafka.topology.api.adminclient.TopologyBuilderAdminClient;
import com.purbon.kafka.topology.model.Topic;
import com.purbon.kafka.topology.model.Topology;
import java.util.Collections;
import org.junit.Rule;
import org.junit.Test;
Expand All @@ -19,17 +21,22 @@ public class CreateTopicActionTest {

@Test
public void shouldComposeDetailedViewOfProperties() {
Topic topic = new Topic("foo");
topic.setProjectPrefix("bar");
topic.setConfig(Collections.singletonMap("foo", "bar"));
Topic t = new Topic("foo");
t.setConfig(Collections.singletonMap("foo", "bar"));

TestTopologyBuilder builder = TestTopologyBuilder.createProject().addTopic(t);

Topology topology = builder.buildTopology();
var topic = topology.getProjects().get(0).getTopics().get(0);

var action = new CreateTopicAction(adminClient, topic, topic.toString());
var refs = action.refs();
assertThat(refs).hasSize(1);
var ref = refs.get(0);
assertThat(ref)
.contains(
"\"resource_name\" : \"rn://create.topic/com.purbon.kafka.topology.actions.topics.CreateTopicAction/bar.foo\"");
"\"resource_name\" : \"rn://create.topic/com.purbon.kafka.topology.actions.topics.CreateTopicAction/ctx.project.foo\"");
assertThat(ref).contains("\"foo\" : \"bar\"");
assertThat(ref).contains("\"topic\" : \"bar.foo\",");
assertThat(ref).contains("\"topic\" : \"ctx.project.foo\",");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.purbon.kafka.topology.TestTopologyBuilder;
import com.purbon.kafka.topology.api.adminclient.TopologyBuilderAdminClient;
import com.purbon.kafka.topology.model.Topic;
import com.purbon.kafka.topology.model.Topology;
import java.util.Collections;
import org.junit.Rule;
import org.junit.Test;
Expand All @@ -19,17 +21,22 @@ public class DeleteTopicsActionTest {

@Test
public void shouldComposeDetailedViewOfProperties() {
Topic topic = new Topic("foo");
topic.setProjectPrefix("bar");
topic.setConfig(Collections.singletonMap("foo", "bar"));
Topic t = new Topic("foo");
t.setConfig(Collections.singletonMap("foo", "bar"));

TestTopologyBuilder builder = TestTopologyBuilder.createProject().addTopic(t);

Topology topology = builder.buildTopology();
var topic = topology.getProjects().get(0).getTopics().get(0);

var action = new DeleteTopics(adminClient, Collections.singletonList(topic.toString()));

var refs = action.refs();
assertThat(refs).hasSize(1);
var ref = refs.get(0);
assertThat(ref)
.contains(
"\"resource_name\" : \"rn://delete.topic/com.purbon.kafka.topology.actions.topics.DeleteTopics$1/bar.foo\"");
assertThat(ref).contains("\"topic\" : \"bar.foo\",");
"\"resource_name\" : \"rn://delete.topic/com.purbon.kafka.topology.actions.topics.DeleteTopics$1/ctx.project.foo\"");
assertThat(ref).contains("\"topic\" : \"ctx.project.foo\",");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,54 @@
import com.purbon.kafka.topology.exceptions.ConfigurationException;
import com.purbon.kafka.topology.exceptions.ValidationException;
import com.purbon.kafka.topology.model.Topic;
import org.junit.Test;

import java.util.HashMap;
import java.util.Map;
import org.junit.Test;

public class MinInSyncReplicasValidationTest {

@Test(expected = ValidationException.class)
public void shouldCheckKoValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "3");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckMinimalValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "1");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckOkValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "2");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckMissingMinInSyncValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}
@Test(expected = ValidationException.class)
public void shouldCheckKoValuesSuccessfully() throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "3");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckMinimalValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "1");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckOkValuesSuccessfully() throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");
config.put("min.insync.replicas", "2");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}

@Test
public void shouldCheckMissingMinInSyncValuesSuccessfully()
throws ValidationException, ConfigurationException {
Map<String, String> config = new HashMap<>();
config.put("replication.factor", "3");

Topic topic = new Topic("topic", config);
MinInSyncReplicasValidation validation = new MinInSyncReplicasValidation();
validation.valid(topic);
}
}