gCubeSystem
/
event-publisher-hook
16
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added `AlignGatewaysUsers` and `SendContextUsersRoles` (#23628) utility functions.

This commit is contained in:
Mauro Mugnaini 2022-07-07 16:51:27 +02:00
parent 8a2a31c0f4
commit 193b4cab24
5 changed files with 275 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -2,6 +2,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
# Changelog for "event-publisher-portal"
## [v1.2.0-SNAPSHOT]
Added `AlignGatewaysUsers` and `SendContextUsersRoles` (#23628) utility functions.
## [v1.1.1]
`UserGroupRoleEventPublisher` don't send events if the group is not enabled (#21925)

4
pom.xml
View File

@ -13,7 +13,7 @@
<groupId>org.gcube.portal</groupId>
<artifactId>event-publisher-hook</artifactId>
<version>1.1.1</version>
<version>1.2.0-SNAPSHOT</version>
<packaging>war</packaging>
<properties>
@ -36,7 +36,7 @@
<dependency>
<groupId>org.gcube.distribution</groupId>
<artifactId>maven-portal-bom</artifactId>
<version>3.6.3</version>
<version>3.6.4</version>
<type>pom</type>
<scope>import</scope>
</dependency>

126
src/test/java/org/gcube/portal/event/publisher/utils/AlignGatewaysUsers.java Normal file
View File

@ -0,0 +1,126 @@
package org.gcube.portal.event.publisher.utils;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URLEncoder;
import org.gcube.event.publisher.BufferedEventProcessor;
import org.gcube.event.publisher.Event;
import org.gcube.event.publisher.EventProcessorException;
import org.gcube.portal.event.publisher.lr62.model.UserEvent;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Usage: <code>AlignGatewaysUsers &lt;conductor-endpoint> &lt;client-id> &lt;client-secret> &lt;keycloak-token-endpoint> &lt;json-export-resource> [&lt;gw-suffix>]</code><br>
*
*
* The JSON input file is structured as "gateway and users" array, with users that belong to the gateway in an array.
* Refer to the example below for further details.
*
* <pre>
* [
* {
* "gateway": "ATest Gateway",
* "users": [
* "gino.chino"
* ]
* },
* {
* "gateway": "A gCube Snapshot Gateway",
* "users": [
* "pino.lino",
* "gino.stilla",
* "cvcvcvcvcv"
* ]
* },
* [...]
* ]
* </pre>
*
* @author Mauro Mugnaini
*
*/
public class AlignGatewaysUsers {
private static final Logger logger = LoggerFactory.getLogger(AlignGatewaysUsers.class);
private static final String SENDER_ID = "gw2users-align";
private static final String GW_SUFFIX = "+Gateway";
@SuppressWarnings("unchecked")
public AlignGatewaysUsers(String conductorEndpoint, String clientId, String clientSecret,
String keycloakTokenEndpoint, String jsonExportResource, String gateway2export)
throws IOException, ParseException, InterruptedException {
BufferedEventProcessor processor = null;
try {
processor = new BufferedEventProcessor(conductorEndpoint, clientId,
clientSecret, keycloakTokenEndpoint, tobeSent -> {
String user = (String) tobeSent.get(UserEvent.USER_ENTRY);
String group = (String) tobeSent.get(UserEvent.GROUP_ENTRY);
return user + "@" + group;
});
} catch (EventProcessorException e) {
logger.error("Cannot create processor object. Exiting...", e);
System.exit(1);
}
JSONArray export = (JSONArray) new JSONParser().parse(
new InputStreamReader(this.getClass().getClassLoader().getResourceAsStream(jsonExportResource)));
long start = System.currentTimeMillis();
for (int i = 0; i < export.size(); i++) {
JSONObject entry = (JSONObject) export.get(i);
String gateway = URLEncoder.encode((String) entry.get("gateway"), "UTF-8");
if (gateway2export != null && !gateway.equals(gateway2export)) {
continue;
} else {
logger.info("- Processing gateway: {}", gateway);
}
JSONArray usersArray = (JSONArray) entry.get("users");
for (int j = 0; j < usersArray.size(); j++) {
String user = (String) usersArray.get(j);
// Group object is too difficult to implement as fake because is mapped via GroupManager
// This is the workaround by using event base class directly:
Event event = new Event(UserEvent.UG_CREATED_NAME, "manual", SENDER_ID);
event.put(UserEvent.USER_ENTRY, user);
event.put(UserEvent.GROUP_ENTRY, gateway);
logger.debug(" * Offering: {}", user);
processor.enqueueEvent(event);
}
}
do {
Thread.sleep(1000);
} while (processor.allQueuedFinishedCorrectly());
long elapsed = System.currentTimeMillis() - start;
logger.info("\t\t\tFinished! Handled {} events in {} ms", processor.getCount(), elapsed);
logger.info("\t\t\tErrors: {} - Stats per event: min: {} ms - max: {} ms.",
new Object[] { processor.getErrors(), processor.getMin(), processor.getMax() });
System.exit(0);
}
public static void main(String[] args) throws IOException, ParseException, InterruptedException {
if (args.length < 5) {
System.err.println(
"Not all arguments where provided.\nUsage: AlignGatewaysUsers <conductor-endpoint> <client-id> <client-secret> <keycloak-token-endpoint> <json-export-resource> [<gw-suffix>]");
System.exit(1);
}
String conductorEndpoint = args[0];
String clientId = args[1];
String clientSecret = args[2];
String keycloakTokenEndpoint = args[3];
String jsonExportResource = args[4];
new AlignGatewaysUsers(conductorEndpoint, clientId, clientSecret, keycloakTokenEndpoint, jsonExportResource,
args.length == 6 ? args[5] + GW_SUFFIX : null);
}
}

121
src/test/java/org/gcube/portal/event/publisher/utils/SendContextUsersRoles.java Normal file
View File

@ -0,0 +1,121 @@
package org.gcube.portal.event.publisher.utils;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URLEncoder;
import org.gcube.event.publisher.BufferedEventProcessor;
import org.gcube.event.publisher.Event;
import org.gcube.event.publisher.EventProcessorException;
import org.gcube.portal.event.publisher.lr62.model.UserGroupRoleEvent;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Usage: <code>SendContextUsersRoles &lt;conductor-endpoint> &lt;client-id> &lt;client-secret> &lt;keycloak-token-endpoint> &lt;role> &lt;json-export-resource></code>.<br>
*
*
* The JSON input file is structured as "context to users" entries, with context as key and users array as value. The role is passed as argument.
* Refer to the example below for further details.
*
* <pre>
* {
* "/root/VO1/VRE1": ["gino.chino"],
* "/root/VO1/VRE2": ["lino.mando"],
* "/root/VO2/VRE3": ["nella.baci", "gino.stilla", "rino.manda"],
* "/root/VO3/VRE4": ["lorian.manda"],
* [...]
* }
* </pre>
*
* @author Mauro Mugnaini
*
*/
public class SendContextUsersRoles {
private static final Logger logger = LoggerFactory.getLogger(BufferedEventProcessor.class);
private static final Boolean DRY_RUN = Boolean.FALSE;
private static final String SENDER_ID_PREFIX = "re-align-role_";
@SuppressWarnings("unchecked")
public SendContextUsersRoles(String conductorEndpoint, String clientId, String clientSecret,
String keycloakTokenEndpoint, String role, String jsonExportResource)
throws IOException, ParseException, InterruptedException {
BufferedEventProcessor processor = null;
try {
processor = new BufferedEventProcessor(conductorEndpoint, clientId,
clientSecret, keycloakTokenEndpoint, tobeSent -> {
String user = (String) tobeSent.get(UserGroupRoleEvent.USER_ENTRY);
String group = (String) tobeSent.get(UserGroupRoleEvent.GROUP_ENTRY);
return user + "@" + group + ":" + role;
});
} catch (EventProcessorException e) {
logger.error("Cannot create processor object. Exiting...", e);
System.exit(1);
}
JSONObject export = (JSONObject) new JSONParser().parse(
new InputStreamReader(this.getClass().getClassLoader().getResourceAsStream(jsonExportResource)));
long start = System.currentTimeMillis();
String sender = SENDER_ID_PREFIX + role.toLowerCase();
int howMany = 0;
for (Object contextObject : export.keySet()) {
String context = contextObject.toString();
String encodedContext = URLEncoder.encode(context, "UTF-8");
JSONArray usersArray = (JSONArray) export.get(context);
for (int j = 0; j < usersArray.size(); j++) {
String user = (String) usersArray.get(j);
// Since Group object is too difficult to implement as a dummy because is mapped via GroupManager,
// this is the workaround by using base event class directly:
Event event = new Event(UserGroupRoleEvent.CREATED_NAME, "manual", sender);
event.put(UserGroupRoleEvent.USER_ENTRY, user);
event.put(UserGroupRoleEvent.GROUP_ENTRY, encodedContext);
event.put(UserGroupRoleEvent.ROLE_ENTRY, role);
logger.info(" * Offering: {}", user);
if (!DRY_RUN) {
processor.enqueueEvent(event);
} else {
logger.debug("Next event: {}", event);
}
howMany += 1;
}
}
logger.info("Events are {}", howMany);
do {
Thread.sleep(1000);
} while (processor.allQueuedFinishedCorrectly());
long elapsed = System.currentTimeMillis() - start;
logger.info("\t\t\tFinished! Handled {} events in {} ms", processor.getCount(), elapsed);
logger.info("\t\t\tErrors: {} - Stats per event: min: {} ms - max: {} ms.",
new Object[] { processor.getErrors(), processor.getMin(), processor.getMax() });
System.exit(0);
}
public static void main(String[] args) throws IOException, ParseException, InterruptedException {
if (args.length < 6) {
System.err.println(
"Not all arguments where provided.\nUsage: SendContextUsersRoles <conductor-endpoint> <client-id> <client-secret> <keycloak-token-endpoint> <role> <json-export-resource>");
System.exit(1);
}
String conductorEndpoint = args[0];
String clientId = args[1];
String clientSecret = args[2];
String keycloakTokenEndpoint = args[3];
String role = args[4];
String jsonExportResource = args[5];
new SendContextUsersRoles(conductorEndpoint, clientId, clientSecret, keycloakTokenEndpoint, role,
jsonExportResource);
}
}

23
src/test/resources/log4j.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration
xmlns="http://jakarta.apache.org/log4j/"
xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="console"
class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
</layout>
</appender>
<logger name="org.gcube" additivity="false">
<level value="INFO" />
<appender-ref ref="console" />
</logger>
<root>
<level value="INFO" />
<appender-ref ref="console" />
</root>
</log4j:configuration>