[ONOS-3634] Enhance app to have a category, icon, URL and readme
This commmit enhances application to have category, icon, URL and
readme. The web GUI and CLI will be implemented in separate commits
Change-Id: Ib02716d7118cc617b24f196f2213ea1fe99a34be
diff --git a/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java b/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java
index e8ff9ec..1528f35 100644
--- a/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java
+++ b/core/api/src/main/java/org/onosproject/app/ApplicationDescription.java
@@ -44,6 +44,13 @@
Version version();
/**
+ * Returns the name of the application origin, group or company.
+ *
+ * @return application origin
+ */
+ String origin();
+
+ /**
* Returns description of the application.
*
* @return application description text
@@ -51,11 +58,32 @@
String description();
/**
- * Returns the name of the application origin, group or company.
+ * Returns category of the application.
*
- * @return application origin
+ * @return application category text
*/
- String origin();
+ String category();
+
+ /**
+ * Returns url of the application.
+ *
+ * @return application url
+ */
+ String url();
+
+ /**
+ * Returns readme of the application.
+ *
+ * @return application readme
+ */
+ String readme();
+
+ /**
+ * Returns icon of the application.
+ *
+ * @return application icon
+ */
+ byte[] icon();
/**
* Returns the role of the application.
diff --git a/core/api/src/main/java/org/onosproject/app/DefaultApplicationDescription.java b/core/api/src/main/java/org/onosproject/app/DefaultApplicationDescription.java
index 569183a..3e52001 100644
--- a/core/api/src/main/java/org/onosproject/app/DefaultApplicationDescription.java
+++ b/core/api/src/main/java/org/onosproject/app/DefaultApplicationDescription.java
@@ -37,6 +37,10 @@
private final Version version;
private final String description;
private final String origin;
+ private final String category;
+ private final String url;
+ private final String readme;
+ private final byte[] icon;
private final ApplicationRole role;
private final Set<Permission> permissions;
private final Optional<URI> featuresRepo;
@@ -50,6 +54,10 @@
* @param version application version
* @param description application description
* @param origin origin company
+ * @param category application category
+ * @param url application URL
+ * @param readme application readme
+ * @param icon application icon
* @param role application role
* @param permissions requested permissions
* @param featuresRepo optional features repo URI
@@ -57,7 +65,8 @@
* @param requiredApps list of required application names
*/
public DefaultApplicationDescription(String name, Version version,
- String description, String origin,
+ String description, String origin, String category,
+ String url, String readme, byte[] icon,
ApplicationRole role, Set<Permission> permissions,
URI featuresRepo, List<String> features,
List<String> requiredApps) {
@@ -65,6 +74,10 @@
this.version = checkNotNull(version, "Version cannot be null");
this.description = checkNotNull(description, "Description cannot be null");
this.origin = checkNotNull(origin, "Origin cannot be null");
+ this.category = checkNotNull(category, "Category cannot be null");
+ this.url = checkNotNull(url, "URL cannot be null");
+ this.readme = readme;
+ this.icon = icon;
this.role = checkNotNull(role, "Role cannot be null");
this.permissions = checkNotNull(permissions, "Permissions cannot be null");
this.featuresRepo = Optional.ofNullable(featuresRepo);
@@ -89,6 +102,26 @@
}
@Override
+ public String category() {
+ return category;
+ }
+
+ @Override
+ public String url() {
+ return url;
+ }
+
+ @Override
+ public String readme() {
+ return readme;
+ }
+
+ @Override
+ public byte[] icon() {
+ return icon;
+ }
+
+ @Override
public String origin() {
return origin;
}
@@ -125,6 +158,9 @@
.add("version", version)
.add("description", description)
.add("origin", origin)
+ .add("category", category)
+ .add("url", url)
+ .add("readme", readme)
.add("role", role)
.add("permissions", permissions)
.add("featuresRepo", featuresRepo)
diff --git a/core/api/src/main/java/org/onosproject/core/Application.java b/core/api/src/main/java/org/onosproject/core/Application.java
index ea2eab9..8700cad 100644
--- a/core/api/src/main/java/org/onosproject/core/Application.java
+++ b/core/api/src/main/java/org/onosproject/core/Application.java
@@ -49,6 +49,34 @@
String description();
/**
+ * Returns category of the application.
+ *
+ * @return application category text
+ */
+ String category();
+
+ /**
+ * Returns url of the application.
+ *
+ * @return application url
+ */
+ String url();
+
+ /**
+ * Returns readme of the application.
+ *
+ * @return application readme
+ */
+ String readme();
+
+ /**
+ * Returns icon of the application.
+ *
+ * @return application icon
+ */
+ byte[] icon();
+
+ /**
* Returns the name of the application origin, group or company.
*
* @return application origin
diff --git a/core/api/src/main/java/org/onosproject/core/DefaultApplication.java b/core/api/src/main/java/org/onosproject/core/DefaultApplication.java
index c351563..8d63600 100644
--- a/core/api/src/main/java/org/onosproject/core/DefaultApplication.java
+++ b/core/api/src/main/java/org/onosproject/core/DefaultApplication.java
@@ -35,6 +35,10 @@
private final ApplicationId appId;
private final Version version;
private final String description;
+ private final String category;
+ private final String url;
+ private final String readme;
+ private final byte[] icon;
private final String origin;
private final ApplicationRole role;
private final Set<Permission> permissions;
@@ -49,6 +53,10 @@
* @param version application version
* @param description application description
* @param origin origin company
+ * @param category application category
+ * @param url application URL
+ * @param readme application readme
+ * @param icon application icon
* @param role application role
* @param permissions requested permissions
* @param featuresRepo optional features repo URI
@@ -56,7 +64,8 @@
* @param requiredApps list of required application names
*/
public DefaultApplication(ApplicationId appId, Version version,
- String description, String origin,
+ String description, String origin, String category,
+ String url, String readme, byte[] icon,
ApplicationRole role, Set<Permission> permissions,
Optional<URI> featuresRepo, List<String> features,
List<String> requiredApps) {
@@ -64,6 +73,10 @@
this.version = checkNotNull(version, "Version cannot be null");
this.description = checkNotNull(description, "Description cannot be null");
this.origin = checkNotNull(origin, "Origin cannot be null");
+ this.category = checkNotNull(category, "Category cannot be null");
+ this.url = checkNotNull(url, "URL cannot be null");
+ this.readme = readme;
+ this.icon = icon;
this.role = checkNotNull(role, "Role cannot be null");
this.permissions = checkNotNull(permissions, "Permissions cannot be null");
this.featuresRepo = checkNotNull(featuresRepo, "Features repo cannot be null");
@@ -88,6 +101,26 @@
}
@Override
+ public String category() {
+ return category;
+ }
+
+ @Override
+ public String url() {
+ return url;
+ }
+
+ @Override
+ public String readme() {
+ return readme;
+ }
+
+ @Override
+ public byte[] icon() {
+ return icon;
+ }
+
+ @Override
public String origin() {
return origin;
}
@@ -119,8 +152,8 @@
@Override
public int hashCode() {
- return Objects.hash(appId, version, description, origin, role, permissions,
- featuresRepo, features, requiredApps);
+ return Objects.hash(appId, version, description, origin, category, url,
+ readme, role, permissions, featuresRepo, features, requiredApps);
}
@Override
@@ -136,6 +169,9 @@
Objects.equals(this.version, other.version) &&
Objects.equals(this.description, other.description) &&
Objects.equals(this.origin, other.origin) &&
+ Objects.equals(this.category, other.category) &&
+ Objects.equals(this.url, other.url) &&
+ Objects.equals(this.readme, other.readme) &&
Objects.equals(this.role, other.role) &&
Objects.equals(this.permissions, other.permissions) &&
Objects.equals(this.featuresRepo, other.featuresRepo) &&
@@ -150,6 +186,9 @@
.add("version", version)
.add("description", description)
.add("origin", origin)
+ .add("category", category)
+ .add("url", url)
+ .add("readme", readme)
.add("role", role)
.add("permissions", permissions)
.add("featuresRepo", featuresRepo)
diff --git a/core/api/src/test/java/org/onosproject/app/ApplicationEventTest.java b/core/api/src/test/java/org/onosproject/app/ApplicationEventTest.java
index 34c593c..0d4ae4c 100644
--- a/core/api/src/test/java/org/onosproject/app/ApplicationEventTest.java
+++ b/core/api/src/test/java/org/onosproject/app/ApplicationEventTest.java
@@ -32,8 +32,9 @@
public class ApplicationEventTest extends AbstractEventTest {
private Application createApp() {
- return new DefaultApplication(APP_ID, VER, DESC, ORIGIN, ROLE,
- PERMS, Optional.of(FURL), FEATURES, APPS);
+ return new DefaultApplication(APP_ID, VER, DESC, ORIGIN, CATEGORY,
+ URL, README, ICON, ROLE, PERMS,
+ Optional.of(FURL), FEATURES, APPS);
}
@Test
diff --git a/core/api/src/test/java/org/onosproject/app/DefaultApplicationDescriptionTest.java b/core/api/src/test/java/org/onosproject/app/DefaultApplicationDescriptionTest.java
index 0e93c1f..e01d4d8 100644
--- a/core/api/src/test/java/org/onosproject/app/DefaultApplicationDescriptionTest.java
+++ b/core/api/src/test/java/org/onosproject/app/DefaultApplicationDescriptionTest.java
@@ -40,6 +40,10 @@
public static final Version VER = Version.version(1, 2, "a", null);
public static final String DESC = "Awesome application from Circus, Inc.";
public static final String ORIGIN = "Circus";
+ public static final String CATEGORY = "other";
+ public static final String URL = "http://www.onosproject.org";
+ public static final String README = "Awesome application from Circus, Inc.";
+ public static final byte[] ICON = new byte[] {};
public static final ApplicationRole ROLE = ApplicationRole.ADMIN;
public static final Set<Permission> PERMS = ImmutableSet.of(
new Permission(AppPermission.class.getName(), "FLOWRULE_WRITE"),
@@ -52,17 +56,20 @@
public void basics() {
ApplicationDescription app =
new DefaultApplicationDescription(APP_NAME, VER, DESC, ORIGIN,
+ CATEGORY, URL, README, ICON,
ROLE, PERMS, FURL, FEATURES, APPS);
assertEquals("incorrect id", APP_NAME, app.name());
assertEquals("incorrect version", VER, app.version());
assertEquals("incorrect description", DESC, app.description());
assertEquals("incorrect origin", ORIGIN, app.origin());
- assertEquals("incorect role", ROLE, app.role());
+ assertEquals("incorrect category", CATEGORY, app.category());
+ assertEquals("incorrect URL", URL, app.url());
+ assertEquals("incorrect readme", README, app.readme());
+ assertEquals("incorrect role", ROLE, app.role());
assertEquals("incorrect permissions", PERMS, app.permissions());
assertEquals("incorrect features repo", FURL, app.featuresRepo().get());
assertEquals("incorrect features", FEATURES, app.features());
assertEquals("incorrect apps", APPS, app.requiredApps());
assertTrue("incorrect toString", app.toString().contains(APP_NAME));
}
-
}
\ No newline at end of file
diff --git a/core/api/src/test/java/org/onosproject/core/DefaultApplicationTest.java b/core/api/src/test/java/org/onosproject/core/DefaultApplicationTest.java
index 77b3812..6cb0d0c 100644
--- a/core/api/src/test/java/org/onosproject/core/DefaultApplicationTest.java
+++ b/core/api/src/test/java/org/onosproject/core/DefaultApplicationTest.java
@@ -33,12 +33,17 @@
@Test
public void basics() {
- Application app = new DefaultApplication(APP_ID, VER, DESC, ORIGIN, ROLE,
+ Application app = new DefaultApplication(APP_ID, VER, DESC, ORIGIN,
+ CATEGORY, URL, README, ICON, ROLE,
PERMS, Optional.of(FURL), FEATURES, APPS);
assertEquals("incorrect id", APP_ID, app.id());
assertEquals("incorrect version", VER, app.version());
assertEquals("incorrect description", DESC, app.description());
assertEquals("incorrect origin", ORIGIN, app.origin());
+ assertEquals("incorrect category", CATEGORY, app.category());
+ assertEquals("incorrect URL", URL, app.url());
+ assertEquals("incorrect readme", README, app.readme());
+ assertEquals("incorrect icon", ICON, app.icon());
assertEquals("incorrect role", ROLE, app.role());
assertEquals("incorrect permissions", PERMS, app.permissions());
assertEquals("incorrect features repo", FURL, app.featuresRepo().get());
@@ -49,16 +54,19 @@
@Test
public void testEquality() {
- Application a1 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN, ROLE,
+ Application a1 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN,
+ CATEGORY, URL, README, ICON, ROLE,
PERMS, Optional.of(FURL), FEATURES, APPS);
- Application a2 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN, ROLE,
+ Application a2 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN,
+ CATEGORY, URL, README, ICON, ROLE,
PERMS, Optional.of(FURL), FEATURES, APPS);
- Application a3 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN, ROLE,
+ Application a3 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN,
+ CATEGORY, URL, README, ICON, ROLE,
PERMS, Optional.empty(), FEATURES, APPS);
- Application a4 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN + "asd", ROLE,
+ Application a4 = new DefaultApplication(APP_ID, VER, DESC, ORIGIN + "asd",
+ CATEGORY, URL, README, ICON, ROLE,
PERMS, Optional.of(FURL), FEATURES, APPS);
new EqualsTester().addEqualityGroup(a1, a2)
.addEqualityGroup(a3).addEqualityGroup(a4).testEquals();
}
-
}
\ No newline at end of file