SHIBUI-1262 [1307 WIP]

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/AbstractElementExtensibleXMLObject.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.ElementExtensibleXMLObject;
 import org.opensaml.core.xml.XMLObject;
 
@@ -20,6 +21,7 @@
 @Entity
 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public abstract class AbstractElementExtensibleXMLObject extends AbstractXMLObject implements ElementExtensibleXMLObject {
     @OneToMany(cascade = CascadeType.ALL)
     @OrderColumn

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/EncryptionMethod.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.xmlsec.encryption.KeySize;
 import org.opensaml.xmlsec.encryption.OAEPparams;
 
@@ -10,6 +11,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class EncryptionMethod extends AbstractElementExtensibleXMLObject implements org.opensaml.saml.saml2.metadata.EncryptionMethod {
 
     private String algorithm;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/Endpoint.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 
 import javax.annotation.Nonnull;
@@ -14,6 +15,7 @@
  */
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class Endpoint extends AbstractAttributeExtensibleXMLObject implements org.opensaml.saml.saml2.metadata.Endpoint {
 
     private String binding;
@@ -72,4 +74,4 @@ public List<XMLObject> getUnknownXMLObjects() {
     public List<XMLObject> getUnknownXMLObjects(@Nonnull QName qName) {
         return null; //TODO
     }
-}
+}

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/EntityDescriptor.java

@@ -2,30 +2,21 @@
 
 import com.google.common.base.MoreObjects;
 import com.google.common.collect.Lists;
-
 import lombok.EqualsAndHashCode;
-import org.hibernate.envers.AuditOverride;
 import org.hibernate.envers.Audited;
 import org.hibernate.envers.NotAudited;
-import org.opensaml.core.config.ConfigurationService;
 import org.opensaml.core.xml.XMLObject;
-import org.opensaml.core.xml.config.XMLObjectProviderRegistry;
-import org.opensaml.core.xml.io.MarshallingException;
 import org.springframework.util.StringUtils;
-import org.w3c.dom.Element;
 
 import javax.annotation.Nullable;
-
-import javax.persistence.JoinColumn;
 import javax.persistence.CascadeType;
 import javax.persistence.Entity;
+import javax.persistence.JoinColumn;
 import javax.persistence.OneToMany;
 import javax.persistence.OneToOne;
 import javax.persistence.OrderColumn;
 import javax.persistence.Transient;
-
 import javax.xml.namespace.QName;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -49,7 +40,6 @@ public class EntityDescriptor extends AbstractDescriptor implements org.opensaml
     private String resourceId;
 
     @OneToOne(cascade = CascadeType.ALL)
-    @NotAudited
     private Organization organization;
 
     @OneToMany(cascade = CascadeType.ALL)
@@ -58,7 +48,6 @@ public class EntityDescriptor extends AbstractDescriptor implements org.opensaml
 
     @OneToMany(cascade = CascadeType.ALL)
     @OrderColumn
-    @NotAudited
     private List<RoleDescriptor> roleDescriptors;
 
     @OneToMany(cascade = CascadeType.ALL)

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/Extensions.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 
 import javax.annotation.Nullable;
@@ -13,6 +14,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class Extensions extends AbstractElementExtensibleXMLObject implements org.opensaml.saml.saml2.metadata.Extensions {
     @Nullable
     @Override

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/KeyDescriptor.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 import org.opensaml.security.credential.UsageType;
 import org.opensaml.xmlsec.signature.KeyInfo;
@@ -12,6 +13,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class KeyDescriptor extends AbstractXMLObject implements org.opensaml.saml.saml2.metadata.KeyDescriptor {
 
     @Column(name = "keyDescriptorName")

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/KeyInfo.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 import org.opensaml.xmlsec.encryption.AgreementMethod;
 import org.opensaml.xmlsec.encryption.EncryptedKey;
@@ -29,6 +30,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class KeyInfo extends AbstractXMLObject implements org.opensaml.xmlsec.signature.KeyInfo {
 
     @OneToMany(cascade = CascadeType.ALL)

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/LocalizedName.java

@@ -1,9 +1,12 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
+import org.hibernate.envers.Audited;
+
 import javax.annotation.Nullable;
 import javax.persistence.MappedSuperclass;
 
 @MappedSuperclass
+@Audited
 public class LocalizedName extends AbstractXMLObject implements org.opensaml.saml.saml2.metadata.LocalizedName {
 
     private String xMLLang;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/Organization.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 
 import javax.annotation.Nullable;
@@ -11,6 +12,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class Organization extends AbstractAttributeExtensibleXMLObject implements org.opensaml.saml.saml2.metadata.Organization {
 
     @OneToOne(cascade = CascadeType.ALL)

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/OrganizationDisplayName.java

@@ -1,11 +1,13 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 
 import javax.persistence.Entity;
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class OrganizationDisplayName extends LocalizedName implements org.opensaml.saml.saml2.metadata.OrganizationDisplayName {
 
 }

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/OrganizationName.java

@@ -1,11 +1,13 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 
 import javax.persistence.Entity;
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class OrganizationName extends LocalizedName implements org.opensaml.saml.saml2.metadata.OrganizationName {
 
 }

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/OrganizationURL.java

@@ -1,12 +1,14 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 
 import javax.annotation.Nullable;
 import javax.persistence.Entity;
 
 @Entity
 @EqualsAndHashCode(callSuper = true)
+@Audited
 public class OrganizationURL extends AbstractXMLObject implements org.opensaml.saml.saml2.metadata.OrganizationURL {
 
     private String xMLLang;

backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/RoleDescriptor.java

@@ -1,6 +1,7 @@
 package edu.internet2.tier.shibboleth.admin.ui.domain;
 
 import lombok.EqualsAndHashCode;
+import org.hibernate.envers.Audited;
 import org.opensaml.core.xml.XMLObject;
 import org.opensaml.core.xml.util.AttributeMap;
 
@@ -25,6 +26,7 @@
 
 @Entity
 @EqualsAndHashCode(callSuper = true, exclude={"unknownAttributes"})
+@Audited
 public class RoleDescriptor extends AbstractDescriptor implements org.opensaml.saml.saml2.metadata.RoleDescriptor {
 
     @ElementCollection

backend/src/test/groovy/edu/internet2/tier/shibboleth/admin/ui/repository/envers/EntityDescriptorEnversVersioningTests.groovy

@@ -7,6 +7,7 @@ import edu.internet2.tier.shibboleth.admin.ui.configuration.TestConfiguration
 import edu.internet2.tier.shibboleth.admin.ui.domain.EntityDescriptor
 import edu.internet2.tier.shibboleth.admin.ui.domain.frontend.ContactRepresentation
 import edu.internet2.tier.shibboleth.admin.ui.domain.frontend.EntityDescriptorRepresentation
+import edu.internet2.tier.shibboleth.admin.ui.domain.frontend.OrganizationRepresentation
 import edu.internet2.tier.shibboleth.admin.ui.opensaml.OpenSamlObjects
 import edu.internet2.tier.shibboleth.admin.ui.repository.EntityDescriptorRepository
 import edu.internet2.tier.shibboleth.admin.ui.service.EntityDescriptorService
@@ -16,7 +17,6 @@ import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest
 import org.springframework.data.jpa.repository.config.EnableJpaRepositories
 import org.springframework.test.context.ContextConfiguration
 import org.springframework.transaction.PlatformTransactionManager
-import spock.lang.Shared
 import spock.lang.Specification
 
 import javax.persistence.EntityManager
@@ -49,11 +49,9 @@ class EntityDescriptorEnversVersioningTests extends Specification {
     @Autowired
     OpenSamlObjects openSamlObjects
 
-    @Shared
-    EntityDescriptor ed = new EntityDescriptor()
-
     def "test versioning with contact persons"() {
         when:
+        def ed = new EntityDescriptor()
         def representation = new EntityDescriptorRepresentation().with {
             it.contacts = [new ContactRepresentation(type: 'administrative', name: 'name', emailAddress: 'test@test')]
             it
@@ -116,4 +114,48 @@ class EntityDescriptorEnversVersioningTests extends Specification {
         entityDescriptorHistory[0][1].timestamp > 0L
 
     }
+
+    def "test versioning with organization"() {
+        when:
+        EntityDescriptor ed = new EntityDescriptor()
+        def representation = new EntityDescriptorRepresentation().with {
+            it.organization = new OrganizationRepresentation(name: 'org', displayName: 'display org', url: 'http://org.edu')
+            it
+        }
+        def entityDescriptorHistory = updateAndGetRevisionHistory(ed, representation, entityDescriptorService,
+                entityDescriptorRepository,
+                txMgr,
+                entityManager)
+        then:
+        entityDescriptorHistory.size() == 1
+        entityDescriptorHistory[0][0].organization.organizationNames[0].value == 'org'
+        entityDescriptorHistory[0][0].organization.displayNames[0].value == 'display org'
+        entityDescriptorHistory[0][0].organization.URLs[0].value == 'http://org.edu'
+        entityDescriptorHistory[0][1].principalUserName == 'anonymous'
+        entityDescriptorHistory[0][1].timestamp > 0L
+
+        when:
+        representation = new EntityDescriptorRepresentation().with {
+            it.organization = new OrganizationRepresentation(name: 'orgUpdated', displayName: 'display org Updated', url: 'http://org2.edu')
+            it
+        }
+        entityDescriptorHistory = updateAndGetRevisionHistory(ed, representation, entityDescriptorService,
+                entityDescriptorRepository,
+                txMgr,
+                entityManager)
+        then:
+        entityDescriptorHistory.size() == 2
+        entityDescriptorHistory[1][0].organization.organizationNames[0].value == 'orgUpdated'
+        entityDescriptorHistory[1][0].organization.displayNames[0].value == 'display org Updated'
+        entityDescriptorHistory[1][0].organization.URLs[0].value == 'http://org2.edu'
+        entityDescriptorHistory[1][1].principalUserName == 'anonymous'
+        entityDescriptorHistory[1][1].timestamp > 0L
+
+        //Check the original revision is intact
+        entityDescriptorHistory[0][0].organization.organizationNames[0].value == 'org'
+        entityDescriptorHistory[0][0].organization.displayNames[0].value == 'display org'
+        entityDescriptorHistory[0][0].organization.URLs[0].value == 'http://org.edu'
+        entityDescriptorHistory[0][1].principalUserName == 'anonymous'
+        entityDescriptorHistory[0][1].timestamp > 0L
+    }
 }