Skip to content

fix(compute-samples): fixed flaky firewall rule deletion #6609

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jan 11, 2022
Merged

fix(compute-samples): fixed flaky firewall rule deletion #6609

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a554914
fix(compute-samples): fixed flaky firewall rule deletion
Sita04 Jan 7, 2022
9f0ff2b
fix(compute-samples): fixed flaky firewall rule deletion
Sita04 Jan 7, 2022
dde40b1
fix(compute-samples): fixed NullPointer caused by Sysout set to null
Sita04 Jan 8, 2022
013b73a
docs(compute-samples): included review comments
Sita04 Jan 11, 2022
4ddfc22
docs(compute-samples): included review comments
Sita04 Jan 11, 2022
4710914
docs(compute-samples): lint fix
Sita04 Jan 11, 2022
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
49 changes: 32 additions & 17 deletions compute/cloud-client/src/test/java/compute/SnippetsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ public static void cleanup() throws IOException, InterruptedException, Execution
requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
requireEnvVar("GOOGLE_CLOUD_PROJECT");

deleteFirewallRuleIfNotDeletedByGceEnforcer(PROJECT_ID, FIREWALL_RULE_CREATE);
if (!isFirewallRuleDeletedByGceEnforcer(PROJECT_ID, FIREWALL_RULE_CREATE)) {
DeleteFirewallRule.deleteFirewallRule(PROJECT_ID, FIREWALL_RULE_CREATE);
}
compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME_ENCRYPTED);
compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME);
compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME_LIST_INSTANCE);
Expand Down Expand Up @@ -287,43 +289,56 @@ public static String getBase64EncodedKey() {
.encodeToString(stringBuilder.toString().getBytes(StandardCharsets.US_ASCII));
}

public static void testListFirewallRules() throws IOException {
public static void testListFirewallRules()
throws IOException, ExecutionException, InterruptedException {
final PrintStream out = System.out;
ByteArrayOutputStream stdOut = new ByteArrayOutputStream();
System.setOut(new PrintStream(stdOut));
compute.ListFirewallRules.listFirewallRules(PROJECT_ID);
assertThat(stdOut.toString()).contains(FIREWALL_RULE_CREATE);
if (!isFirewallRuleDeletedByGceEnforcer(PROJECT_ID, FIREWALL_RULE_CREATE)) {
compute.ListFirewallRules.listFirewallRules(PROJECT_ID);
assertThat(stdOut.toString()).contains(FIREWALL_RULE_CREATE);
}
// Clear system output to not affect other tests.
// Refrain from setting out to null.
stdOut.close();
System.setOut(null);
System.setOut(out);
}

public static void testPatchFirewallRule()
throws IOException, InterruptedException, ExecutionException {
try (FirewallsClient client = FirewallsClient.create()) {
ByteArrayOutputStream stdOut = new ByteArrayOutputStream();
System.setOut(new PrintStream(stdOut));
Assert.assertEquals(1000, client.get(PROJECT_ID, FIREWALL_RULE_CREATE).getPriority());
compute.PatchFirewallRule.patchFirewallPriority(PROJECT_ID, FIREWALL_RULE_CREATE, 500);
TimeUnit.SECONDS.sleep(5);
Assert.assertEquals(500, client.get(PROJECT_ID, FIREWALL_RULE_CREATE).getPriority());
stdOut.close();
System.setOut(null);
final PrintStream out = System.out;
ByteArrayOutputStream stdOut = new ByteArrayOutputStream();
Copy link
Contributor

@averikitsch averikitsch Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: a more consistent way would be to execute this in a before or beforeAll method.

Copy link
Contributor Author

@Sita04 Sita04 Jan 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

beforeAll() has the mechanism to clear stdout before every function.

testPatchFirewallRule() needed this as it is called from setUp() directly (to test before GCE Enforcer renders this test invalid).

System.setOut(new PrintStream(stdOut));
if (!isFirewallRuleDeletedByGceEnforcer(PROJECT_ID, FIREWALL_RULE_CREATE)) {
try (FirewallsClient client = FirewallsClient.create()) {
Assert.assertEquals(1000, client.get(PROJECT_ID, FIREWALL_RULE_CREATE).getPriority());
compute.PatchFirewallRule.patchFirewallPriority(PROJECT_ID, FIREWALL_RULE_CREATE, 500);
TimeUnit.SECONDS.sleep(5);
Assert.assertEquals(500, client.get(PROJECT_ID, FIREWALL_RULE_CREATE).getPriority());
}
}
// Clear system output to not affect other tests.
// Refrain from setting out to null as it will throw NullPointer in the subsequent tests.
stdOut.close();
System.setOut(out);
}

public static void deleteFirewallRuleIfNotDeletedByGceEnforcer(String projectId,
public static boolean isFirewallRuleDeletedByGceEnforcer(String projectId,
String firewallRule) throws IOException, ExecutionException, InterruptedException {
/* (**INTERNAL method**)
This method will prevent test failure if the firewall rule was auto-deleted by GCE Enforcer.
(Feel free to remove this method if not running on a Google-owned project.)
*/
try {
GetFirewallRule.getFirewallRule(projectId, firewallRule);
DeleteFirewallRule.deleteFirewallRule(projectId, firewallRule);
} catch (NotFoundException e) {
System.out.println("Rule already deleted ! ");
} catch (InvalidArgumentException e) {
return true;
} catch (InvalidArgumentException | NullPointerException e) {
System.out.println("Rule is not ready (probably being deleted).");
return true;
}
return false;
}

public static String getInstanceStatus(String instanceName) throws IOException {
Expand Down