From 81ad9aa3964eec60a1d431290fc23139aee2204d Mon Sep 17 00:00:00 2001 From: vempo Date: Tue, 9 Jan 2018 14:25:08 +0200 Subject: Add Togglz REST API Supporting REST API, and Javascript for Togglz Issue-ID: SDC-881 Change-Id: I026d3f190cb95c8943a85b26dfbcd13e856abe64 Signed-off-by: shrek2000 (cherry picked from commit 5a33f027cd2bc4253d5ebb7a71889ead65d095b2) Signed-off-by: vempo --- .../onboarding-rest-war/pom.xml | 5 ++ .../src/main/webapp/WEB-INF/beans-services.xml | 6 +- openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml | 1 + .../openecomp-sdc-rest-webapp/togglz-rest/pom.xml | 22 +++++++ .../togglz-rest/togglz-rest-services/pom.xml | 68 ++++++++++++++++++++++ .../sdcrests/togglz/rest/TogglzFeatures.java | 44 ++++++++++++++ .../rest/mapping/MapToggleableFeatureToDto.java | 40 +++++++++++++ .../togglz/rest/services/TogglzFeaturesImpl.java | 42 +++++++++++++ .../java/org/openecomp/TogglzFeatureRestTest.java | 59 +++++++++++++++++++ .../togglz-rest/togglz-rest-types/pom.xml | 15 +++++ .../sdcrests/togglz/types/FeatureDto.java | 55 +++++++++++++++++ .../sdcrests/togglz/types/FeatureSetDto.java | 36 ++++++++++++ 12 files changed, 392 insertions(+), 1 deletion(-) create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/TogglzFeatures.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/mapping/MapToggleableFeatureToDto.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/services/TogglzFeaturesImpl.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/test/java/org/openecomp/TogglzFeatureRestTest.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/pom.xml create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureDto.java create mode 100644 openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureSetDto.java (limited to 'openecomp-be/api/openecomp-sdc-rest-webapp') diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml index 550b4e610f..be85dc579d 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/pom.xml @@ -70,6 +70,11 @@ application-config-rest-services ${project.version} + + org.openecomp.sdc + togglz-rest-services + ${project.version} + org.openecomp.sdc.onboarding action-library-rest-services diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml index e43fa017d8..495cd3f843 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/src/main/webapp/WEB-INF/beans-services.xml @@ -3,7 +3,8 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:context="http://www.springframework.org/schema/context" - xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + xsi:schemaLocation="http://www.springframework.org/schema/beans + http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> @@ -38,6 +39,8 @@ + + @@ -69,6 +72,7 @@ + diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml index d44e0c8b98..e7f1b62956 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/pom.xml @@ -28,6 +28,7 @@ item-rest notifications-fe notifications-rest + togglz-rest diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/pom.xml new file mode 100644 index 0000000000..fb786f2089 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/pom.xml @@ -0,0 +1,22 @@ + + + 4.0.0 + + + org.openecomp.sdc + openecomp-sdc-rest-webapp + 1.2.0-SNAPSHOT + + + togglz-rest + pom + + + + togglz-rest-types + togglz-rest-services + + + \ No newline at end of file diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/pom.xml new file mode 100644 index 0000000000..baad898ff1 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/pom.xml @@ -0,0 +1,68 @@ + + + 4.0.0 + + + org.openecomp.sdc + togglz-rest + 1.2.0-SNAPSHOT + + + togglz-rest-services + + + + + javax.ws.rs + javax.ws.rs-api + ${ws.rs.version} + + + org.springframework + spring-context + ${spring.framework.version} + + + javax.inject + javax.inject + ${javax.inject.version} + + + org.openecomp.sdc.core + openecomp-common-lib + ${project.version} + + + org.openecomp.sdc + togglz-rest-types + ${project.version} + + + org.openecomp.sdc + openecomp-sdc-common-rest + ${project.version} + + + + org.apache.cxf + cxf-rt-frontend-jaxrs + ${cxf.version} + + + junit + junit + ${junit.version} + test + + + org.mockito + mockito-all + test + ${mockito.all.version} + + + + + \ No newline at end of file diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/TogglzFeatures.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/TogglzFeatures.java new file mode 100644 index 0000000000..9a1fde3d9c --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/TogglzFeatures.java @@ -0,0 +1,44 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * 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 org.openecomp.sdcrests.togglz.rest; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import org.openecomp.sdcrests.togglz.types.FeatureSetDto; +import org.springframework.validation.annotation.Validated; + +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +@Path("/v1.0/togglz") +@Produces(MediaType.APPLICATION_JSON) +@Consumes(MediaType.APPLICATION_JSON) +@Api(value = "TOGGLZ") +@Validated +public interface TogglzFeatures { + + @GET + @ApiOperation(value = "Get TOGGLZ Features", + response = FeatureSetDto.class, + responseContainer = "List") + Response getFeatures(); + +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/mapping/MapToggleableFeatureToDto.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/mapping/MapToggleableFeatureToDto.java new file mode 100644 index 0000000000..769622d35e --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/mapping/MapToggleableFeatureToDto.java @@ -0,0 +1,40 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * 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 org.openecomp.sdcrests.togglz.rest.mapping; + +import org.openecomp.sdcrests.mapping.MappingBase; +import org.openecomp.sdcrests.togglz.types.FeatureDto; +import org.openecomp.sdcrests.togglz.types.FeatureSetDto; + +import java.util.Collection; +import java.util.Collections; +import java.util.Set; +import java.util.stream.Collectors; +import org.openecomp.sdc.common.togglz.ToggleStatus; + +public class MapToggleableFeatureToDto extends MappingBase, FeatureSetDto> { + + @Override + public void doMapping(Collection source, FeatureSetDto target) { + if (source != null && !source.isEmpty()){ + Set fDtos = source.stream().map(f -> new FeatureDto(f.name(), f.isActive())) + .collect(Collectors.toSet()); + target.setFeatures(fDtos); + } else { + target.setFeatures(Collections.emptySet()); + } + } +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/services/TogglzFeaturesImpl.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/services/TogglzFeaturesImpl.java new file mode 100644 index 0000000000..5b7240be54 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/main/java/org/openecomp/sdcrests/togglz/rest/services/TogglzFeaturesImpl.java @@ -0,0 +1,42 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * 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 org.openecomp.sdcrests.togglz.rest.services; + +import org.openecomp.sdc.common.togglz.ToggleableFeature; +import org.openecomp.sdcrests.togglz.rest.TogglzFeatures; +import org.openecomp.sdcrests.togglz.rest.mapping.MapToggleableFeatureToDto; +import org.openecomp.sdcrests.togglz.types.FeatureSetDto; +import org.springframework.context.annotation.Scope; +import org.springframework.stereotype.Service; + +import javax.inject.Named; +import javax.ws.rs.core.Response; +import java.util.Arrays; + +@Named +@Service("TogglzFeature") +@Scope(value = "prototype") +public class TogglzFeaturesImpl implements TogglzFeatures { + + @Override + public Response getFeatures() { + FeatureSetDto featureSetDto = new FeatureSetDto(); + new MapToggleableFeatureToDto().doMapping(Arrays.asList(ToggleableFeature.values()), featureSetDto); + return Response.ok(featureSetDto).build(); + } +} + diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/test/java/org/openecomp/TogglzFeatureRestTest.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/test/java/org/openecomp/TogglzFeatureRestTest.java new file mode 100644 index 0000000000..b8f3286823 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-services/src/test/java/org/openecomp/TogglzFeatureRestTest.java @@ -0,0 +1,59 @@ +package org.openecomp; + +import com.google.common.collect.Sets; +import org.junit.Test; +import org.openecomp.sdc.common.togglz.ToggleStatus; +import org.openecomp.sdc.common.togglz.ToggleableFeature; +import org.openecomp.sdcrests.togglz.rest.TogglzFeatures; +import org.openecomp.sdcrests.togglz.rest.mapping.MapToggleableFeatureToDto; +import org.openecomp.sdcrests.togglz.rest.services.TogglzFeaturesImpl; +import org.openecomp.sdcrests.togglz.types.FeatureDto; +import org.openecomp.sdcrests.togglz.types.FeatureSetDto; + +import javax.ws.rs.core.Response; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Set; +import java.util.stream.Collectors; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class TogglzFeatureRestTest { + + @Test + public void shouldConvertDataProperly() { + ToggleStatus tf = mock(ToggleStatus.class); + final String TF_NAME = "tf"; + final boolean ACTIVE = true; + when(tf.name()).thenReturn(TF_NAME); + when(tf.isActive()).thenReturn(ACTIVE); + MapToggleableFeatureToDto mapToggleableFeatureToDto = new MapToggleableFeatureToDto(); + FeatureSetDto target = new FeatureSetDto(); + Collection source = Collections.singletonList(tf); + mapToggleableFeatureToDto.doMapping(source, target); + assertEquals(source.size(), target.getFeatures().size()); + FeatureDto result = target.getFeatures().iterator().next(); + assertEquals(TF_NAME, result.getName()); + assertEquals(ACTIVE, result.isActive()); + + } + + @Test + public void shouldGetCurrentTogglzValues() { + TogglzFeatures togglzFeature = new TogglzFeaturesImpl(); + Response response = togglzFeature.getFeatures(); + assertNotNull(response); + Object entity = response.getEntity(); + assertEquals(entity.getClass(), FeatureSetDto.class); + Set features = ((FeatureSetDto) entity).getFeatures(); + assertEquals(features.size(), ToggleableFeature.values().length); + Set names = Arrays.stream(ToggleableFeature.values()).map(Enum::name).collect(Collectors.toSet()); + Set dtoNames = features.stream().map(FeatureDto::getName).collect(Collectors.toSet()); + assertTrue(Sets.symmetricDifference(names, dtoNames).isEmpty()); + } +} \ No newline at end of file diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/pom.xml b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/pom.xml new file mode 100644 index 0000000000..ac264de509 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/pom.xml @@ -0,0 +1,15 @@ + + + 4.0.0 + + + org.openecomp.sdc + togglz-rest + 1.2.0-SNAPSHOT + + + togglz-rest-types + + \ No newline at end of file diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureDto.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureDto.java new file mode 100644 index 0000000000..d6e2fbd669 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureDto.java @@ -0,0 +1,55 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * 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 org.openecomp.sdcrests.togglz.types; + +import java.util.Objects; + +public class FeatureDto { + + private final String name; + private final boolean active; + + public FeatureDto(String name, boolean active) { + this.name = name; + this.active = active; + } + + public String getName() { + return name; + } + + public boolean isActive() { + return active; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof FeatureDto)) return false; + FeatureDto that = (FeatureDto) o; + return Objects.equals(getName(), that.getName()); + } + + @Override + public int hashCode() { + return Objects.hash(getName()); + } + + @Override + public String toString() { + return "FeatureDto{name='" + name + '\'' + ", active=" + active + '}'; + } +} diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureSetDto.java b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureSetDto.java new file mode 100644 index 0000000000..cf7ee71a35 --- /dev/null +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/togglz-rest/togglz-rest-types/src/main/java/org/openecomp/sdcrests/togglz/types/FeatureSetDto.java @@ -0,0 +1,36 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * 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 org.openecomp.sdcrests.togglz.types; + +import java.util.Set; + +public class FeatureSetDto { + + private Set features; + + public Set getFeatures() { + return features; + } + + public void setFeatures(Set features) { + this.features = features; + } + + @Override + public String toString() { + return "FeatureSetDto{features=" + features + '}'; + } +} -- cgit 1.2.3-korg