ALF-7260: schema comparator - improved language of reporting.

The differences and validation messages are hopefully improved, e.g:

Difference: missing sequence from database, expected at path: .alf_acl_member_seq
Difference: missing table from database, expected at path: .alf_acl_change_set
Validation: index alfresco.some_table.idx_table_id.name="idx_table_id" fails to match rule: value must be 'xyz'

I'm sure there's still room for improvement but this should give a decent starting point.



git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@32420 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Matt Ward
2011-11-30 17:57:02 +00:00
parent 4096c01153
commit 3fab4ea0d6
10 changed files with 54 additions and 23 deletions

View File

@@ -88,7 +88,7 @@ public final class Difference extends Result
{
return I18NUtil.getMessage(
"system.schema_comp.diff.target_only",
getWhere(),
getRight().getDbObject().getTypeName(),
getRight().getPath(),
getRight().getPropertyValue());
}
@@ -96,14 +96,14 @@ public final class Difference extends Result
{
return I18NUtil.getMessage(
"system.schema_comp.diff.ref_only",
getWhere(),
getLeft().getDbObject().getTypeName(),
getLeft().getPath(),
getLeft().getPropertyValue());
}
return I18NUtil.getMessage(
"system.schema_comp.diff",
getWhere(),
getLeft().getDbObject().getTypeName(),
getLeft().getPath(),
getLeft().getPropertyValue(),
getRight().getPath(),

View File

@@ -24,6 +24,7 @@ import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import org.alfresco.util.schemacomp.Difference.Where;
import org.alfresco.util.schemacomp.model.Column;
import org.junit.Before;
import org.junit.Test;
import org.springframework.extensions.surf.util.I18NUtil;
@@ -47,15 +48,17 @@ public class DifferenceTest
DbProperty refDbProp = mock(DbProperty.class);
when(refDbProp.getPath()).thenReturn("alfresco.some_table.some_column.name");
when(refDbProp.getDbObject()).thenReturn(new Column("some_column"));
when(refDbProp.getPropertyValue()).thenReturn("node_ref");
DbProperty targetDbProp = mock(DbProperty.class);
when(targetDbProp.getPath()).thenReturn("alfresco.some_table.some_column.name");
when(targetDbProp.getDbObject()).thenReturn(new Column("some_column"));
when(targetDbProp.getPropertyValue()).thenReturn("nood_ref");
Difference diff = new Difference(Where.IN_BOTH_BUT_DIFFERENCE, refDbProp, targetDbProp);
assertEquals("Difference: IN_BOTH_BUT_DIFFERENCE, reference path:alfresco.some_table.some_column.name " +
"(value: node_ref), target path:alfresco.some_table.some_column.name (value: nood_ref)",
assertEquals("Difference: expected column alfresco.some_table.some_column.name=\"node_ref\"" +
", but was alfresco.some_table.some_column.name=\"nood_ref\"",
diff.describe());
}
@@ -63,13 +66,12 @@ public class DifferenceTest
public void describeRefOnly()
{
DbProperty refDbProp = mock(DbProperty.class);
when(refDbProp.getPath()).thenReturn("alfresco.some_table.some_column.name");
when(refDbProp.getPropertyValue()).thenReturn("node_ref");
when(refDbProp.getPath()).thenReturn("alfresco.some_table.some_column");
when(refDbProp.getDbObject()).thenReturn(new Column("some_column"));
Difference diff = new Difference(Where.ONLY_IN_REFERENCE, refDbProp, null);
assertEquals("Difference: ONLY_IN_REFERENCE, reference path:alfresco.some_table.some_column.name " +
"(value: node_ref)",
assertEquals("Difference: missing column from database, expected at path: alfresco.some_table.some_column",
diff.describe());
}
@@ -77,13 +79,12 @@ public class DifferenceTest
public void describeTargetOnly()
{
DbProperty targetDbProp = mock(DbProperty.class);
when(targetDbProp.getPath()).thenReturn("alfresco.some_table.some_column.name");
when(targetDbProp.getPropertyValue()).thenReturn("node_ref");
when(targetDbProp.getPath()).thenReturn("alfresco.some_table.some_column");
when(targetDbProp.getDbObject()).thenReturn(new Column("some_column"));
Difference diff = new Difference(Where.ONLY_IN_TARGET, null, targetDbProp);
assertEquals("Difference: ONLY_IN_TARGET, target path:alfresco.some_table.some_column.name " +
"(value: node_ref)",
assertEquals("Difference: unexpected column found in database with path: alfresco.some_table.some_column",
diff.describe());
}
}

View File

@@ -51,7 +51,7 @@ public class RedundantDbObjectTest
RedundantDbObject redundantDBO = new RedundantDbObject(reference, matches);
assertEquals("3 redundant items? reference: MyDbObject[name=reference], " +
assertEquals("Redundancy: 3 items matching MyDbObject[name=reference], " +
"matches: MyDbObject[name=match1], MyDbObject[name=match2], MyDbObject[name=match3]",
redundantDBO.describe());
}

View File

@@ -66,6 +66,7 @@ public class ValidationResult extends Result
{
return I18NUtil.getMessage(
"system.schema_comp.validation",
getDbProperty().getDbObject().getTypeName(),
getDbProperty().getPath(),
getValue(),
message);

View File

@@ -23,6 +23,7 @@ import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import org.alfresco.util.schemacomp.model.Index;
import org.junit.Before;
import org.junit.Test;
import org.springframework.extensions.surf.util.I18NUtil;
@@ -45,12 +46,14 @@ public class ValidationResultTest
public void describe()
{
DbProperty targetDbProp = mock(DbProperty.class);
when(targetDbProp.getPath()).thenReturn("alfresco.some_table.some_index.name");
when(targetDbProp.getPropertyValue()).thenReturn("ibx_my_index");
when(targetDbProp.getPath()).thenReturn("alfresco.some_table.idx_table_id.name");
when(targetDbProp.getPropertyValue()).thenReturn("idx_table_id");
when(targetDbProp.getDbObject()).thenReturn(new Index(""));
ValidationResult validation = new ValidationResult(targetDbProp, "value must be 'xyz'");
assertEquals("Validation: target path:alfresco.some_table.some_index.name (value: ibx_my_index, rule: value must be 'xyz')",
assertEquals("Validation: index alfresco.some_table.idx_table_id.name=\"idx_table_id\" fails to " +
"match rule: value must be 'xyz'",
validation.describe());
}
}

View File

@@ -252,4 +252,11 @@ public abstract class AbstractDbObject implements DbObject
this.validators = validators;
}
}
@Override
public String getTypeName()
{
return getClass().getSimpleName().toLowerCase();
}
}

View File

@@ -105,4 +105,11 @@ public interface DbObject
* @param validators
*/
void setValidators(List<DbValidator> validators);
/**
* Type name, e.g. "column", "foreign key"
*
* @return String
*/
String getTypeName();
}

View File

@@ -166,5 +166,11 @@ public class ForeignKey extends AbstractDbObject
public void accept(DbObjectVisitor visitor)
{
visitor.visit(this);
}
}
@Override
public String getTypeName()
{
return "foreign key";
}
}

View File

@@ -155,4 +155,10 @@ public class PrimaryKey extends AbstractDbObject
checkColumnOrders();
visitor.visit(this);
}
@Override
public String getTypeName()
{
return "primary key";
}
}