src_fm_fc_ms_ff
stringlengths 43
86.8k
| target
stringlengths 20
276k
|
|---|---|
Label { public static Label of(final String label) { if (StringUtils.isEmpty(label)) { return RootLabel.getInstance(); } if (!ASCIILabel.ASCII_SET.containsAll(label)) { IDNA.Info info = new IDNA.Info(); StringBuilder result = new StringBuilder(); IDNA.labelToUnicode(label, result, info); if (info.hasErrors()) { throw new LabelException.IDNParseException(info.getErrors()); } return new NonASCIILabel.ULabel(result.toString()); } if (!ASCIILabel.LDHLabel.LDH_SET.containsAll(label) || label.startsWith(HYPHEN) || label.endsWith(HYPHEN)) { return new ASCIILabel.NONLDHLabel(label); } if (!label.matches("^..--.*")) { return new ASCIILabel.LDHLabel.NonReservedLDHLabel(label); } if (label.startsWith("xn")) { Label aLabel = new ASCIILabel.LDHLabel.ReservedLDHLabel.ALabel(label); try { aLabel.toUnicode(); return aLabel; } catch (LabelException.IDNParseException e) { LOGGER.debug("Fake A-Label", e); return new ASCIILabel.LDHLabel.ReservedLDHLabel.FakeALabel(label, e.getErrors()); } } return new ASCIILabel.LDHLabel.ReservedLDHLabel(label); } Label(String value); static Label of(final String label); String getStringValue(); Label toLDH(); Label toUnicode(); static final Logger LOGGER; static final int IDNA_OPTIONS; } | @Test public void testLabelInstances() { Label label = Label.of("example"); assertTrue(label instanceof Label.ASCIILabel.LDHLabel.NonReservedLDHLabel); label = Label.of(""); assertTrue(label instanceof Label.RootLabel); label = Label.of("xn--bcher-kva"); assertTrue(label instanceof Label.ASCIILabel.LDHLabel.ReservedLDHLabel.ALabel); label = Label.of("xn--bcher-aaa"); assertTrue(label instanceof Label.ASCIILabel.LDHLabel.ReservedLDHLabel.FakeALabel); label = Label.of("_tcp"); assertTrue(label instanceof Label.ASCIILabel.NONLDHLabel); label = Label.of("-example"); assertTrue(label instanceof Label.ASCIILabel.NONLDHLabel); label = Label.of("example-"); assertTrue(label instanceof Label.ASCIILabel.NONLDHLabel); }
@Test public void testControlCharacters() { for (final String s : new UnicodeSet(0, 31)) { Assert.assertThrows(new Assert.Closure() { @Override public void execute() throws Throwable { Label.of(s); } }, LabelException.IDNParseException.class, "expects LabelException"); } } |
Label { public Label toUnicode() { return this; } Label(String value); static Label of(final String label); String getStringValue(); Label toLDH(); Label toUnicode(); static final Logger LOGGER; static final int IDNA_OPTIONS; } | @Test public void testToUnicode() { Label label = Label.of("xn--bcher-kva"); assertEquals("b\u00FCcher", label.toUnicode().getStringValue()); } |
Label { public Label toLDH() { return this; } Label(String value); static Label of(final String label); String getStringValue(); Label toLDH(); Label toUnicode(); static final Logger LOGGER; static final int IDNA_OPTIONS; } | @Test public void testToLDH() { Label label = Label.of("b\u00FCcher"); assertEquals("xn--bcher-kva", label.toLDH().getStringValue()); label = Label.of("Bu\u0308cher"); assertEquals("xn--bcher-kva", label.toLDH().getStringValue()); assertEquals("b\u00FCcher", label.getStringValue()); } |
TelephoneNumber { public static TelephoneNumber of(String number) { String normalized = number.replaceAll("[\\(\\)\\.\\s-_]", ""); LOGGER.debug("Normalized telephone number: {}", normalized); if (!normalized.matches("^\\+?\\d+$")) { throw new IllegalArgumentException("bad number"); } String prefix = "", suffix = ""; if (normalized.startsWith("+")) { for (int i = 1; i <= 3; i++) { prefix = normalized.substring(1, i); suffix = normalized.substring(i); LOGGER.debug("prefix: {} suffix: {}", prefix, suffix); if (COUNTRY_CODES.containsKey(prefix)) { break; } } } else { prefix = "0"; suffix = normalized; } return new TelephoneNumber(Integer.valueOf(prefix), new BigInteger(suffix)); } private TelephoneNumber(int countryCode, BigInteger nationalNumber); static String getRegion(int countryCode); static TelephoneNumber of(String number); static TelephoneNumber of(int countryCode, BigInteger nationalNumber); int getCountryCode(); BigInteger getNationalNumber(); String getRegion(); String getStringValue(); @Override String toString(); } | @Test public void testInvalidCountryCode() { assertThrows(new Closure() { @Override public void execute() throws Throwable { TelephoneNumber.of(1000, new BigInteger("1234567890")); } }, IllegalArgumentException.class, "Should throw IllegalArgumentException"); }
@Test public void testTooLongTelephoneNumber() { assertThrows(new Closure() { @Override public void execute() throws Throwable { TelephoneNumber.of("+32 12345678901234"); } }, IllegalArgumentException.class, "Should throw IllegalArgumentException"); }
@Test public void testInvalidCharacters() { assertThrows(new Closure() { @Override public void execute() throws Throwable { TelephoneNumber.of("+32 abcdefg"); } }, IllegalArgumentException.class, "Should throw IllegalArgumentException"); assertThrows(new Closure() { @Override public void execute() throws Throwable { TelephoneNumber.of("+32 %1234)56789"); } }, IllegalArgumentException.class, "Should throw IllegalArgumentException"); } |
CIDR { public static CIDR of(String cidr) { String[] parts = cidr.split("\\/"); if (parts.length == 1) { try { InetAddress address = InetAddress.getByName(parts[0]); int length = address instanceof Inet4Address ? 32 : 128; return new CIDR(address.getAddress(), length); } catch (UnknownHostException e) { throw new IllegalArgumentException(e); } } if (parts.length != 2) { throw new IllegalArgumentException("Invalid format"); } try { InetAddress address = InetAddress.getByName(parts[0]); return new CIDR(address.getAddress(),Integer.parseInt(parts[1])); } catch (UnknownHostException e) { throw new IllegalArgumentException(e); } } CIDR(byte[] address, int size); byte[] getAddress(); int getSize(); byte[] getMask(); boolean contains(InetAddress inet); static CIDR of(String cidr); } | @Test public void testDoesItSmoke() { Assert.assertThrows(new Assert.Closure() { @Override public void execute() throws Throwable { CIDR.of("1.1.1.1/-1"); } }, IllegalArgumentException.class, "negative prefix size"); } |
SimpleDbExceptionTranslator implements PersistenceExceptionTranslator { @Override public DataAccessException translateExceptionIfPossible(RuntimeException e) { final String errorMessage = e.getLocalizedMessage(); if(e instanceof DuplicateItemNameException) { return new DuplicateKeyException(errorMessage, e); } if(e instanceof AttributeDoesNotExistException) { return new EmptyResultDataAccessException(errorMessage, -1); } if(e instanceof ResourceNotFoundException) { return new DataRetrievalFailureException(errorMessage, e); } if(e instanceof InvalidParameterValueException) { return new InvalidDataAccessResourceUsageException(errorMessage, e); } if(e instanceof NoSuchDomainException) { return new EmptyResultDataAccessException(errorMessage, -1); } if((e instanceof NumberDomainAttributesExceededException) || (e instanceof NumberDomainsExceededException)) { return new DataIntegrityViolationException(errorMessage, e); } if((e instanceof InvalidNextTokenException) || (e instanceof TooManyRequestedAttributesException) || (e instanceof MissingParameterException) ) { return new InvalidDataAccessApiUsageException(errorMessage, e); } if(e instanceof AmazonServiceException) { return new DataAccessResourceFailureException(errorMessage, e); } if(e instanceof AmazonClientException) { return new UncategorizedSpringDaoException(errorMessage, e); } return null; } private SimpleDbExceptionTranslator(); static synchronized SimpleDbExceptionTranslator getTranslatorInstance(); RuntimeException translateAmazonClientException(AmazonClientException e); @Override DataAccessException translateExceptionIfPossible(RuntimeException e); } | @Test public void translateExceptionIfPossible_should_translate_DuplicateItemNameException_into_DuplicateKeyException() { DuplicateItemNameException duplicateItemException = new DuplicateItemNameException("Duplicate Item"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(duplicateItemException); assertThat(dataAccessException, is(instanceOf(DuplicateKeyException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Duplicate Item")); }
@Test public void translateExceptionIfPossible_should_translate_AttributeDoesNotExistException_into_EmptyResultDataAccessException() { AttributeDoesNotExistException attributeDoesNotExistException = new AttributeDoesNotExistException( "Attribute does not exist"); DataAccessException dataAccessException = translator .translateExceptionIfPossible(attributeDoesNotExistException); assertThat(dataAccessException, is(instanceOf(EmptyResultDataAccessException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), is("Attribute does not exist")); }
@Test public void translateExceptionIfPossible_should_translate_ResourceNotFoundException_into_DataRetrievalFailureException() { ResourceNotFoundException resourceNotFoundException = new ResourceNotFoundException("Resource Not Found"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(resourceNotFoundException); assertThat(dataAccessException, is(instanceOf(DataRetrievalFailureException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Resource Not Found")); }
@Test public void translateExceptionIfPossible_should_translate_InvalidParameterValueException_into_InvalidDataAccessResourceUsageException() { InvalidParameterValueException invalidParameterValueException = new InvalidParameterValueException( "Invalid Parameter"); DataAccessException dataAccessException = translator .translateExceptionIfPossible(invalidParameterValueException); assertThat(dataAccessException, is(instanceOf(InvalidDataAccessResourceUsageException.class))); assertThat(invalidParameterValueException, is(notNullValue())); assertThat(invalidParameterValueException.getLocalizedMessage(), is("Invalid Parameter")); }
@Test public void translateExceptionIfPossible_should_translate_NoSuchDomainException_into_EmptyResultDataAccessException() { NoSuchDomainException noSuchDomainException = new NoSuchDomainException("No such domain"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(noSuchDomainException); assertThat(dataAccessException, is(instanceOf(EmptyResultDataAccessException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), is("No such domain")); }
@Test public void translateExceptionIfPossible_should_translate_NumberDomainsExceededException_into_DataIntegrityViolationException() { NumberDomainsExceededException numberDomainsExceededException = new NumberDomainsExceededException( "Invalid domain number"); DataAccessException dataAccessException = translator .translateExceptionIfPossible(numberDomainsExceededException); assertThat(dataAccessException, is(instanceOf(DataIntegrityViolationException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Invalid domain number")); }
@Test public void translateExceptionIfPossible_should_translate_InvalidNextTokenException_into_InvalidDataAccessApiUsageException() { InvalidNextTokenException invalidNextTokenException = new InvalidNextTokenException("Invalid Token"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(invalidNextTokenException); assertThat(dataAccessException, is(instanceOf(InvalidDataAccessApiUsageException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Invalid Token")); }
@Test public void translateExceptionIfPossible_should_translate_AmazonServiceException_into_DataAccessResourceFailureException() { AmazonServiceException amazonServiceException = new AmazonServiceException("Amazon internal exception"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(amazonServiceException); assertThat(dataAccessException, is(instanceOf(DataAccessResourceFailureException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Amazon internal exception")); }
@Test public void translateExceptionIfPossible_should_translate_AmazonClientException_into_UncategorizedSpringDaoException() { AmazonClientException amazonClientException = new AmazonClientException("Amazon internal client exception"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(amazonClientException); assertThat(dataAccessException, is(instanceOf(UncategorizedSpringDaoException.class))); assertThat(dataAccessException, is(notNullValue())); assertThat(dataAccessException.getLocalizedMessage(), StringContains.containsString("Amazon internal client exception")); }
@Test public void translateExceptionIfPossible_should_not_interpret_non_translated_exception_like_mapping_exceptions() { MappingException mappingException = new MappingException("Invalid Query"); DataAccessException dataAccessException = translator.translateExceptionIfPossible(mappingException); assertThat(dataAccessException, is(nullValue())); } |
AlphanumStringComparator implements Comparator<String> { @Override public int compare(String s1, String s2) { int c = 0; Matcher m1 = prefixRexp.matcher(s1); Matcher m2 = prefixRexp.matcher(s2); if (m1.find() && m2.find()) { Integer i1 = Integer.valueOf(m1.group(1)); Integer i2 = Integer.valueOf(m2.group(1)); c = i1.compareTo(i2); } else { throw new IllegalArgumentException("Can not compare strings missing 'digit@' pattern"); } return c; } @Override int compare(String s1, String s2); } | @Test public void should_correctly_compare_alphanumerical_strings() throws Exception { AlphanumStringComparator comparator = new AlphanumStringComparator(); assertTrue(comparator.compare("10@foo", "2@foo") > 0); assertTrue(comparator.compare("2@foo", "10@foo") < 0); assertTrue(comparator.compare("10@foo", "10@foo") == 0); } |
MapUtils { public static List<Map<String, List<String>>> splitToChunksOfSize(Map<String, List<String>> rawMap, int chunkSize) { List<Map<String, List<String>>> mapChunks = new LinkedList<Map<String, List<String>>>(); Set<Map.Entry<String, List<String>>> rawEntries = rawMap.entrySet(); Map<String, List<String>> currentChunk = new LinkedHashMap<String, List<String>>(); int rawEntryIndex = 0; for(Map.Entry<String, List<String>> rawEntry : rawEntries) { if(rawEntryIndex % chunkSize == 0) { if(currentChunk.size() > 0) { mapChunks.add(currentChunk); } currentChunk = new LinkedHashMap<String, List<String>>(); } currentChunk.put(rawEntry.getKey(), rawEntry.getValue()); rawEntryIndex++; if(rawEntryIndex == rawMap.size()) { mapChunks.add(currentChunk); } } return mapChunks; } private MapUtils(); static List<Map<String, List<String>>> splitToChunksOfSize(Map<String, List<String>> rawMap, int chunkSize); } | @Test public void splitToChunksOfSize_should_split_entries_exceeding_size() throws Exception { Map<String, List<String>> attributes = new LinkedHashMap<String, List<String>>(); for(int i = 0; i < SAMPLE_MAP_SIZE + 100; i++) { List<String> list = new ArrayList<String>(); list.add("Value: " + i); attributes.put("Key: " + i, list); } List<Map<String, List<String>>> chunks = MapUtils.splitToChunksOfSize(attributes, SAMPLE_MAP_SIZE); assertEquals(2, chunks.size()); Map<String, List<String>> firstChunk = chunks.get(0); assertEquals(SAMPLE_MAP_SIZE, firstChunk.size()); Map<String, List<String>> secondChunk = chunks.get(1); assertEquals(100, secondChunk.size()); assertTrue(secondChunk.containsKey("Key: " + 256)); assertTrue(secondChunk.containsKey("Key: " + 355)); } |
PartTreeConverter { public static String toIndexedQuery(final PartTree tree) { final StringBuilder result = new StringBuilder(); final Iterator<OrPart> orIt = tree.iterator(); while(orIt.hasNext()) { final OrPart orPart = orIt.next(); final Iterator<Part> partIt = orPart.iterator(); while(partIt.hasNext()) { final Part part = partIt.next(); result.append(" " + part.getProperty().getSegment() + " "); result.append(convertOperator(part.getType())); if(partIt.hasNext()) { result.append(" AND "); } } if(orIt.hasNext()) { result.append(" OR "); } } return StringUtil.removeExtraSpaces(result.toString()); } private PartTreeConverter(); static String toIndexedQuery(final PartTree tree); } | @Test public void should_create_corect_query_for_simple_property() { final String methodName = "findByItemName"; final PartTree tree = new PartTree(methodName, SimpleDbSampleEntity.class); final String query = PartTreeConverter.toIndexedQuery(tree); final String expected = " itemName = ? "; assertEquals(expected, query); }
@Test public void should_create_corect_query_for_between() { final String methodName = "readByAgeBetween"; final PartTree tree = new PartTree(methodName, SimpleDbSampleEntity.class); final String query = PartTreeConverter.toIndexedQuery(tree); final String expected = " age BETWEEN ? and ? "; assertEquals(expected, query); }
@Test public void should_create_corect_query_for_complex_operators() { final String methodName = "getByItemNameLikeOrAgeGreaterThanAndAgeLessThan"; final PartTree tree = new PartTree(methodName, SimpleDbSampleEntity.class); final String query = PartTreeConverter.toIndexedQuery(tree); final String expected = " itemName LIKE ? OR age > ? AND age < ? "; assertEquals(expected, query); }
@Test(expected = MappingException.class) public void shoud_fail_for_unsupported_operator() { final String methodName = "readByAgeEndsWith"; final PartTree tree = new PartTree(methodName, SimpleDbSampleEntity.class); PartTreeConverter.toIndexedQuery(tree); } |
SimpleDbRepositoryQuery implements RepositoryQuery { void assertNotHavingNestedQueryParameters(String query) { List<String> attributesFromQuery = QueryUtils.getQueryPartialFieldNames(query); final Class<?> domainClass = method.getDomainClazz(); for(String attribute : attributesFromQuery) { try { Field field = ReflectionUtils.getDeclaredFieldInHierarchy(domainClass, attribute); if(FieldTypeIdentifier.isOfType(field, FieldType.NESTED_ENTITY)) { throw new IllegalArgumentException("Invalid query parameter :" + attribute + " is nested object"); } } catch(NoSuchFieldException e) { } } } SimpleDbRepositoryQuery(SimpleDbQueryMethod method, SimpleDbOperations simpledbOperations); @Override Object execute(Object[] parameters); @Override QueryMethod getQueryMethod(); static RepositoryQuery fromQueryAnnotation(SimpleDbQueryMethod queryMethod,
SimpleDbOperations simpleDbOperations); } | @SuppressWarnings({ "rawtypes", "unchecked" }) @Test(expected = IllegalArgumentException.class) public void assertNotHavingNestedQueryParameters_should_fail_for_nested_attributes() { SimpleDbQueryMethod method = Mockito.mock(SimpleDbQueryMethod.class); Mockito.when(method.getDomainClazz()).thenReturn((Class) SampleEntity.class); SimpleDbRepositoryQuery repositoryQuery = new SimpleDbRepositoryQuery(method, null); repositoryQuery.assertNotHavingNestedQueryParameters("select sampleNestedAttribute from SampleEntity"); } |
SimpleDbQueryRunner { public Object executeSingleResultQuery() { List<?> returnListFromDb = executeQuery(); return getSingleResult(returnListFromDb); } SimpleDbQueryRunner(SimpleDbOperations simpledbOperations, Class<?> domainClass, String query); SimpleDbQueryRunner(SimpleDbOperations simpledbOperations, Class<?> domainClass, String query,
Pageable pageable); List<?> executeQuery(); Object executeSingleResultQuery(); long executeCount(); List<String> getRequestedQueryFieldNames(); String getSingleQueryFieldName(); Page<?> executePagedQuery(); } | @Test(expected = IllegalArgumentException.class) public void executeSingleResultQuery_should_fail_if_multiple_results_are_retrieved() { SimpleDbOperations simpleDbOperations = Mockito.mock(SimpleDbOperations.class); List<SampleEntity> sampleMultipleResults = new ArrayList<SampleEntity>(); sampleMultipleResults.add(new SampleEntity()); sampleMultipleResults.add(new SampleEntity()); Mockito.when(simpleDbOperations.find(Mockito.same(SampleEntity.class), Mockito.anyString())).thenReturn( sampleMultipleResults); SimpleDbQueryRunner runner = new SimpleDbQueryRunner((SimpleDbOperations) simpleDbOperations, SampleEntity.class, null); runner.executeSingleResultQuery(); } |
SimpleDbQueryRunner { Object getSingleResult(List<?> returnListFromDb) { Assert.isTrue(returnListFromDb.size() <= 1, "Select statement should return only one entity from database, returned elements size=" + returnListFromDb.size() + ", for Query=" + query); return returnListFromDb.size() > 0 ? returnListFromDb.get(0) : null; } SimpleDbQueryRunner(SimpleDbOperations simpledbOperations, Class<?> domainClass, String query); SimpleDbQueryRunner(SimpleDbOperations simpledbOperations, Class<?> domainClass, String query,
Pageable pageable); List<?> executeQuery(); Object executeSingleResultQuery(); long executeCount(); List<String> getRequestedQueryFieldNames(); String getSingleQueryFieldName(); Page<?> executePagedQuery(); } | @Test public void getSingleResult_should_return_null_for_empty_list() { SimpleDbQueryRunner runner = new SimpleDbQueryRunner(null, SampleEntity.class, null); final Object result = runner.getSingleResult(new ArrayList<SampleEntity>()); assertNull(result); }
@Test public void getSingleResult_should_return_single_value_from_list_with_one_element() { SimpleDbQueryRunner runner = new SimpleDbQueryRunner(null, SampleEntity.class, null); final ArrayList<SampleEntity> results = new ArrayList<SampleEntity>(); results.add(new SampleEntity()); final Object result = runner.getSingleResult(results); assertNotNull(result); }
@Test(expected = IllegalArgumentException.class) public void getSingleResult_should_fail_for_list_with_multiple_elements() { SimpleDbQueryRunner runner = new SimpleDbQueryRunner(null, SampleEntity.class, null); final ArrayList<SampleEntity> results = new ArrayList<SampleEntity>(); results.add(new SampleEntity()); results.add(new SampleEntity()); runner.getSingleResult(results); } |
SimpleDbResultConverter { public static List<Object> filterNamedAttributesAsList(List<?> domainObjects, String attributeName) { List<Object> ret = new ArrayList<Object>(); for(Object object : domainObjects) { ret.add(ReflectionUtils.callGetter(object, attributeName)); } return ret; } private SimpleDbResultConverter(); static List<Object> filterNamedAttributesAsList(List<?> domainObjects, String attributeName); static Set<Object> filterNamedAttributesAsSet(List<?> domainObjects, String attributeName); static List<List<Object>> toListOfListOfObject(List<?> entityList, List<String> requestedQueryFieldNames); } | @Test public void filterNamedAttributesAsList_should_return_list_of_named_attributes() throws Exception { List<SampleEntity> entities = new ArrayList<SampleEntity>(); SampleEntity entity = new SampleEntity(); entity.setSampleAttribute(SAMPLE_INT_VALUE); entities.add(entity); List<Object> filteredAttributes = SimpleDbResultConverter.filterNamedAttributesAsList(entities, "sampleAttribute"); assertEquals(1, filteredAttributes.size()); Object firstElement = filteredAttributes.get(0); assertEquals(SAMPLE_INT_VALUE, firstElement); }
@Test public void filterNamedAttributesAsList_should_work_for_list_attributes() throws Exception { List<SampleEntity> entities = new ArrayList<SampleEntity>(); SampleEntity entity = new SampleEntity(); entity.setSampleList(new ArrayList<Integer>()); entities.add(entity); List<Object> filteredAttributes = SimpleDbResultConverter.filterNamedAttributesAsList(entities, "sampleList"); assertEquals(1, filteredAttributes.size()); Object firstElement = filteredAttributes.get(0); assertTrue(firstElement instanceof List); }
@Test(expected = MappingException.class) public void filterNamedAttributesAsList_should_not_return_list_of_named_attributes_for_wrong_att() throws Exception { List<SampleEntity> entities = new ArrayList<SampleEntity>(); SampleEntity entity = new SampleEntity(); entities.add(entity); SimpleDbResultConverter.filterNamedAttributesAsList(entities, "wrongAttribute"); } |
SimpleDbResultConverter { public static Set<Object> filterNamedAttributesAsSet(List<?> domainObjects, String attributeName) { Set<Object> ret = new LinkedHashSet<Object>(); for(Object object : domainObjects) { ret.add(ReflectionUtils.callGetter(object, attributeName)); } return ret; } private SimpleDbResultConverter(); static List<Object> filterNamedAttributesAsList(List<?> domainObjects, String attributeName); static Set<Object> filterNamedAttributesAsSet(List<?> domainObjects, String attributeName); static List<List<Object>> toListOfListOfObject(List<?> entityList, List<String> requestedQueryFieldNames); } | @Test public void filterNamedAttributesAsSet_should_return_Set_of_named_attributes() throws Exception { List<SampleEntity> entities = new ArrayList<SampleEntity>(); SampleEntity entity = new SampleEntity(); entity.setSampleAttribute(SAMPLE_INT_VALUE); entities.add(entity); Set<Object> filteredAttributes = SimpleDbResultConverter .filterNamedAttributesAsSet(entities, "sampleAttribute"); assertEquals(1, filteredAttributes.size()); Object firstElement = filteredAttributes.iterator().next(); assertEquals(SAMPLE_INT_VALUE, firstElement); } |
SimpleDbResultConverter { public static List<List<Object>> toListOfListOfObject(List<?> entityList, List<String> requestedQueryFieldNames) { if(entityList.size() > 0) { List<List<Object>> rows = new ArrayList<List<Object>>(); for(Object entity : entityList) { List<Object> cols = new ArrayList<Object>(); for(String fieldName : requestedQueryFieldNames) { Object value = ReflectionUtils.callGetter(entity, fieldName); cols.add(value); } rows.add(cols); } return rows; } else { return Collections.emptyList(); } } private SimpleDbResultConverter(); static List<Object> filterNamedAttributesAsList(List<?> domainObjects, String attributeName); static Set<Object> filterNamedAttributesAsSet(List<?> domainObjects, String attributeName); static List<List<Object>> toListOfListOfObject(List<?> entityList, List<String> requestedQueryFieldNames); } | @Test public void toListOfListOfObject_should_return_List_of_Lists_containing_requested_attributes() { List<SampleEntity> entities = new ArrayList<SampleEntity>(); SampleEntity entity = new SampleEntity(); entity.setSampleAttribute(SAMPLE_INT_VALUE); entity.setSampleList(new ArrayList<Integer>()); entities.add(entity); List<String> attributes = Arrays.asList("sampleAttribute", "sampleList"); List<List<Object>> filteredAttributes = SimpleDbResultConverter.toListOfListOfObject(entities, attributes); assertEquals(1, filteredAttributes.size()); List<Object> columns = filteredAttributes.get(0); assertEquals(2, columns.size()); assertEquals(SAMPLE_INT_VALUE, columns.get(0)); } |
MultipleResultExecution extends AbstractSimpleDbQueryExecution { MultipleResultType detectResultType(SimpleDbQueryMethod method) { String query = method.getAnnotatedQuery(); if(method.returnsCollectionOfDomainClass()) { return MultipleResultType.COLLECTION_OF_DOMAIN_ENTITIES; } else if(QueryUtils.getQueryPartialFieldNames(query).size() > 1) { return MultipleResultType.LIST_OF_LIST_OF_OBJECT; } else { if(method.returnsListOfListOfObject()) { return MultipleResultType.LIST_OF_LIST_OF_OBJECT; } else if(method.returnsFieldOfTypeCollection()) { return MultipleResultType.FIELD_OF_TYPE_COLLECTION; } else if(List.class.isAssignableFrom(method.getReturnType())) { return MultipleResultType.LIST_OF_FIELDS; } else if(Set.class.isAssignableFrom(method.getReturnType())) { return MultipleResultType.SET_OF_FIELDS; } else { throw new IllegalArgumentException("Wrong return type for query: " + query); } } } MultipleResultExecution(SimpleDbOperations simpledbOperations); } | @Test public void detectResultType_should_return_COLLECTION_OF_DOMAIN_ENTITIES() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("selectAll", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.COLLECTION_OF_DOMAIN_ENTITIES, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_for_selected_field_should_return_COLLECTION_OF_DOMAIN_ENTITIES() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("partialSampleListSelect", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.COLLECTION_OF_DOMAIN_ENTITIES, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_should_return_LIST_OF_LIST_OF_OBJECT() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("selectCoreFields", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.LIST_OF_LIST_OF_OBJECT, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_for_multiple_selected_attributes_should_return_LIST_OF_LIST_OF_OBJECT() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("selectFields", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.LIST_OF_LIST_OF_OBJECT, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_should_return_FIELD_OF_TYPE_COLLECTION() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("sampleListSelect", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.FIELD_OF_TYPE_COLLECTION, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_should_return_LIST_OF_FIELDS() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("sampleAllSampleListSelect", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.LIST_OF_FIELDS, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_should_return_SET_OF_FIELDS() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("sampleAllSampleListSelectInSet", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.SET_OF_FIELDS, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test public void detectResultType_should_return_FIELD_OF_TYPE_COLLECTION_of_list_of_lists() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("listOfListOfIntegerFieldSelect", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); assertEquals(MultipleResultExecution.MultipleResultType.FIELD_OF_TYPE_COLLECTION, multipleResultExecution.detectResultType(repositoryMethod)); }
@Test(expected = IllegalArgumentException.class) public void detectResultType_should_return_error_for_inexisting_field() throws Exception { SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("sampleWrongField", SampleEntity.class); MultipleResultExecution multipleResultExecution = new MultipleResultExecution(null); multipleResultExecution.detectResultType(repositoryMethod); } |
PagedResultExecution extends AbstractSimpleDbQueryExecution { @Override protected Object doExecute(SimpleDbQueryMethod queryMethod, SimpleDbQueryRunner queryRunner) { final Page<?> pagedResult = queryRunner.executePagedQuery(); if(queryMethod.isPageQuery()) { return pagedResult; } return pagedResult.getContent(); } PagedResultExecution(SimpleDbOperations simpleDbOperations); } | @Test @SuppressWarnings({ "rawtypes", "unchecked" }) public void doExecute_should_return_Page_type() throws Exception { final SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("selectAllIntoPage", SampleEntity.class); final PagedResultExecution execution = new PagedResultExecution(null); final SimpleDbQueryRunner queryRunner = Mockito.mock(SimpleDbQueryRunner.class); when(queryRunner.executePagedQuery()).thenReturn(new PageImpl(new ArrayList())); final Object result = execution.doExecute(repositoryMethod, queryRunner); assertTrue(Page.class.isAssignableFrom(result.getClass())); }
@Test @SuppressWarnings({ "rawtypes", "unchecked" }) public void doExecute_should_return_List_type() throws Exception { final SimpleDbQueryMethod repositoryMethod = prepareQueryMethodToTest("selectAllIntoList", SampleEntity.class); final PagedResultExecution execution = new PagedResultExecution(null); final SimpleDbQueryRunner queryRunner = Mockito.mock(SimpleDbQueryRunner.class); when(queryRunner.executePagedQuery()).thenReturn(new PageImpl(new ArrayList())); final Object result = execution.doExecute(repositoryMethod, queryRunner); assertTrue(List.class.isAssignableFrom(result.getClass())); } |
SimpleDBAttributeConverter { public static Object decodeToPrimitiveArray(List<String> fromSimpleDbAttValues, Class<?> retType) throws ParseException { Object primitiveCollection = Array.newInstance(retType, fromSimpleDbAttValues.size()); int idx = 0; for(Iterator<String> iterator = fromSimpleDbAttValues.iterator(); iterator.hasNext(); idx++) { Array.set(primitiveCollection, idx, decodeToFieldOfType(iterator.next(), retType)); } return primitiveCollection; } private SimpleDBAttributeConverter(); static String encode(Object ob); static List<String> encodeArray(final Object arrayValues); static Object decodeToFieldOfType(String value, Class<?> retType); static Object decodeToPrimitiveArray(List<String> fromSimpleDbAttValues, Class<?> retType); } | @Test public void toSimpleDBAttributeValues_should_return_an_string_representation_of_concatenated_array_elements() throws ParseException { final int[] expectedIntArray = { 1, 2, 3, 4 }; final List<String> simpleDBValues = Arrays.asList("1", "2", "3", "4"); Object returnedPrimitiveCol = SimpleDBAttributeConverter.decodeToPrimitiveArray(simpleDBValues, int.class); int arrayLength = Array.getLength(returnedPrimitiveCol); for(int idx = 0; idx < arrayLength; idx++) { assertEquals(expectedIntArray[idx], Array.get(returnedPrimitiveCol, idx)); } } |
SimpleDbAttributeValueSplitter { public static Map<String, List<String>> splitAttributeValuesWithExceedingLengths(Map<String, String> rawAttributes) { Map<String, List<String>> splitAttributes = new LinkedHashMap<String, List<String>>(); Set<Map.Entry<String, String>> rawEntries = rawAttributes.entrySet(); for(Map.Entry<String, String> rawEntry : rawEntries) { splitAttributes.put(rawEntry.getKey(), new ArrayList<String>()); if(rawEntry.getValue().length() > MAX_ATTR_VALUE_LEN) { splitAttributes.get(rawEntry.getKey()).addAll(splitExceedingValue(rawEntry.getValue())); } else { splitAttributes.get(rawEntry.getKey()).add(rawEntry.getValue()); } } return splitAttributes; } private SimpleDbAttributeValueSplitter(); static Map<String, List<String>> splitAttributeValuesWithExceedingLengths(Map<String, String> rawAttributes); static Map<String, String> combineAttributeValuesWithExceedingLengths(Map<String, List<String>> multiValueAttributes); static final int MAX_ATTR_VALUE_LEN; } | @Test public void splitAttributeValuesWithExceedingLengths_should_detect_long_attributes() throws Exception { Map<String, String> rawAttributes = new LinkedHashMap<String, String>(); rawAttributes.put(SAMPLE_ATT_NAME, STRING_OF_MAX_SIMPLE_DB_LENGTH + "c"); Map<String, List<String>> splitAttributes = SimpleDbAttributeValueSplitter .splitAttributeValuesWithExceedingLengths(rawAttributes); assertEquals("count(keys) == 1", 1, splitAttributes.keySet().size()); Iterator<List<String>> iterator = splitAttributes.values().iterator(); List<String> next = null; if (iterator.hasNext()) { next = iterator.next(); } assertNotNull(next); assertEquals("count(values) == 2", 2, next.size()); }
@Test public void splitAttributeValuesWithExceedingLengths_should_not_split_short_attributes() throws Exception { Map<String, String> rawAttributes = new LinkedHashMap<String, String>(); rawAttributes.put(SAMPLE_ATT_NAME, "shortValue"); Map<String, List<String>> splitAttributes = SimpleDbAttributeValueSplitter .splitAttributeValuesWithExceedingLengths(rawAttributes); assertEquals(1, splitAttributes.keySet().size()); List<String> firstSplitAttribute = splitAttributes.values().iterator().next(); assertEquals("shortValue", firstSplitAttribute.get(0)); } |
QueryBuilder { @Override public String toString() { String result = query.toString(); LOGGER.debug("Created query: {}", result); return result; } QueryBuilder(SimpleDbEntityInformation<?, ?> entityInformation); QueryBuilder(SimpleDbEntityInformation<?, ?> entityInformation, boolean shouldCount); QueryBuilder(String customQuery); QueryBuilder(String customQuery, boolean shouldCount); QueryBuilder withLimit(final int limit); QueryBuilder withIds(Iterable<?> iterable); QueryBuilder with(Sort sort); QueryBuilder with(Pageable pageable); @Override String toString(); } | @Test public void should_create_correct_queries_if_no_other_clauses_are_specified() throws Exception { QueryBuilder builder = new QueryBuilder(SimpleDbSampleEntity.entityInformation()); String returnedQuery = builder.toString(); assertEquals("select * from `simpleDbSampleEntity`", returnedQuery); }
@Test public void should_include_count_clause_if_requested() throws Exception { QueryBuilder builder = new QueryBuilder(SimpleDbSampleEntity.entityInformation(), true); String returnedQuery = builder.toString(); assertThat(returnedQuery, containsString("select count(*) from")); } |
EntityWrapper { public Map<String, String> serialize() { return serialize(""); } EntityWrapper(SimpleDbEntityInformation<T, ?> entityInformation, T item); EntityWrapper(SimpleDbEntityInformation<T, ?> entityInformation, T item, boolean isNested); EntityWrapper(SimpleDbEntityInformation<T, ?> entityInformation); EntityWrapper(SimpleDbEntityInformation<T, ?> entityInformation, boolean isNested); String getDomain(); String getItemName(); Map<String, String> getAttributes(); T getItem(); void generateIdIfNotSet(); void setId(String itemName); Map<String, String> serialize(); Object deserialize(final Map<String, String> attributes); Map<String, List<String>> toMultiValueAttributes(); } | @Test public void test_getSerializedPrimitiveAttributes() throws ParseException { final SampleEntity entity = new SampleEntity(); entity.setIntField(11); entity.setLongField(123); entity.setShortField((short) -12); entity.setFloatField(-0.01f); entity.setDoubleField(1.2d); entity.setByteField((byte) 1); entity.setBooleanField(Boolean.TRUE); entity.setStringField("string"); entity.setDoubleWrapper(Double.valueOf("2323.32d")); EntityWrapper<SampleEntity, String> sdbEntity = new EntityWrapper<SampleEntity, String>( EntityInformationSupport.readEntityInformation(SampleEntity.class), entity); assertNotNull(sdbEntity); final Map<String, String> attributes = sdbEntity.serialize(); assertNotNull(attributes); String intValues = attributes.get("intField"); assertNotNull(intValues); assertEquals(entity.getIntField(), ((Integer) SimpleDBAttributeConverter.decodeToFieldOfType(intValues, Integer.class)).intValue()); String longValues = attributes.get("longField"); assertEquals(entity.getLongField(), ((Long) SimpleDBAttributeConverter.decodeToFieldOfType(longValues, Long.class)).longValue()); String shortValues = attributes.get("shortField"); assertEquals(entity.getShortField(), ((Short) SimpleDBAttributeConverter.decodeToFieldOfType(shortValues, Short.class)).shortValue()); String floatValues = attributes.get("floatField"); assertTrue(entity.getFloatField() == ((Float) SimpleDBAttributeConverter.decodeToFieldOfType(floatValues, Float.class)).floatValue()); String doubleValues = attributes.get("doubleField"); assertTrue(entity.getDoubleField() == ((Double) SimpleDBAttributeConverter.decodeToFieldOfType(doubleValues, Double.class)).doubleValue()); String byteValues = attributes.get("byteField"); assertTrue(entity.getByteField() == ((Byte) SimpleDBAttributeConverter.decodeToFieldOfType(byteValues, Byte.class)).byteValue()); String booleanValues = attributes.get("booleanField"); assertTrue(entity.getBooleanField() == ((Boolean) SimpleDBAttributeConverter.decodeToFieldOfType(booleanValues, Boolean.class)).booleanValue()); }
@Test public void should_generate_attribute_keys_for_nested_domain_fields() { final AClass aDomain = new AClass(); { aDomain.nestedB = new BClass(); { aDomain.nestedB.floatField = 21f; aDomain.nestedB.nestedNestedC = new CClass(); { aDomain.nestedB.nestedNestedC.doubleField = 14d; } } } EntityWrapper<AClass, String> sdbEntity = new EntityWrapper<AClass, String>( EntityInformationSupport.readEntityInformation(AClass.class), aDomain); final Map<String, String> attributes = sdbEntity.serialize(); assertNotNull(attributes); assertEquals(3, attributes.size()); final Set<String> keySet = attributes.keySet(); assertTrue(keySet.contains("intField")); assertTrue(keySet.contains("nestedB.floatField")); assertTrue(keySet.contains("nestedB.nestedNestedC.doubleField")); } |
DomainItemBuilder { public T populateDomainItem(SimpleDbEntityInformation<T, ?> entityInformation, Item item) { return buildDomainItem(entityInformation, item); } List<T> populateDomainItems(SimpleDbEntityInformation<T, ?> entityInformation, SelectResult selectResult); T populateDomainItem(SimpleDbEntityInformation<T, ?> entityInformation, Item item); } | @Test public void populateDomainItem_should_convert_item_name() { Item sampleItem = new Item(SAMPLE_ITEM_NAME, new ArrayList<Attribute>()); SimpleDbEntityInformation<SimpleDbSampleEntity, String> entityInformation = SimpleDbSampleEntity .entityInformation(); domainItemBuilder = new DomainItemBuilder<SimpleDbSampleEntity>(); SimpleDbSampleEntity returnedDomainEntity = domainItemBuilder.populateDomainItem(entityInformation, sampleItem); assertEquals(SAMPLE_ITEM_NAME, returnedDomainEntity.getItemName()); }
@Test public void populateDomainItem_should_convert_attributes() { List<Attribute> attributeList = new ArrayList<Attribute>(); attributeList.add(new Attribute("booleanField", "" + SAMPLE_BOOLEAN_ATT_VALUE)); Item sampleItem = new Item(SAMPLE_ITEM_NAME, attributeList); SimpleDbEntityInformation<SimpleDbSampleEntity, String> entityInformation = SimpleDbSampleEntity .entityInformation(); domainItemBuilder = new DomainItemBuilder<SimpleDbSampleEntity>(); SimpleDbSampleEntity returnedDomainEntity = domainItemBuilder.populateDomainItem(entityInformation, sampleItem); assertTrue(returnedDomainEntity.getBooleanField() == SAMPLE_BOOLEAN_ATT_VALUE); } |
Util { public static Map<String, String> objectToStringMap(Object object) { TypeReference<HashMap<String, String>> typeReference = new TypeReference<HashMap<String, String>>() {}; return objectMapper.convertValue(object, typeReference); } private Util(); static String getDefaultMusicFolder(); static String getDefaultPodcastFolder(); static String getDefaultPlaylistFolder(); static boolean isWindows(); static void setContentLength(HttpServletResponse response, long length); static List<T> subList(List<T> list, long offset, long max); static List<Integer> toIntegerList(int[] values); static int[] toIntArray(List<Integer> values); static String debugObject(Object object); static String getURLForRequest(HttpServletRequest request); static String getAnonymizedURLForRequest(HttpServletRequest request); static boolean isInstanceOfClassName(Object o, String className); static Map<String, String> objectToStringMap(Object object); static T stringMapToObject(Class<T> clazz, Map<String, String> data); static T stringMapToValidObject(Class<T> clazz, Map<String, String> data); } | @Test public void objectToStringMapNull() { MediaLibraryStatistics statistics = null; Map<String, String> stringStringMap = Util.objectToStringMap(statistics); assertNull(stringStringMap); }
@Test public void objectToStringMap() { Date date = new Date(1568350960725L); MediaLibraryStatistics statistics = new MediaLibraryStatistics(date); statistics.incrementAlbums(5); statistics.incrementSongs(4); statistics.incrementArtists(910823); statistics.incrementTotalDurationInSeconds(30); statistics.incrementTotalLengthInBytes(2930491082L); Map<String, String> stringStringMap = Util.objectToStringMap(statistics); assertEquals("5", stringStringMap.get("albumCount")); assertEquals("4", stringStringMap.get("songCount")); assertEquals("910823", stringStringMap.get("artistCount")); assertEquals("30", stringStringMap.get("totalDurationInSeconds")); assertEquals("2930491082", stringStringMap.get("totalLengthInBytes")); assertEquals("1568350960725", stringStringMap.get("scanDate")); } |
InternetRadioService { public List<InternetRadioSource> getInternetRadioSources(InternetRadio radio) { List<InternetRadioSource> sources; if (cachedSources.containsKey(radio.getId())) { LOG.debug("Got cached sources for internet radio {}!", radio.getStreamUrl()); sources = cachedSources.get(radio.getId()); } else { LOG.debug("Retrieving sources for internet radio {}...", radio.getStreamUrl()); try { sources = retrieveInternetRadioSources(radio); if (sources.isEmpty()) { LOG.warn("No entries found for internet radio {}.", radio.getStreamUrl()); } else { LOG.info("Retrieved playlist for internet radio {}, got {} sources.", radio.getStreamUrl(), sources.size()); } } catch (Exception e) { LOG.error("Failed to retrieve sources for internet radio {}.", radio.getStreamUrl(), e); sources = new ArrayList<>(); } cachedSources.put(radio.getId(), sources); } return sources; } InternetRadioService(); void clearInternetRadioSourceCache(); void clearInternetRadioSourceCache(Integer internetRadioId); List<InternetRadioSource> getInternetRadioSources(InternetRadio radio); } | @Test public void testRedirectLoop() { List<InternetRadioSource> radioSources = internetRadioService.getInternetRadioSources(radioMoveLoop); Assert.assertEquals(0, radioSources.size()); }
@Test public void testParseSimplePlaylist() { List<InternetRadioSource> radioSources = internetRadioService.getInternetRadioSources(radio1); Assert.assertEquals(2, radioSources.size()); Assert.assertEquals(TEST_STREAM_URL_1, radioSources.get(0).getStreamUrl()); Assert.assertEquals(TEST_STREAM_URL_2, radioSources.get(1).getStreamUrl()); }
@Test public void testRedirects() { List<InternetRadioSource> radioSources = internetRadioService.getInternetRadioSources(radioMove); Assert.assertEquals(2, radioSources.size()); Assert.assertEquals(TEST_STREAM_URL_3, radioSources.get(0).getStreamUrl()); Assert.assertEquals(TEST_STREAM_URL_4, radioSources.get(1).getStreamUrl()); }
@Test public void testLargeInput() { List<InternetRadioSource> radioSources = internetRadioService.getInternetRadioSources(radioLarge); Assert.assertEquals(250, radioSources.size()); }
@Test public void testLargeInputURL() { List<InternetRadioSource> radioSources = internetRadioService.getInternetRadioSources(radioLarge2); Assert.assertEquals(1, radioSources.size()); } |
Util { public static <T> T stringMapToObject(Class<T> clazz, Map<String, String> data) { return objectMapper.convertValue(data, clazz); } private Util(); static String getDefaultMusicFolder(); static String getDefaultPodcastFolder(); static String getDefaultPlaylistFolder(); static boolean isWindows(); static void setContentLength(HttpServletResponse response, long length); static List<T> subList(List<T> list, long offset, long max); static List<Integer> toIntegerList(int[] values); static int[] toIntArray(List<Integer> values); static String debugObject(Object object); static String getURLForRequest(HttpServletRequest request); static String getAnonymizedURLForRequest(HttpServletRequest request); static boolean isInstanceOfClassName(Object o, String className); static Map<String, String> objectToStringMap(Object object); static T stringMapToObject(Class<T> clazz, Map<String, String> data); static T stringMapToValidObject(Class<T> clazz, Map<String, String> data); } | @Test public void stringMapToObject() { Map<String, String> stringStringMap = new HashMap<>(); stringStringMap.put("albumCount", "5"); stringStringMap.put("songCount", "4"); stringStringMap.put("artistCount", "910823"); stringStringMap.put("totalDurationInSeconds", "30"); stringStringMap.put("totalLengthInBytes", "2930491082"); stringStringMap.put("scanDate", "1568350960725"); MediaLibraryStatistics statistics = Util.stringMapToObject(MediaLibraryStatistics.class, stringStringMap); assertEquals(new Integer(5), statistics.getAlbumCount()); assertEquals(new Integer(4), statistics.getSongCount()); assertEquals(new Integer(910823), statistics.getArtistCount()); assertEquals(new Long(30L), statistics.getTotalDurationInSeconds()); assertEquals(new Long(2930491082L), statistics.getTotalLengthInBytes()); assertEquals(new Date(1568350960725L), statistics.getScanDate()); }
@Test public void stringMapToObjectWithExtraneousData() { Map<String, String> stringStringMap = new HashMap<>(); stringStringMap.put("albumCount", "5"); stringStringMap.put("songCount", "4"); stringStringMap.put("artistCount", "910823"); stringStringMap.put("totalDurationInSeconds", "30"); stringStringMap.put("totalLengthInBytes", "2930491082"); stringStringMap.put("scanDate", "1568350960725"); stringStringMap.put("extraneousData", "nothingHereToLookAt"); MediaLibraryStatistics statistics = Util.stringMapToObject(MediaLibraryStatistics.class, stringStringMap); assertEquals(new Integer(5), statistics.getAlbumCount()); assertEquals(new Integer(4), statistics.getSongCount()); assertEquals(new Integer(910823), statistics.getArtistCount()); assertEquals(new Long(30L), statistics.getTotalDurationInSeconds()); assertEquals(new Long(2930491082L), statistics.getTotalLengthInBytes()); assertEquals(new Date(1568350960725L), statistics.getScanDate()); } |
Util { public static <T> T stringMapToValidObject(Class<T> clazz, Map<String, String> data) { T object = stringMapToObject(clazz, data); Set<ConstraintViolation<T>> validate = validator.validate(object); if (validate.isEmpty()) { return object; } else { throw new IllegalArgumentException("Created object was not valid"); } } private Util(); static String getDefaultMusicFolder(); static String getDefaultPodcastFolder(); static String getDefaultPlaylistFolder(); static boolean isWindows(); static void setContentLength(HttpServletResponse response, long length); static List<T> subList(List<T> list, long offset, long max); static List<Integer> toIntegerList(int[] values); static int[] toIntArray(List<Integer> values); static String debugObject(Object object); static String getURLForRequest(HttpServletRequest request); static String getAnonymizedURLForRequest(HttpServletRequest request); static boolean isInstanceOfClassName(Object o, String className); static Map<String, String> objectToStringMap(Object object); static T stringMapToObject(Class<T> clazz, Map<String, String> data); static T stringMapToValidObject(Class<T> clazz, Map<String, String> data); } | @Test(expected = IllegalArgumentException.class) public void stringMapToValidObjectWithNoData() { Map<String, String> stringStringMap = new HashMap<>(); MediaLibraryStatistics statistics = Util.stringMapToValidObject(MediaLibraryStatistics.class, stringStringMap); } |
JWTSecurityService { public String addJWTToken(String uri) { return addJWTToken(UriComponentsBuilder.fromUriString(uri)).build().toString(); } @Autowired JWTSecurityService(SettingsService settingsService); static String generateKey(); static Algorithm getAlgorithm(String jwtKey); String addJWTToken(String uri); UriComponentsBuilder addJWTToken(UriComponentsBuilder builder); UriComponentsBuilder addJWTToken(UriComponentsBuilder builder, Date expires); static DecodedJWT verify(String jwtKey, String token); DecodedJWT verify(String credentials); static final String JWT_PARAM_NAME; static final String CLAIM_PATH; static final int DEFAULT_DAYS_VALID_FOR; } | @Test public void addJWTToken() { UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(uriString); String actualUri = service.addJWTToken(builder).build().toUriString(); String jwtToken = UriComponentsBuilder.fromUriString(actualUri).build().getQueryParams().getFirst( JWTSecurityService.JWT_PARAM_NAME); DecodedJWT verify = verifier.verify(jwtToken); Claim claim = verify.getClaim(JWTSecurityService.CLAIM_PATH); assertEquals(expectedClaimString, claim.asString()); } |
CsarController { @ApiOperation( value = "List all CSARs stored on the server", notes = "Returns a Hypermedia Resource containing all CSARs" + " that have been uploaded to the server and did not get removed", response = CsarResources.class, produces = "application/hal+json" ) @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) public ResponseEntity<Resources<CsarResponse>> listCSARs() { Link selfLink = linkTo(methodOn(CsarController.class).listCSARs()).withSelfRel(); List<CsarResponse> responses = new ArrayList<>(); for (Csar csar : csarService.getCsars()) { responses.add(new CsarResponse(csar.getIdentifier(), csar.getLifecyclePhases())); } Resources<CsarResponse> csarResources = new HiddenResources<>(responses, selfLink); return ResponseEntity.ok().body(csarResources); } @Autowired CsarController(CsarService csarService); @ApiOperation( value = "List all CSARs stored on the server", notes = "Returns a Hypermedia Resource containing all CSARs" + " that have been uploaded to the server and did not get removed", response = CsarResources.class, produces = "application/hal+json" ) @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) ResponseEntity<Resources<CsarResponse>> listCSARs(); @ApiOperation( value = "Returns details for a specific name (identifier)", notes = "Returns the element with the given name, Object contents are " + "equal to a regular /csars request (if you just look at the desired entry)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The Csar was found and the contents are found in the body", response = CsarResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given name (identifier)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{name}", method = RequestMethod.GET, produces = "application/hal+json" ) ResponseEntity<CsarResponse> getCSARInfo(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "name") String name
); @ApiOperation( value = "Creates a new CSAR", notes = "This operation creates a new CSAR if the name (identifier) is not used already. " + "The uploaded file has to be a valid CSAR archive. " + "Once the file was uploaded the server will synchronously " + "(the client has to wait for the response) unzip the archive and parse it. " + "Upload gets performed using Multipart Form upload.", code = 201 ) @ApiResponses({ @ApiResponse( code = 201, message = "The upload of the csar was successful", response = Void.class ), @ApiResponse( code = 406, message = "CSAR upload rejected - given ID already in use", response = Void.class ), @ApiResponse( code = 500, message = "The server encountered a unexpected problem", response = Void.class ) }) @RequestMapping( path = "/{name}", method = {RequestMethod.PUT, RequestMethod.POST}, produces = "application/hal+json" ) ResponseEntity<Void> uploadCSAR(
@ApiParam(value = "The unique identifier for the CSAR", required = true)
@PathVariable(name = "name") String name,
@ApiParam(value = "The CSAR Archive (Compressed as ZIP)", required = true)
@RequestParam(name = "file", required = true) MultipartFile file
// HttpServletRequest request
); @ApiOperation( value = "Deletes a Existing CSAR", notes = "Deletes the Resulting CSAR and its transformations (if none of them is running). " + "If a transformation is running (in the state TRANSFORMING) the CSAR cannot be deleted" ) @ApiResponses({ @ApiResponse( code = 200, message = "The deletion of the CSAR was successful", response = Void.class ), @ApiResponse( code = 400, message = "The deletion of the CSAR failed, because there is one or more transformations still running.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given name (identifier)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{name}/delete", method = {RequestMethod.DELETE}, produces = "application/hal+json" ) ResponseEntity<Void> deleteCsar(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "my-csar-name")
@PathVariable("name") String name
); @RequestMapping( path = "/{name}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs of a csar", tags = {"csars"}, notes = "Returns the logs for a csar, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "name") String csarId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); } | @Test public void listCsars() throws Exception { ResultActions resultActions = mvc.perform( get(LIST_CSARS_URL).accept(ACCEPTED_MIME_TYPE) ).andDo(print()).andExpect(status().is2xxSuccessful()); resultActions.andExpect(jsonPath("$.links[0].rel").value("self")); resultActions.andExpect(jsonPath("$.links[0].href").value(LIST_CSARS_SELF_URL)); resultActions.andExpect(jsonPath("$.content").exists()); resultActions.andExpect(jsonPath("$.content").isArray()); resultActions.andExpect(jsonPath("$.content[2]").doesNotExist()); resultActions.andReturn(); } |
ReadmeBuilder { @Override public String toString() { Parser markdownParser = Parser.builder().build(); Node markdownDocument = markdownParser.parse(this.markdownText); HtmlRenderer renderer = HtmlRenderer.builder().build(); return TEMPLATE.replace(README_TEMPLATE_TITLE_KEY, this.pageTitle) .replace(README_TEMPLATE_BODY_KEY, renderer.render(markdownDocument)); } ReadmeBuilder(String markdownText, String pageTitle); static ReadmeBuilder fromMarkdownResource(String title, String path, TransformationContext context); @Override String toString(); } | @Test public void testBuilderWithMarkdownString() { logger.info("Initilaizing Readme Builder"); ReadmeBuilder builder = new ReadmeBuilder("# Hello World", "Hello"); logger.info("Rendering"); String result = builder.toString(); logger.info("Rendered: {}", result); assertTrue(result.contains("<h1>Hello World</h1>")); assertTrue(result.contains("<title>Hello</title>")); } |
KubernetesPlugin extends ToscanaPlugin<KubernetesLifecycle> { @Override public KubernetesLifecycle getInstance(TransformationContext context) throws Exception { return new KubernetesLifecycle(context, mapper); } @Autowired KubernetesPlugin(BaseImageMapper mapper); @Override KubernetesLifecycle getInstance(TransformationContext context); static final String DOCKER_PUSH_TO_REGISTRY_PROPERTY_KEY; static final String DOCKER_REGISTRY_URL_PROPERTY_KEY; static final String DOCKER_REGISTRY_USERNAME_PROPERTY_KEY; static final String DOCKER_REGISTRY_PASSWORD_PROPERTY_KEY; static final String DOCKER_REGISTRY_REPOSITORY_PROPERTY_KEY; } | @Test(expected = ValidationFailureException.class) public void modelCheckTest() throws Exception { EffectiveModel singleComputeModel = new EffectiveModelFactory().create(TestCsars.VALID_SINGLE_COMPUTE_WINDOWS_TEMPLATE, logMock()); TransformationContext context = setUpMockTransformationContext(singleComputeModel); KubernetesLifecycle lifecycle = plugin.getInstance(context); plugin.transform(lifecycle); } |
SudoUtils { public static Optional<String> getSudoInstallCommand(String baseImage) { String imageName = baseImage.split(":")[0]; return Optional.ofNullable(IMAGE_MAP.get(imageName)); } static Optional<String> getSudoInstallCommand(String baseImage); } | @Test public void validate() { Optional<String> result = SudoUtils.getSudoInstallCommand(input); if (expected == null) { assertTrue(!result.isPresent()); return; } String r = result.get(); assertEquals(r, expected); } |
ResourceFileCreator { public HashMap<String, String> getResourceYaml() throws JsonProcessingException { HashMap<String, String> result = new HashMap<>(); for (IKubernetesResource<?> resource : resources) { result.put(resource.getName(), resource.toYaml()); } return result; } ResourceFileCreator(Collection<Pod> pods); HashMap<String, String> getResourceYaml(); } | @Test public void testReplicationControllerCreation() { ResourceFileCreator resourceFileCreator = new ResourceFileCreator(Pod.getPods(TestNodeStacks.getLampNodeStacks(logMock()))); HashMap<String, String> result = null; try { result = resourceFileCreator.getResourceYaml(); } catch (JsonProcessingException e) { e.printStackTrace(); fail(); } String service = result.get(appServiceName); String deployment = result.get(appDeploymentName); Yaml yaml = new Yaml(); deploymentTest((Map) yaml.load(deployment)); } |
MapperUtils { public static boolean anythingSet(OsCapability capability) { Optional[] optionals = { capability.getDistribution(), capability.getArchitecture(), capability.getType(), capability.getVersion() }; return Arrays.stream(optionals).anyMatch(Optional::isPresent); } static boolean anythingSet(OsCapability capability); static final Comparator<DockerImageTag> TAG_COMPARATOR_MINOR_VERSION; } | @Test public void testNoneSet() { assertFalse(anythingSet(new OsCapability(entity))); }
@Test public void testOneSet() { assertTrue(anythingSet(new OsCapability(entity).setType(Type.LINUX))); } |
CapabilityMapper { public String mapOsCapabilityToImageId(OsCapability osCapability) throws SdkClientException, ParseException, IllegalArgumentException { AmazonEC2 ec2 = AmazonEC2ClientBuilder.standard() .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)) .withRegion(awsRegion) .build(); DescribeImagesRequest describeImagesRequest = new DescribeImagesRequest() .withFilters( new Filter("virtualization-type").withValues("hvm"), new Filter("root-device-type").withValues("ebs")) .withOwners("099720109477"); if (osCapability.getType().isPresent() && osCapability.getType().get().equals(OsCapability.Type.WINDOWS)) { describeImagesRequest.withFilters(new Filter("platform").withValues("windows")); } if (osCapability.getDistribution().isPresent()) { if (osCapability.getDistribution().get().equals(OsCapability.Distribution.UBUNTU)) { describeImagesRequest.withFilters(new Filter("name").withValues("*ubuntu/images/*")); } else { describeImagesRequest.withFilters(new Filter("name").withValues("*" + osCapability.getDistribution() .toString() + "*")); } } if (osCapability.getVersion().isPresent()) { describeImagesRequest.withFilters(new Filter("name").withValues("*" + osCapability.getVersion().get() + "*")); } if (osCapability.getArchitecture().isPresent()) { if (osCapability.getArchitecture().get().equals(OsCapability.Architecture.x86_64)) { describeImagesRequest.withFilters(new Filter("architecture").withValues(ARCH_x86_64)); } else if (osCapability.getArchitecture().get().equals(OsCapability.Architecture.x86_32)) { describeImagesRequest.withFilters(new Filter("architecture").withValues(ARCH_x86_32)); } else { throw new UnsupportedOperationException("This architecture is not supported " + osCapability .getArchitecture()); } } else { describeImagesRequest.withFilters(new Filter("architecture").withValues(ARCH_x86_64)); } try { DescribeImagesResult describeImagesResult = ec2.describeImages(describeImagesRequest); String imageId = processResult(describeImagesResult); logger.debug("ImageId is: '{}'", imageId); return imageId; } catch (SdkClientException se) { logger.error("Cannot connect to AWS to request image Ids"); throw se; } catch (ParseException pe) { logger.error("Error parsing date format of image creation dates"); throw pe; } catch (IllegalArgumentException ie) { logger.error("With the filters created from the OsCapability there are no valid images received"); throw ie; } } CapabilityMapper(String awsRegion, AWSCredentials awsCredentials, Logger logger); String mapOsCapabilityToImageId(OsCapability osCapability); String mapComputeCapabilityToInstanceType(ComputeCapability computeCapability, String distinction); Integer mapComputeCapabilityToRDSAllocatedStorage(ComputeCapability computeCapability); void mapDiskSize(ComputeCapability computeCapability, CloudFormationModule cfnModule, String nodeName); static final String EC2_DISTINCTION; static final String RDS_DISTINCTION; } | @Test public void testMapOsCapabilityToImageId() throws ParseException { try { String imageId = capabilityMapper.mapOsCapabilityToImageId(osCapability); Assert.assertThat(imageId, CoreMatchers.containsString("ami-")); } catch (SdkClientException se) { logger.info("Probably no internet connection / credentials, omitting test"); } } |
CapabilityMapper { public String mapComputeCapabilityToInstanceType(ComputeCapability computeCapability, String distinction) throws IllegalArgumentException { Integer numCpus = computeCapability.getNumCpus().orElse(0); Integer memSize = computeCapability.getMemSizeInMb().orElse(0); final ImmutableList<InstanceType> instanceTypes; if (EC2_DISTINCTION.equals(distinction)) { instanceTypes = EC2_INSTANCE_TYPES; } else if (RDS_DISTINCTION.equals(distinction)) { instanceTypes = RDS_INSTANCE_CLASSES; } else { throw new IllegalArgumentException("Distinction not supported: " + distinction); } List<Integer> allNumCpus = instanceTypes.stream() .map(InstanceType::getNumCpus) .sorted() .collect(Collectors.toList()); List<Integer> allMemSizes = instanceTypes.stream() .map(InstanceType::getMemSize) .sorted() .collect(Collectors.toList()); try { logger.debug("Check numCpus: '{}'", numCpus); numCpus = checkValue(numCpus, allNumCpus); logger.debug("Check memSize: '{}'", memSize); memSize = checkValue(memSize, allMemSizes); } catch (IllegalArgumentException ie) { logger.error("Values numCpus: '{}' and/or memSize: are too big. No InstanceType found", numCpus, memSize); throw ie; } String instanceType = findCombination(numCpus, memSize, instanceTypes, allNumCpus, allMemSizes); logger.debug("InstanceType is: '{}'", instanceType); return instanceType; } CapabilityMapper(String awsRegion, AWSCredentials awsCredentials, Logger logger); String mapOsCapabilityToImageId(OsCapability osCapability); String mapComputeCapabilityToInstanceType(ComputeCapability computeCapability, String distinction); Integer mapComputeCapabilityToRDSAllocatedStorage(ComputeCapability computeCapability); void mapDiskSize(ComputeCapability computeCapability, CloudFormationModule cfnModule, String nodeName); static final String EC2_DISTINCTION; static final String RDS_DISTINCTION; } | @Test public void testMapComputeCapabilityToInstanceTypeEC2() { String instanceType = capabilityMapper.mapComputeCapabilityToInstanceType(containerCapability, EC2_DISTINCTION); Assert.assertEquals(instanceType, expectedEC2); }
@Test public void testMapComputeCapabilityToInstanceTypeRDS() { String instanceType = capabilityMapper.mapComputeCapabilityToInstanceType(containerCapability, RDS_DISTINCTION); Assert.assertEquals(instanceType, expectedRDS); } |
CapabilityMapper { public Integer mapComputeCapabilityToRDSAllocatedStorage(ComputeCapability computeCapability) { final Integer minSize = 20; final Integer maxSize = 6144; Integer diskSize = computeCapability.getDiskSizeInMb().orElse(minSize * 1000); diskSize = diskSize / 1000; if (diskSize > maxSize) { logger.debug("Disk size: '{}'", maxSize); return maxSize; } if (diskSize < minSize) { logger.debug("Disk size: '{}'", minSize); return minSize; } logger.debug("Disk size: '{}'", diskSize); return diskSize; } CapabilityMapper(String awsRegion, AWSCredentials awsCredentials, Logger logger); String mapOsCapabilityToImageId(OsCapability osCapability); String mapComputeCapabilityToInstanceType(ComputeCapability computeCapability, String distinction); Integer mapComputeCapabilityToRDSAllocatedStorage(ComputeCapability computeCapability); void mapDiskSize(ComputeCapability computeCapability, CloudFormationModule cfnModule, String nodeName); static final String EC2_DISTINCTION; static final String RDS_DISTINCTION; } | @Test public void testMapComputeCapabilityToRDSAllocatedStorage() { int newDiskSize = capabilityMapper.mapComputeCapabilityToRDSAllocatedStorage(containerCapability); Assert.assertEquals(newDiskSize, expectedDiskSize); } |
CsarController { @ApiOperation( value = "Deletes a Existing CSAR", notes = "Deletes the Resulting CSAR and its transformations (if none of them is running). " + "If a transformation is running (in the state TRANSFORMING) the CSAR cannot be deleted" ) @ApiResponses({ @ApiResponse( code = 200, message = "The deletion of the CSAR was successful", response = Void.class ), @ApiResponse( code = 400, message = "The deletion of the CSAR failed, because there is one or more transformations still running.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given name (identifier)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{name}/delete", method = {RequestMethod.DELETE}, produces = "application/hal+json" ) public ResponseEntity<Void> deleteCsar( @ApiParam(value = "The unique identifier for the CSAR", required = true, example = "my-csar-name") @PathVariable("name") String name ) { Csar csar = getCsarForName(name); csar.getTransformations().forEach((k, v) -> { if (v.getState() == TransformationState.TRANSFORMING) { throw new ActiveTransformationsException( String.format( "Transformation %s/%s is still running. Cannot delete csar while a transformation is running!", name, k ) ); } }); csarService.deleteCsar(csar); return ResponseEntity.ok().build(); } @Autowired CsarController(CsarService csarService); @ApiOperation( value = "List all CSARs stored on the server", notes = "Returns a Hypermedia Resource containing all CSARs" + " that have been uploaded to the server and did not get removed", response = CsarResources.class, produces = "application/hal+json" ) @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) ResponseEntity<Resources<CsarResponse>> listCSARs(); @ApiOperation( value = "Returns details for a specific name (identifier)", notes = "Returns the element with the given name, Object contents are " + "equal to a regular /csars request (if you just look at the desired entry)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The Csar was found and the contents are found in the body", response = CsarResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given name (identifier)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{name}", method = RequestMethod.GET, produces = "application/hal+json" ) ResponseEntity<CsarResponse> getCSARInfo(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "name") String name
); @ApiOperation( value = "Creates a new CSAR", notes = "This operation creates a new CSAR if the name (identifier) is not used already. " + "The uploaded file has to be a valid CSAR archive. " + "Once the file was uploaded the server will synchronously " + "(the client has to wait for the response) unzip the archive and parse it. " + "Upload gets performed using Multipart Form upload.", code = 201 ) @ApiResponses({ @ApiResponse( code = 201, message = "The upload of the csar was successful", response = Void.class ), @ApiResponse( code = 406, message = "CSAR upload rejected - given ID already in use", response = Void.class ), @ApiResponse( code = 500, message = "The server encountered a unexpected problem", response = Void.class ) }) @RequestMapping( path = "/{name}", method = {RequestMethod.PUT, RequestMethod.POST}, produces = "application/hal+json" ) ResponseEntity<Void> uploadCSAR(
@ApiParam(value = "The unique identifier for the CSAR", required = true)
@PathVariable(name = "name") String name,
@ApiParam(value = "The CSAR Archive (Compressed as ZIP)", required = true)
@RequestParam(name = "file", required = true) MultipartFile file
// HttpServletRequest request
); @ApiOperation( value = "Deletes a Existing CSAR", notes = "Deletes the Resulting CSAR and its transformations (if none of them is running). " + "If a transformation is running (in the state TRANSFORMING) the CSAR cannot be deleted" ) @ApiResponses({ @ApiResponse( code = 200, message = "The deletion of the CSAR was successful", response = Void.class ), @ApiResponse( code = 400, message = "The deletion of the CSAR failed, because there is one or more transformations still running.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given name (identifier)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{name}/delete", method = {RequestMethod.DELETE}, produces = "application/hal+json" ) ResponseEntity<Void> deleteCsar(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "my-csar-name")
@PathVariable("name") String name
); @RequestMapping( path = "/{name}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs of a csar", tags = {"csars"}, notes = "Returns the logs for a csar, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "name") String csarId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); } | @Test public void testDelete() throws Exception { final boolean[] executed = new boolean[]{false}; doAnswer(iom -> executed[0] = true).when(service).deleteCsar(any(Csar.class)); mvc.perform( delete(DELETE_VALID_CSAR_URL).accept(ACCEPTED_MIME_TYPE) ).andDo(print()) .andExpect(status().is(200)) .andExpect(content().bytes(new byte[0])); assertTrue("csarService.delete() did not get called!", executed[0]); } |
CloudFormationFileCreator { public void writeScripts() throws IOException { writeFileUploadScript(); writeStackCreationScript(); writeDeployScript(); writeCleanUpScript(); } CloudFormationFileCreator(TransformationContext context, CloudFormationModule cfnModule); void copyFiles(); void writeScripts(); void copyUtilScripts(); void copyUtilDependencies(); void writeReadme(TransformationContext context); static final String CLI_COMMAND_CREATESTACK; static final String CLI_COMMAND_DELETESTACK; static final String CLI_COMMAND_DELETEBUCKET; static final String COMMAND_ECHO; static final String STRING_DELETESTACK; static final String CLI_PARAM_STACKNAME; static final String CLI_PARAM_TEMPLATEFILE; static final String CLI_PARAM_PARAMOVERRIDES; static final String CLI_PARAM_CAPABILITIES; static final String CLI_PARAM_BUCKET; static final String CLI_PARAM_FORCE; static final String CAPABILITY_IAM; static final String FILENAME_DEPLOY; static final String FILENAME_UPLOAD; static final String FILENAME_CREATE_STACK; static final String FILENAME_CLEANUP; static final String TEMPLATE_YAML; static final String CHANGE_TO_PARENT_DIRECTORY; static final String RELATIVE_DIRECTORY_PREFIX; static final String FILEPATH_CLOUDFORMATION; static final String FILEPATH_SCRIPTS_UTIL; static final String FILEPATH_FILES_UTIL; } | @Test public void testWriteScripts() throws Exception { cfnModule.addFileUpload(new FileUpload(FILENAME_TEST_FILE, FROM_CSAR)); fileCreator.writeScripts(); File deployScript = new File(targetDir, SCRIPTS_DIR_PATH + FILENAME_DEPLOY + BASH_FILE_ENDING); File fileUploadScript = new File(targetDir, SCRIPTS_DIR_PATH + FILENAME_UPLOAD + BASH_FILE_ENDING); File createStackScript = new File(targetDir, SCRIPTS_DIR_PATH + FILENAME_CREATE_STACK + BASH_FILE_ENDING); assertTrue(deployScript.exists()); assertTrue(fileUploadScript.exists()); String expectedDeployContent = SHEBANG + "\n" + SOURCE_UTIL_ALL + "\n" + SUBCOMMAND_EXIT + "\n" + "check \"aws\"\n" + "source file-upload.sh\n" + "source create-stack.sh\n"; String expectedFileUploadContent = SHEBANG + "\n" + SOURCE_UTIL_ALL + "\n" + SUBCOMMAND_EXIT + "\n" + "createBucket " + cfnModule.getBucketName() + " " + cfnModule.getAWSRegion() + "\n" + "uploadFile " + cfnModule.getBucketName() + " \"" + FILENAME_TEST_FILE + "\" \"" + FILEPATH_TARGET_TEST_FILE_LOCAL + "\"" + "\n"; String expectedCreateStackContent = SHEBANG + "\n" + SOURCE_UTIL_ALL + "\n" + SUBCOMMAND_EXIT + "\n" + CLI_COMMAND_CREATESTACK + CLI_PARAM_STACKNAME + cfnModule.getStackName() + " " + CLI_PARAM_TEMPLATEFILE + "../" + TEMPLATE_YAML + " " + CLI_PARAM_CAPABILITIES + " " + CAPABILITY_IAM + "\n"; String actualDeployContent = FileUtils.readFileToString(deployScript, StandardCharsets.UTF_8); String actualFileUploadContent = FileUtils.readFileToString(fileUploadScript, StandardCharsets.UTF_8); String actualCreateStackContent = FileUtils.readFileToString(createStackScript, StandardCharsets.UTF_8); assertEquals(expectedDeployContent, actualDeployContent); assertEquals(expectedFileUploadContent, actualFileUploadContent); assertEquals(expectedCreateStackContent, actualCreateStackContent); } |
CloudFormationFileCreator { public void copyUtilScripts() throws IOException { List<String> utilScripts = IOUtils.readLines( getClass().getResourceAsStream(FILEPATH_SCRIPTS_UTIL + "scripts-list"), Charsets.UTF_8 ); logger.debug("Copying util scripts to the target artifact."); copyUtilFile(utilScripts, FILEPATH_SCRIPTS_UTIL, UTIL_DIR_PATH); } CloudFormationFileCreator(TransformationContext context, CloudFormationModule cfnModule); void copyFiles(); void writeScripts(); void copyUtilScripts(); void copyUtilDependencies(); void writeReadme(TransformationContext context); static final String CLI_COMMAND_CREATESTACK; static final String CLI_COMMAND_DELETESTACK; static final String CLI_COMMAND_DELETEBUCKET; static final String COMMAND_ECHO; static final String STRING_DELETESTACK; static final String CLI_PARAM_STACKNAME; static final String CLI_PARAM_TEMPLATEFILE; static final String CLI_PARAM_PARAMOVERRIDES; static final String CLI_PARAM_CAPABILITIES; static final String CLI_PARAM_BUCKET; static final String CLI_PARAM_FORCE; static final String CAPABILITY_IAM; static final String FILENAME_DEPLOY; static final String FILENAME_UPLOAD; static final String FILENAME_CREATE_STACK; static final String FILENAME_CLEANUP; static final String TEMPLATE_YAML; static final String CHANGE_TO_PARENT_DIRECTORY; static final String RELATIVE_DIRECTORY_PREFIX; static final String FILEPATH_CLOUDFORMATION; static final String FILEPATH_SCRIPTS_UTIL; static final String FILEPATH_FILES_UTIL; } | @Test public void copyUtilScripts() throws Exception { fileCreator.copyUtilScripts(); File createBucketUtilScript = new File(targetDir, UTIL_DIR_PATH + FILENAME_CREATE_BUCKET + BASH_FILE_ENDING); File uploadFileUtilScript = new File(targetDir, UTIL_DIR_PATH + FILENAME_UPLOAD_FILE + BASH_FILE_ENDING); assertTrue(createBucketUtilScript.exists()); assertTrue(uploadFileUtilScript.exists()); } |
CloudFormationFileCreator { public void copyFiles() { List<String> fileUploadList = getFilePaths(getFileUploadByType(cfnModule.getFileUploadList(), FROM_CSAR)); logger.debug("Checking if files need to be copied."); if (!fileUploadList.isEmpty()) { logger.debug("Files to be copied found. Attempting to copy files to the target artifact."); fileUploadList.forEach((filePath) -> { String targetPath = FILEPATH_TARGET + filePath; try { cfnModule.getFileAccess().copy(filePath, targetPath); } catch (IOException e) { throw new TransformationFailureException("Copying of files to the target artifact failed.", e); } }); } else { logger.debug("No files to be copied found. Skipping copying of files."); } } CloudFormationFileCreator(TransformationContext context, CloudFormationModule cfnModule); void copyFiles(); void writeScripts(); void copyUtilScripts(); void copyUtilDependencies(); void writeReadme(TransformationContext context); static final String CLI_COMMAND_CREATESTACK; static final String CLI_COMMAND_DELETESTACK; static final String CLI_COMMAND_DELETEBUCKET; static final String COMMAND_ECHO; static final String STRING_DELETESTACK; static final String CLI_PARAM_STACKNAME; static final String CLI_PARAM_TEMPLATEFILE; static final String CLI_PARAM_PARAMOVERRIDES; static final String CLI_PARAM_CAPABILITIES; static final String CLI_PARAM_BUCKET; static final String CLI_PARAM_FORCE; static final String CAPABILITY_IAM; static final String FILENAME_DEPLOY; static final String FILENAME_UPLOAD; static final String FILENAME_CREATE_STACK; static final String FILENAME_CLEANUP; static final String TEMPLATE_YAML; static final String CHANGE_TO_PARENT_DIRECTORY; static final String RELATIVE_DIRECTORY_PREFIX; static final String FILEPATH_CLOUDFORMATION; static final String FILEPATH_SCRIPTS_UTIL; static final String FILEPATH_FILES_UTIL; } | @Test public void copyFiles() { cfnModule.addFileUpload(new FileUpload(FILENAME_TEST_FILE, FROM_CSAR)); fileCreator.copyFiles(); assertTrue(FILEPATH_TARGET_TEST_FILE.exists()); } |
BashScript { public void append(String string) throws IOException { logger.debug("Appending {} to {}.sh", string, name); access.access(scriptPath).appendln(string).close(); } BashScript(PluginFileAccess access, String name); void append(String string); void checkEnvironment(String command); String getScriptPath(); static final String SHEBANG; static final String SOURCE_UTIL_ALL; static final String SUBCOMMAND_EXIT; } | @Test public void appendTest() throws IOException { String string = UUID.randomUUID().toString(); bashScript.append(string); File expectedGeneratedScript = new File(targetScriptFolder, fileName + ".sh"); List<String> result = IOUtils.readLines(new FileInputStream(expectedGeneratedScript)); assertEquals(string, result.get(result.size() - 1)); } |
ZipUtility { public static boolean unzip(ZipInputStream zipIn, String destDirectory) throws IOException { File destDir = new File(destDirectory); if (!destDir.exists()) { destDir.mkdir(); } ZipEntry entry = zipIn.getNextEntry(); if (entry == null) { return false; } while (entry != null) { String filePath = destDirectory + File.separator + entry.getName(); if (!entry.isDirectory()) { extractFile(zipIn, filePath); } else { logger.trace("Creating directory: {}", filePath); File dir = new File(filePath); dir.mkdir(); } zipIn.closeEntry(); entry = zipIn.getNextEntry(); } zipIn.close(); return true; } static boolean unzip(ZipInputStream zipIn, String destDirectory); static void compressDirectory(File directory, OutputStream output); } | @Test public void unzipFile() throws IOException { ZipInputStream is = new ZipInputStream(new FileInputStream(TestCsars.VALID_LAMP_INPUT)); boolean result = ZipUtility.unzip(is, tmpdir.toString()); assertTrue(result); }
@Test public void unzipNotAFile() throws IOException { ZipInputStream is = new ZipInputStream(new FileInputStream(TestCsars.VALID_LAMP_INPUT_TEMPLATE)); boolean result = ZipUtility.unzip(is, tmpdir.toString()); assertFalse(result); } |
PluginFileAccess { public void copy(String relativePath) throws IOException { copy(relativePath, relativePath); } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void copyFile() throws Exception { String filename = "testFile"; File file = new File(sourceDir, "testFile"); file.createNewFile(); File expectedFile = new File(targetDir, filename); assertFalse(expectedFile.exists()); access.copy(filename); assertTrue(expectedFile.exists()); }
@Test public void copyDirRecursively() throws IOException { String dirname = "dir"; File dir = new File(sourceDir, dirname); dir.mkdir(); for (int i = 0; i < 10; i++) { new File(dir, String.valueOf(i)).createNewFile(); } File expectedDir = new File(targetDir, dirname); assertFalse(expectedDir.exists()); access.copy(dirname); assertTrue(expectedDir.exists()); for (int i = 0; i < 10; i++) { assertTrue(new File(expectedDir, String.valueOf(i)).exists()); } }
@Test(expected = FileNotFoundException.class) public void copyInvalidPathThrowsException() throws IOException { String file = "nonexistent_file"; access.copy(file); }
@Test public void copySourceToGivenTargetSuccessful() throws IOException { String filename = "some-file"; File file = new File(sourceDir, filename); file.createNewFile(); String alternativeDirName = "some-dir/nested/even-deeper"; File alternateDirectory = new File(targetDir, alternativeDirName); File targetFile = new File(alternateDirectory, filename); String relativeTargetPath = String.format("%s/%s", alternativeDirName, filename); access.copy(filename, relativeTargetPath); assertTrue(targetFile.exists()); } |
TransformationController { @ApiOperation( value = "Retrieve the outputs and their values", tags = {"transformations"}, notes = "This operation returns the outputs of a deployment. Retrieval of the outputs is not possible " + "if the transformation (including deployment) is not done yet" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetOutputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform", response = RestErrorResponse.class ), @ApiResponse( code = 400, message = "The state of the transformation is invalid (not ERROR or DONE)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{platform}/outputs", method = {RequestMethod.GET}, produces = "application/hal+json" ) public ResponseEntity<GetOutputsResponse> getOutputs( @ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String csarId, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platformId ) { Csar csar = findByCsarId(csarId); Transformation transformation = findTransformationByPlatform(csar, platformId); if (transformation.getState() != TransformationState.DONE && transformation.getState() != TransformationState.ERROR) { throw new IllegalTransformationStateException("The Transformation has not finished yet!"); } List<OutputProperty> outputs = transformation.getOutputs(); List<OutputWrap> wrappedOutputs = outputs.stream() .map(OutputWrap::new) .collect(Collectors.toList()); return ResponseEntity.ok(new GetOutputsResponse(csarId, platformId, wrappedOutputs)); } @Autowired TransformationController(CsarService csarService,
TransformationService transformationService,
PlatformService platformService); @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "List all transformations of a CSAR", tags = {"transformations", "csars"}, notes = "Returns a HAL-Resources list containing all Transformations for a specific CSAR" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = TransformationResources.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<Resources<TransformationResponse>> getCSARTransformations(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name
); @RequestMapping( path = "/{platform}", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get details for a specific transformation", tags = {"transformations"}, notes = "Returns a HAL-Resource Containing the details for the transformation with the given parameters" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<TransformationResponse> getCSARTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/create", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/hal+json" ) @ApiOperation( value = "Create a new Transformation", tags = {"transformations"}, notes = "Creates a new transformation for the given CSAR and Platform " + "(If the platform does not exist and there is no other transformation with the same CSAR and Platform, " + "you have to delete the old transformation in this case)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The transfomation could not get created because there already is a Transformation" + " of this CSAR on the given Platform", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the platform is not known.", response = RestErrorResponse.class ) }) ResponseEntity<Void> addTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/start", method = RequestMethod.POST, produces = "application/hal+json" ) @ApiOperation( value = "Start a Transformation", tags = {"transformations"}, notes = "Starts a transformation that has been created and is ready to get started. To start a transformation, the " + "Transformation has to be in the state READY otherwise the transformation cannot start." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The state of the transformation is illegal. This means that the transformation is not in the" + "READY state. Therefore starting it is not possible", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity startTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/delete", method = RequestMethod.DELETE, produces = "application/hal+json" ) @ApiOperation( value = "Delete a transformation", tags = {"transformations"}, notes = "Deletes a transformation and all the coresponding artifacts" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The Deletion of the csar failed", response = Void.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> deleteTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs for a Transformation", tags = {"transformations"}, notes = "Returns the logs for a transformation, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getTransformationLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); @RequestMapping( path = "/{platform}/artifact", method = RequestMethod.GET, produces = "application/octet-stream" ) @ApiOperation( value = "Download the target artifact archive", tags = {"transformations"}, notes = "Once the transformation is done (in the state DONE) or it has encountered a error (state ERROR). " + "It is possible to download a archive (ZIP format) of all the files generated while the transformation was " + "running." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "There is nothing to download yet because the execution of the transformation has not yet started " + "or is not finished (With or without errors)", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> getTransformationArtifact(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarName,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform,
HttpServletResponse response
); @RequestMapping( path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Retrieve the inputs of this transformation", tags = {"transformations"}, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<GetInputsResponse> getInputs(
@ApiParam(value = "The identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @RequestMapping( path = "/{platform}/inputs", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/json" ) @ApiOperation( value = "Set the value of inputs", tags = {"transformations"}, notes = "With this method it is possible to set the value of an input or multiple inputs at once. The values " + "of inputs can be set as long as they are in the READY or INPUT_REQUIRED state. The transformation changes its state " + "to ready once all required inputs have a valid value assigned to them." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = Void.class ), @ApiResponse( code = 400, message = "Inputs cannot get set once the transformation has been started.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform.", response = RestErrorResponse.class ), @ApiResponse( code = 406, message = "At least one of the inputs could not get set because either the key does not exist or the " + "syntax validation of the value has failed.", response = InputsResponse.class ) }) ResponseEntity<InputsResponse> setInputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@RequestBody InputsResponse propertiesRequest
); @ApiOperation( value = "Retrieve the outputs and their values", tags = {"transformations"}, notes = "This operation returns the outputs of a deployment. Retrieval of the outputs is not possible " + "if the transformation (including deployment) is not done yet" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetOutputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform", response = RestErrorResponse.class ), @ApiResponse( code = 400, message = "The state of the transformation is invalid (not ERROR or DONE)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{platform}/outputs", method = {RequestMethod.GET}, produces = "application/hal+json" ) ResponseEntity<GetOutputsResponse> getOutputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Cannot delete csar with running transformations") @ExceptionHandler(IndexOutOfBoundsException.class) void handleLogIndexLessThanZero(); } | @Test public void testGetOutputs() throws Exception { List<Transformation> transformations = preInitNonCreationTests(); Transformation t = transformations.get(0); when(t.getState()).thenReturn(TransformationState.DONE); String outputKey = "test_output"; List<OutputProperty> outputs = Lists.newArrayList(new PlatformInput( outputKey, PropertyType.TEXT, "", true, "some value" )); when(t.getOutputs()).thenReturn(outputs); mvc.perform(get(GET_OUTPUT_URL)) .andDo(print()) .andExpect(status().is(200)) .andExpect(jsonPath("$.outputs").isArray()) .andExpect(jsonPath("$.links[0].href").value("http: .andExpect(jsonPath("$.outputs[0].key").value(outputKey)) .andReturn(); }
@Test public void testGetOutputsEmptyOutputs() throws Exception { List<Transformation> transformations = preInitNonCreationTests(); Transformation t = transformations.get(0); when(t.getState()).thenReturn(TransformationState.DONE); when(t.getOutputs()).thenReturn(new ArrayList<>()); mvc.perform(get(GET_OUTPUT_URL)) .andDo(print()) .andExpect(status().is(200)) .andExpect(jsonPath("$.outputs").isArray()) .andExpect(jsonPath("$.links[0].href").value("http: .andReturn(); } |
PluginFileAccess { public BufferedLineWriter access(String relativePath) throws IOException { File target = new File(targetDir, relativePath); target.getParentFile().mkdirs(); try { return new BufferedLineWriter(new FileWriter(target, true)); } catch (FileNotFoundException e) { logger.error("Failed to create OutputStream for file '{}'", target); throw e; } } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void write() throws Exception { String secondString = "second_test_string"; access.access(targetFileName).appendln(fileContent).close(); access.access(targetFileName).append(secondString).close(); assertTrue(targetFile.isFile()); List<String> result = IOUtils.readLines(new FileInputStream(targetFile)); assertEquals(fileContent, result.get(result.size() - 2)); assertEquals(secondString, result.get(result.size() - 1)); }
@Test(expected = IOException.class) public void writePathIsDirectoryThrowsException() throws IOException { targetFile.mkdir(); access.access(targetFileName); }
@Test public void writeSubDirectoriesGetAutomaticallyCreated() throws IOException { String path = "test/some/subdirs/filename"; access.access(path).append(fileContent).close(); File targetFile = new File(targetDir, path); assertTrue(targetFile.isFile()); assertEquals(fileContent, FileUtils.readFileToString(targetFile)); } |
PluginFileAccess { public String read(String relativePath) throws IOException { File source = new File(sourceDir, relativePath); try { return FileUtils.readFileToString(source); } catch (IOException e) { logger.error("Failed to read content from file '{}'", source); throw e; } } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void readSuccessful() throws IOException { String path = "file"; File file = new File(sourceDir, path); InputStream inputStream = IOUtils.toInputStream(fileContent, "UTF-8"); FileUtils.copyInputStreamToFile(inputStream, file); String result = access.read(path); assertNotNull(result); assertEquals(fileContent, result); }
@Test(expected = IOException.class) public void readFileNotExists() throws IOException { String path = "nonexistent-file"; access.read(path); } |
PluginFileAccess { public String getAbsolutePath(String relativePath) throws FileNotFoundException { File targetFile = new File(targetDir, relativePath); if (targetFile.exists()) { return targetFile.getAbsolutePath(); } else { throw new FileNotFoundException(String.format("File '%s' not found", targetFile)); } } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void getAbsolutePathSuccess() throws IOException { String filename = "some-source-file"; File sourceFile = new File(targetDir, filename); sourceFile.createNewFile(); String result = access.getAbsolutePath(filename); assertEquals(sourceFile.getAbsolutePath(), result); }
@Test(expected = FileNotFoundException.class) public void getAbsolutePathNoSuchFile() throws FileNotFoundException { String filename = "nonexistent-file"; access.getAbsolutePath(filename); fail("getAbsolutePath() should have raised FileNotFoundException."); } |
PluginFileAccess { public void delete(String relativePath) { File file = new File(targetDir, relativePath); FileUtils.deleteQuietly(file); } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void delete() throws IOException { String filename = "some-file"; File file = new File(targetDir, filename); file.createNewFile(); assertTrue(file.exists()); access.delete(filename); assertFalse(file.exists()); } |
PluginFileAccess { public void createDirectories(String relativePath) { File targetFolder = new File(targetDir, relativePath); targetFolder.mkdirs(); } PluginFileAccess(File sourceDir, File targetDir, Log log); void copy(String relativePath); void copy(String relativeSourcePath, String relativeTargetPath); BufferedLineWriter access(String relativePath); BufferedOutputStream accessAsOutputStream(String relativePath); String read(String relativePath); String getAbsolutePath(String relativePath); void delete(String relativePath); void createDirectories(String relativePath); } | @Test public void createFolder() { String folder = "some-folder/some-subfolder/some-subsubfolder"; access.createDirectories(folder); File expectedFolder = new File(targetDir, folder); assertTrue(expectedFolder.exists()); } |
LogImpl implements Log { @Override public List<LogEntry> getLogEntries(int first, int last) { return getLogEntries(first, last, true); } LogImpl(File logFile); @Override void addLogEntry(LogEntry e); @Override List<LogEntry> getLogEntries(int first, int last); @Override List<LogEntry> getLogEntries(int firstIndex); @Override Logger getLogger(String context); @Override Logger getLogger(Class context); @Override void close(); } | @Test public void getAllLogEntries() throws Exception { logger.info("Trying to retrieve complete log"); List<LogEntry> logs = log.getLogEntries(0); logger.info("Checking length"); assertTrue(logs.size() == 100); logger.info("Checking data"); for (int i = 0; i < logs.size(); i++) { LogEntry e = logs.get(i); assertEquals((String.format("Log-Message-%d", i)), e.getMessage()); } logger.info("Done"); }
@Test public void getPartialLogEntries() throws Exception { logger.info("Trying to log from index 50"); List<LogEntry> logs = log.getLogEntries(50); logger.info("Checking length"); assertTrue(logs.size() == 50); logger.info("Checking data"); for (int i = 50; i < logs.size(); i++) { LogEntry e = logs.get(i); assertEquals(String.format("Log-Message-%d", i), e.getMessage()); } logger.info("Done"); }
@Test public void getLogsFromOuterBound() throws Exception { logger.info("Trying to get logs from index 100"); assertSame(0, log.getLogEntries(101).size()); logger.info("Done"); }
@Test public void getFirstTenLogEntries() throws Exception { logger.info("Trying to log from index 0 to 10"); List<LogEntry> logs = log.getLogEntries(0, 9); logger.info("Checking length"); assertSame(10, logs.size()); logger.info("Checking data"); for (int i = 0; i < logs.size(); i++) { LogEntry e = logs.get(i); assertEquals(String.format("Log-Message-%d", i), e.getMessage()); } logger.info("Done"); }
@Test(expected = IllegalArgumentException.class) public void getLogEntriesWithInvalidBounds() throws Exception { logger.info("Trying to log from index 0 to 10"); log.getLogEntries(100, 10); }
@Test public void logReadsLogfileWithIllegalLogsAndIgnoresThem() throws IOException { PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(logfile))); pw.write("log level which does not adhere to logging format"); log = new LogImpl(logfile); List<LogEntry> entries = log.getLogEntries(0); assertEquals(0, entries.size()); } |
TransformationServiceImpl implements TransformationService { @Override public Transformation createTransformation(Csar csar, Platform targetPlatform) throws PlatformNotFoundException { return transformationDao.create(csar, targetPlatform); } @Autowired TransformationServiceImpl(
TransformationDao transformationDao,
PluginService pluginService,
@Lazy CsarDao csarDao,
ArtifactService artifactService
); @Override Transformation createTransformation(Csar csar, Platform targetPlatform); @Override boolean startTransformation(Transformation transformation); @Override boolean abortTransformation(Transformation transformation); @Override boolean deleteTransformation(Transformation transformation); } | @Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void createTransformation() throws Exception { Transformation expected = new TransformationImpl(csar, PLATFORM1, log, modelMock()); Transformation transformation = service.createTransformation(csar, PLATFORM1); assertTrue(csar.getTransformation(PLATFORM1.id).isPresent()); assertEquals(expected, transformation); }
@Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void transformationCreationNoProps() throws Exception { Transformation t = service.createTransformation(csar, PASSING_DUMMY.getPlatform()); assertTrue(csar.getTransformation(PASSING_DUMMY.getPlatform().id).isPresent()); assertNotNull(t); assertEquals(TransformationState.READY, t.getState()); }
@Test(expected = PlatformNotFoundException.class) public void transformationCreationPlatformNotFound() throws PlatformNotFoundException { service.createTransformation(csar, PLATFORM_NOT_SUPPORTED); }
@Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void transformationCreationInputNeeded() throws Exception { Transformation t = service.createTransformation(csar, PLATFORM_PASSING_INPUT_REQUIRED_DUMMY); assertTrue(csar.getTransformation(PLATFORM_PASSING_INPUT_REQUIRED_DUMMY.id).isPresent()); assertNotNull(t); assertEquals(TransformationState.INPUT_REQUIRED, t.getState()); } |
TransformationServiceImpl implements TransformationService { @Override public boolean startTransformation(Transformation transformation) { if (transformation.getState() == TransformationState.READY) { Future<?> taskFuture = executor.submit( new ExecutionTask( transformation, artifactService, pluginService, csarDao.getContentDir(transformation.getCsar()), transformationDao.getContentDir(transformation) ) ); tasks.put(transformation, taskFuture); return true; } return false; } @Autowired TransformationServiceImpl(
TransformationDao transformationDao,
PluginService pluginService,
@Lazy CsarDao csarDao,
ArtifactService artifactService
); @Override Transformation createTransformation(Csar csar, Platform targetPlatform); @Override boolean startTransformation(Transformation transformation); @Override boolean abortTransformation(Transformation transformation); @Override boolean deleteTransformation(Transformation transformation); } | @Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void startTransformation() throws Exception { Transformation t = startTransformationInternal(TransformationState.DONE, PASSING_DUMMY.getPlatform()); assertNotNull(t); } |
TransformationController { @RequestMapping( path = "/{platform}/start", method = RequestMethod.POST, produces = "application/hal+json" ) @ApiOperation( value = "Start a Transformation", tags = {"transformations"}, notes = "Starts a transformation that has been created and is ready to get started. To start a transformation, the " + "Transformation has to be in the state READY otherwise the transformation cannot start." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The state of the transformation is illegal. This means that the transformation is not in the" + "READY state. Therefore starting it is not possible", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) public ResponseEntity startTransformation( @ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String name, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platform ) { logger.info("Starting transformation for csar '{}' on '{}'", name, platform); Csar csar = findByCsarId(name); Transformation transformation = findTransformationByPlatform(csar, platform); if (transformationService.startTransformation(transformation)) { return ResponseEntity.ok().build(); } else { throw new IllegalTransformationStateException("Transformation could not start because" + " its not in a valid state to start."); } } @Autowired TransformationController(CsarService csarService,
TransformationService transformationService,
PlatformService platformService); @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "List all transformations of a CSAR", tags = {"transformations", "csars"}, notes = "Returns a HAL-Resources list containing all Transformations for a specific CSAR" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = TransformationResources.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<Resources<TransformationResponse>> getCSARTransformations(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name
); @RequestMapping( path = "/{platform}", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get details for a specific transformation", tags = {"transformations"}, notes = "Returns a HAL-Resource Containing the details for the transformation with the given parameters" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<TransformationResponse> getCSARTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/create", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/hal+json" ) @ApiOperation( value = "Create a new Transformation", tags = {"transformations"}, notes = "Creates a new transformation for the given CSAR and Platform " + "(If the platform does not exist and there is no other transformation with the same CSAR and Platform, " + "you have to delete the old transformation in this case)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The transfomation could not get created because there already is a Transformation" + " of this CSAR on the given Platform", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the platform is not known.", response = RestErrorResponse.class ) }) ResponseEntity<Void> addTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/start", method = RequestMethod.POST, produces = "application/hal+json" ) @ApiOperation( value = "Start a Transformation", tags = {"transformations"}, notes = "Starts a transformation that has been created and is ready to get started. To start a transformation, the " + "Transformation has to be in the state READY otherwise the transformation cannot start." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The state of the transformation is illegal. This means that the transformation is not in the" + "READY state. Therefore starting it is not possible", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity startTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/delete", method = RequestMethod.DELETE, produces = "application/hal+json" ) @ApiOperation( value = "Delete a transformation", tags = {"transformations"}, notes = "Deletes a transformation and all the coresponding artifacts" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The Deletion of the csar failed", response = Void.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> deleteTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs for a Transformation", tags = {"transformations"}, notes = "Returns the logs for a transformation, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getTransformationLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); @RequestMapping( path = "/{platform}/artifact", method = RequestMethod.GET, produces = "application/octet-stream" ) @ApiOperation( value = "Download the target artifact archive", tags = {"transformations"}, notes = "Once the transformation is done (in the state DONE) or it has encountered a error (state ERROR). " + "It is possible to download a archive (ZIP format) of all the files generated while the transformation was " + "running." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "There is nothing to download yet because the execution of the transformation has not yet started " + "or is not finished (With or without errors)", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> getTransformationArtifact(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarName,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform,
HttpServletResponse response
); @RequestMapping( path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Retrieve the inputs of this transformation", tags = {"transformations"}, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<GetInputsResponse> getInputs(
@ApiParam(value = "The identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @RequestMapping( path = "/{platform}/inputs", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/json" ) @ApiOperation( value = "Set the value of inputs", tags = {"transformations"}, notes = "With this method it is possible to set the value of an input or multiple inputs at once. The values " + "of inputs can be set as long as they are in the READY or INPUT_REQUIRED state. The transformation changes its state " + "to ready once all required inputs have a valid value assigned to them." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = Void.class ), @ApiResponse( code = 400, message = "Inputs cannot get set once the transformation has been started.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform.", response = RestErrorResponse.class ), @ApiResponse( code = 406, message = "At least one of the inputs could not get set because either the key does not exist or the " + "syntax validation of the value has failed.", response = InputsResponse.class ) }) ResponseEntity<InputsResponse> setInputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@RequestBody InputsResponse propertiesRequest
); @ApiOperation( value = "Retrieve the outputs and their values", tags = {"transformations"}, notes = "This operation returns the outputs of a deployment. Retrieval of the outputs is not possible " + "if the transformation (including deployment) is not done yet" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetOutputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform", response = RestErrorResponse.class ), @ApiResponse( code = 400, message = "The state of the transformation is invalid (not ERROR or DONE)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{platform}/outputs", method = {RequestMethod.GET}, produces = "application/hal+json" ) ResponseEntity<GetOutputsResponse> getOutputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Cannot delete csar with running transformations") @ExceptionHandler(IndexOutOfBoundsException.class) void handleLogIndexLessThanZero(); } | @Test public void testStartTransformationSuccess() throws Exception { preInitNonCreationTests(); when(transformationService.startTransformation(any(Transformation.class))).thenReturn(true); mvc.perform( post(START_TRANSFORMATION_VALID_URL) .contentType(MediaType.APPLICATION_JSON) .content(INPUTS_VALID) ).andDo(print()) .andExpect(status().is(200)) .andExpect(content().bytes(new byte[0])) .andReturn(); }
@Test public void testStartTransformationFail() throws Exception { preInitNonCreationTests(); when(transformationService.startTransformation(any(Transformation.class))).thenReturn(false); mvc.perform( post(START_TRANSFORMATION_VALID_URL) .contentType(MediaType.APPLICATION_JSON) .content(INPUTS_VALID) ).andDo(print()) .andExpect(status().is(400)) .andExpect(content().bytes(new byte[0])) .andReturn(); assertNotEquals(TransformationState.TRANSFORMING, csarService.getCsar(VALID_CSAR_NAME).get().getTransformation(VALID_PLATFORM_NAME).get().getState()); } |
TransformationServiceImpl implements TransformationService { @Override public boolean abortTransformation(Transformation transformation) { Future<?> task = tasks.get(transformation); if (task == null) { return false; } if (task.isDone()) { return false; } return task.cancel(true); } @Autowired TransformationServiceImpl(
TransformationDao transformationDao,
PluginService pluginService,
@Lazy CsarDao csarDao,
ArtifactService artifactService
); @Override Transformation createTransformation(Csar csar, Platform targetPlatform); @Override boolean startTransformation(Transformation transformation); @Override boolean abortTransformation(Transformation transformation); @Override boolean deleteTransformation(Transformation transformation); } | @Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void stopNotStarted() throws Exception { transformationCreationNoProps(); Transformation t = csar.getTransformations().get(PASSING_DUMMY.getPlatform().id); assertFalse(service.abortTransformation(t)); } |
TransformationServiceImpl implements TransformationService { @Override public boolean deleteTransformation(Transformation transformation) { if (transformation.getState() == TransformationState.TRANSFORMING) { return false; } transformationDao.delete(transformation); tasks.remove(transformation); return true; } @Autowired TransformationServiceImpl(
TransformationDao transformationDao,
PluginService pluginService,
@Lazy CsarDao csarDao,
ArtifactService artifactService
); @Override Transformation createTransformation(Csar csar, Platform targetPlatform); @Override boolean startTransformation(Transformation transformation); @Override boolean abortTransformation(Transformation transformation); @Override boolean deleteTransformation(Transformation transformation); } | @Test(timeout = TEST_EXECUTION_TIMEOUT_MS) public void deleteTransformation() throws Exception { Transformation transformation = new TransformationImpl(csar, PLATFORM1, log, modelMock()); csar.getTransformations().put(PLATFORM1.id, transformation); service.deleteTransformation(transformation); assertFalse(csar.getTransformations().containsValue(transformation)); } |
TransformationFilesystemDao implements TransformationDao { @Override public File getRootDir(Transformation transformation) { return getRootDir(transformation.getCsar(), transformation.getPlatform()); } @Autowired TransformationFilesystemDao(PlatformService platformService, EffectiveModelFactory effectiveModelFactory); @Override Transformation create(Csar csar, Platform platform); @Override void delete(Transformation transformation); @Override Optional<Transformation> find(Csar csar, Platform platform); @Override List<Transformation> find(Csar csar); @Override TargetArtifact createTargetArtifact(Transformation transformation); @Override File getRootDir(Transformation transformation); @Override File getContentDir(Transformation transformation); @Override void setCsarDao(CsarDao csarDao); final static String ARTIFACT_FAILED_REGEX; final static String ARTIFACT_SUCCESSFUL_REGEX; final static String CONTENT_DIR; } | @Test public void getRootDir() { doReturn(new File(new File(tmpdir, csar.getIdentifier()), CsarFilesystemDao.TRANSFORMATION_DIR)).when(csarDao).getTransformationsDir(csar); doReturn(new File(tmpdir, csar.getIdentifier())).when(csarDao).getRootDir(csar); File expectedParent = new File(csarDao.getRootDir(csar), CsarFilesystemDao.TRANSFORMATION_DIR); File expected = new File(expectedParent, PLATFORM1.id); File actual = transformationDao.getRootDir(transformation); assertEquals(expected, actual); } |
TransformationFilesystemDao implements TransformationDao { @Override public Transformation create(Csar csar, Platform platform) throws PlatformNotFoundException { if (!platformService.isSupported(platform)) { throw new PlatformNotFoundException(); } Optional<Transformation> oldTransformation = csar.getTransformation(platform.id); if (oldTransformation.isPresent()) { delete(oldTransformation.get()); } else { delete(getRootDir(csar, platform)); } Transformation transformation = createTransformation(csar, platform); csar.getTransformations().put(platform.id, transformation); getContentDir(transformation).mkdirs(); return transformation; } @Autowired TransformationFilesystemDao(PlatformService platformService, EffectiveModelFactory effectiveModelFactory); @Override Transformation create(Csar csar, Platform platform); @Override void delete(Transformation transformation); @Override Optional<Transformation> find(Csar csar, Platform platform); @Override List<Transformation> find(Csar csar); @Override TargetArtifact createTargetArtifact(Transformation transformation); @Override File getRootDir(Transformation transformation); @Override File getContentDir(Transformation transformation); @Override void setCsarDao(CsarDao csarDao); final static String ARTIFACT_FAILED_REGEX; final static String ARTIFACT_SUCCESSFUL_REGEX; final static String CONTENT_DIR; } | @Test public void createDeletesOldFilesAndCreatesBlankDir() { List<File> files = createRandomFiles(transformationRootDir); assertNotEquals(0, transformationRootDir.list().length); when(platformService.isSupported(PLATFORM1)).thenReturn(true); transformationDao.create(csar, PLATFORM1); for (File file : files) { assertFalse(file.exists()); } assertTrue(transformationRootDir.exists()); File[] result = transformationRootDir.listFiles(); assertEquals(1, result.length); assertEquals(TransformationFilesystemDao.CONTENT_DIR, result[0].getName()); assertEquals(1, result[0].list().length); } |
TransformationFilesystemDao implements TransformationDao { @Override public void delete(Transformation transformation) { transformation.getCsar().getTransformations().remove(transformation.getPlatform().id); File transformationDir = getRootDir(transformation); delete(transformationDir); } @Autowired TransformationFilesystemDao(PlatformService platformService, EffectiveModelFactory effectiveModelFactory); @Override Transformation create(Csar csar, Platform platform); @Override void delete(Transformation transformation); @Override Optional<Transformation> find(Csar csar, Platform platform); @Override List<Transformation> find(Csar csar); @Override TargetArtifact createTargetArtifact(Transformation transformation); @Override File getRootDir(Transformation transformation); @Override File getContentDir(Transformation transformation); @Override void setCsarDao(CsarDao csarDao); final static String ARTIFACT_FAILED_REGEX; final static String ARTIFACT_SUCCESSFUL_REGEX; final static String CONTENT_DIR; } | @Test public void delete() { createRandomFiles(transformationRootDir); transformationDao.delete(transformation); assertFalse(transformationRootDir.exists()); } |
TransformationFilesystemDao implements TransformationDao { @Override public Optional<Transformation> find(Csar csar, Platform platform) { Set<Transformation> transformations = readFromDisk(csar); return Optional.ofNullable(transformations.stream() .filter(transformation -> transformation.getCsar().equals(csar) && transformation.getPlatform().equals(platform)) .findFirst().orElse(null)); } @Autowired TransformationFilesystemDao(PlatformService platformService, EffectiveModelFactory effectiveModelFactory); @Override Transformation create(Csar csar, Platform platform); @Override void delete(Transformation transformation); @Override Optional<Transformation> find(Csar csar, Platform platform); @Override List<Transformation> find(Csar csar); @Override TargetArtifact createTargetArtifact(Transformation transformation); @Override File getRootDir(Transformation transformation); @Override File getContentDir(Transformation transformation); @Override void setCsarDao(CsarDao csarDao); final static String ARTIFACT_FAILED_REGEX; final static String ARTIFACT_SUCCESSFUL_REGEX; final static String CONTENT_DIR; } | @Test public void findFromSpecificCsar() { when(csarDao.getTransformationsDir(csar)).thenReturn(tmpdir); createRandomFiles(new File(tmpdir, PLATFORM1.id)); createRandomFiles(new File(tmpdir, PLATFORM2.id)); createRandomFiles(new File(tmpdir, PLATFORM_NOT_SUPPORTED.id)); when(platformService.findPlatformById(PLATFORM1.id)).thenReturn(Optional.of(PLATFORM1)); when(platformService.findPlatformById(PLATFORM2.id)).thenReturn(Optional.of(PLATFORM2)); List<Transformation> transformations = transformationDao.find(csar); assertEquals(2, transformations.size()); }
@Test public void findSpecificTransformation() { when(csarDao.getTransformationsDir(csar)).thenReturn(tmpdir); when(platformService.findPlatformById(PLATFORM1.id)).thenReturn(Optional.of(PLATFORM1)); when(platformService.findPlatformById(PLATFORM2.id)).thenReturn(Optional.of(PLATFORM2)); createRandomFiles(new File(tmpdir, PLATFORM1.id)); createRandomFiles(new File(tmpdir, PLATFORM2.id)); Transformation transformation = transformationDao.find(csar, PLATFORM1).get(); assertNotNull(transformation); assertEquals(csar, transformation.getCsar()); assertEquals(PLATFORM1, transformation.getPlatform()); Optional<Transformation> notStoredTransformation = transformationDao.find(csar, PLATFORM3); assertFalse(notStoredTransformation.isPresent()); } |
CsarImpl implements Csar { @Override public Optional<Transformation> getTransformation(String platformId) { Transformation t = transformations.get(platformId); return Optional.ofNullable(t); } CsarImpl(File rootDir, String identifier, Log log); @Override boolean validate(); @Override Map<String, Transformation> getTransformations(); @Override Optional<Transformation> getTransformation(String platformId); @Override String getIdentifier(); @Override Log getLog(); @Override List<LifecyclePhase> getLifecyclePhases(); @Override LifecyclePhase getLifecyclePhase(Phase phase); @Override boolean equals(Object obj); @Override int hashCode(); @Override void setTransformations(List<Transformation> transformations); @Override File getContentDir(); @Override File getTemplate(); @Override String toString(); } | @Test public void getTransformationsForSpecificPlatform() throws Exception { Optional<Transformation> result = csar.getTransformation(PLATFORM1.id); assertTrue(result.isPresent()); assertEquals(transformation1, result.get()); } |
CsarFilesystemDao implements CsarDao { @Override public Csar create(String identifier, InputStream inputStream) { csarMap.remove(identifier); File csarDir = setupDir(identifier); Csar csar = new CsarImpl(getRootDir(identifier), identifier, getLog(identifier)); File transformationDir = new File(csarDir, TRANSFORMATION_DIR); transformationDir.mkdir(); unzip(identifier, inputStream, csar, csarDir); csarMap.put(identifier, csar); return csar; } @Autowired CsarFilesystemDao(Preferences preferences, @Lazy TransformationDao transformationDao); @PostConstruct void init(); @Override Csar create(String identifier, InputStream inputStream); @Override void delete(String identifier); @Override Optional<Csar> find(String identifier); @Override List<Csar> findAll(); @Override File getRootDir(Csar csar); @Override File getContentDir(Csar csar); @Override File getTransformationsDir(Csar csar); final static String CSARS_DIR; final static String TRANSFORMATION_DIR; } | @Test public void create() throws Exception { String identifier = "my-csar-checkStateNoPropsSet"; File csarFile = TestCsars.VALID_MINIMAL_DOCKER; InputStream csarStream = new FileInputStream(csarFile); csarDao.create(identifier, csarStream); File csarFolder = new File(generalCsarsDir, identifier); File contentFolder = new File(csarFolder, CsarImpl.CONTENT_DIR); File transformationFolder = new File(csarFolder, CsarFilesystemDao.TRANSFORMATION_DIR); assertTrue(contentFolder.isDirectory()); assertTrue(transformationFolder.isDirectory()); assertTrue(contentFolder.list().length == 1); } |
CsarFilesystemDao implements CsarDao { @Override public void delete(String identifier) { File csarDir = new File(dataDir, identifier); try { FileUtils.deleteDirectory(csarDir); csarMap.remove(identifier); logger.info("Deleted csar directory '{}'", csarDir); } catch (IOException e) { logger.error("Failed to delete csar directory with identifier '{}'", identifier, e); } } @Autowired CsarFilesystemDao(Preferences preferences, @Lazy TransformationDao transformationDao); @PostConstruct void init(); @Override Csar create(String identifier, InputStream inputStream); @Override void delete(String identifier); @Override Optional<Csar> find(String identifier); @Override List<Csar> findAll(); @Override File getRootDir(Csar csar); @Override File getContentDir(Csar csar); @Override File getTransformationsDir(Csar csar); final static String CSARS_DIR; final static String TRANSFORMATION_DIR; } | @Test public void deleteCsarRemovesDataOnDisk() throws Exception { String identifier = createFakeCsarDirectories(1)[0]; csarDao.delete(identifier); File csarDir = new File(generalCsarsDir, identifier); assertFalse(csarDir.exists()); } |
CsarFilesystemDao implements CsarDao { @Override public Optional<Csar> find(String identifier) { Csar csar = csarMap.get(identifier); return Optional.ofNullable(csar); } @Autowired CsarFilesystemDao(Preferences preferences, @Lazy TransformationDao transformationDao); @PostConstruct void init(); @Override Csar create(String identifier, InputStream inputStream); @Override void delete(String identifier); @Override Optional<Csar> find(String identifier); @Override List<Csar> findAll(); @Override File getRootDir(Csar csar); @Override File getContentDir(Csar csar); @Override File getTransformationsDir(Csar csar); final static String CSARS_DIR; final static String TRANSFORMATION_DIR; } | @Test public void find() { String identifier = createFakeCsarDirectories(1)[0]; csarDao = new CsarFilesystemDao(preferences, transformationDao); csarDao.init(); Optional<Csar> csar = csarDao.find(identifier); assertTrue(csar.isPresent()); assertEquals(identifier, csar.get().getIdentifier()); } |
CsarFilesystemDao implements CsarDao { @Override public List<Csar> findAll() { List<Csar> csarList = new ArrayList<>(); csarList.addAll(csarMap.values()); return csarList; } @Autowired CsarFilesystemDao(Preferences preferences, @Lazy TransformationDao transformationDao); @PostConstruct void init(); @Override Csar create(String identifier, InputStream inputStream); @Override void delete(String identifier); @Override Optional<Csar> find(String identifier); @Override List<Csar> findAll(); @Override File getRootDir(Csar csar); @Override File getContentDir(Csar csar); @Override File getTransformationsDir(Csar csar); final static String CSARS_DIR; final static String TRANSFORMATION_DIR; } | @Test public void findAll() { int numberOfCsars = 10; createFakeCsarDirectories(numberOfCsars); csarDao = new CsarFilesystemDao(preferences, transformationDao); csarDao.init(); List<Csar> csarList = csarDao.findAll(); assertEquals("Correct amount of csars returned", numberOfCsars, csarList.size()); } |
ServiceGraph extends SimpleDirectedGraph<Entity, Connection> { public Optional<Entity> getEntity(List<String> path) { Entity current = root; for (String segment : path) { Optional<Entity> child = current.getChild(segment); if (child.isPresent()) { current = child.get(); } else { return Optional.empty(); } } return Optional.of(current); } ServiceGraph(Log log); ServiceGraph(File template, Log log); void finalizeGraph(); boolean inputsValid(); Map<String, InputProperty> getInputs(); Map<String, OutputProperty> getOutputs(); void addEntity(Entity entity); Optional<Entity> getEntity(List<String> path); Optional<Entity> getEntity(EntityId id); Entity getEntityOrThrow(EntityId id); Iterator<Entity> iterator(EntityId id); void replaceEntity(Entity source, Entity target); void addConnection(Entity source, Entity target, String connectionName); Collection<Entity> getChildren(EntityId id); Logger getLogger(); Log getLog(); } | @Test public void requirementTest() { currentFile = REQUIREMENT; Optional<Entity> fulfiller = getGraph().getEntity(Lists.newArrayList("topology_template", "node_templates", "test-node", "requirements", "test-requirement1", "node")); assertTrue(fulfiller.isPresent()); Optional<Entity> fulfiller2 = getGraph().getEntity(Lists.newArrayList("topology_template", "node_templates", "test-node", "requirements", "test-requirement2", "node")); assertTrue(fulfiller2.isPresent()); MappingEntity capabilityEntity = (MappingEntity) getGraph().getEntity(new EntityId(Lists.newArrayList( "topology_template", "node_templates", "test-node", "requirements", "test-requirement2", "capability"))).get(); DatabaseEndpointCapability capability = TypeWrapper.wrapTypedElement(capabilityEntity); assertNotNull(capability); MappingEntity relationshipEntity = (MappingEntity) getGraph().getEntity(new EntityId(Lists.newArrayList( "topology_template", "node_templates", "test-node", "requirements", "test-requirement2", "relationship"))).get(); ConnectsTo relationship = TypeWrapper.wrapTypedElement(relationshipEntity); assertNotNull(relationship); assertEquals(Lists.newArrayList("1", "2"), getList("topology_template", "node_templates", "test-node", "requirements", "test-requirement2", "occurrences")); } |
ServiceGraph extends SimpleDirectedGraph<Entity, Connection> { public boolean inputsValid() { Map<String, InputProperty> inputs = getInputs(); return inputs.values().stream() .allMatch(InputProperty::isValid); } ServiceGraph(Log log); ServiceGraph(File template, Log log); void finalizeGraph(); boolean inputsValid(); Map<String, InputProperty> getInputs(); Map<String, OutputProperty> getOutputs(); void addEntity(Entity entity); Optional<Entity> getEntity(List<String> path); Optional<Entity> getEntity(EntityId id); Entity getEntityOrThrow(EntityId id); Iterator<Entity> iterator(EntityId id); void replaceEntity(Entity source, Entity target); void addConnection(Entity source, Entity target, String connectionName); Collection<Entity> getChildren(EntityId id); Logger getLogger(); Log getLog(); } | @Test public void allInputsSetTest() { currentFile = INPUT_NO_VALUE; ServiceGraph graph = getGraph(); assertFalse(graph.inputsValid()); currentFile = INPUT; graph = getGraph(); assertTrue(graph.inputsValid()); } |
TransformationController { @RequestMapping( path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Retrieve the inputs of this transformation", tags = {"transformations"}, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) public ResponseEntity<GetInputsResponse> getInputs( @ApiParam(value = "The identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String csarId, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platformId ) { Csar csar = findByCsarId(csarId); Transformation transformation = findTransformationByPlatform(csar, platformId); List<InputWrap> inputWrapList = toPropertyWrapList(transformation.getInputs(), null); GetInputsResponse response = new GetInputsResponse(csarId, platformId, inputWrapList); return ResponseEntity.ok(response); } @Autowired TransformationController(CsarService csarService,
TransformationService transformationService,
PlatformService platformService); @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "List all transformations of a CSAR", tags = {"transformations", "csars"}, notes = "Returns a HAL-Resources list containing all Transformations for a specific CSAR" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = TransformationResources.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<Resources<TransformationResponse>> getCSARTransformations(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name
); @RequestMapping( path = "/{platform}", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get details for a specific transformation", tags = {"transformations"}, notes = "Returns a HAL-Resource Containing the details for the transformation with the given parameters" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<TransformationResponse> getCSARTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/create", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/hal+json" ) @ApiOperation( value = "Create a new Transformation", tags = {"transformations"}, notes = "Creates a new transformation for the given CSAR and Platform " + "(If the platform does not exist and there is no other transformation with the same CSAR and Platform, " + "you have to delete the old transformation in this case)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The transfomation could not get created because there already is a Transformation" + " of this CSAR on the given Platform", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the platform is not known.", response = RestErrorResponse.class ) }) ResponseEntity<Void> addTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/start", method = RequestMethod.POST, produces = "application/hal+json" ) @ApiOperation( value = "Start a Transformation", tags = {"transformations"}, notes = "Starts a transformation that has been created and is ready to get started. To start a transformation, the " + "Transformation has to be in the state READY otherwise the transformation cannot start." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The state of the transformation is illegal. This means that the transformation is not in the" + "READY state. Therefore starting it is not possible", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity startTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/delete", method = RequestMethod.DELETE, produces = "application/hal+json" ) @ApiOperation( value = "Delete a transformation", tags = {"transformations"}, notes = "Deletes a transformation and all the coresponding artifacts" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The Deletion of the csar failed", response = Void.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> deleteTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs for a Transformation", tags = {"transformations"}, notes = "Returns the logs for a transformation, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getTransformationLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); @RequestMapping( path = "/{platform}/artifact", method = RequestMethod.GET, produces = "application/octet-stream" ) @ApiOperation( value = "Download the target artifact archive", tags = {"transformations"}, notes = "Once the transformation is done (in the state DONE) or it has encountered a error (state ERROR). " + "It is possible to download a archive (ZIP format) of all the files generated while the transformation was " + "running." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "There is nothing to download yet because the execution of the transformation has not yet started " + "or is not finished (With or without errors)", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> getTransformationArtifact(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarName,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform,
HttpServletResponse response
); @RequestMapping( path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Retrieve the inputs of this transformation", tags = {"transformations"}, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<GetInputsResponse> getInputs(
@ApiParam(value = "The identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @RequestMapping( path = "/{platform}/inputs", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/json" ) @ApiOperation( value = "Set the value of inputs", tags = {"transformations"}, notes = "With this method it is possible to set the value of an input or multiple inputs at once. The values " + "of inputs can be set as long as they are in the READY or INPUT_REQUIRED state. The transformation changes its state " + "to ready once all required inputs have a valid value assigned to them." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = Void.class ), @ApiResponse( code = 400, message = "Inputs cannot get set once the transformation has been started.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform.", response = RestErrorResponse.class ), @ApiResponse( code = 406, message = "At least one of the inputs could not get set because either the key does not exist or the " + "syntax validation of the value has failed.", response = InputsResponse.class ) }) ResponseEntity<InputsResponse> setInputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@RequestBody InputsResponse propertiesRequest
); @ApiOperation( value = "Retrieve the outputs and their values", tags = {"transformations"}, notes = "This operation returns the outputs of a deployment. Retrieval of the outputs is not possible " + "if the transformation (including deployment) is not done yet" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetOutputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform", response = RestErrorResponse.class ), @ApiResponse( code = 400, message = "The state of the transformation is invalid (not ERROR or DONE)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{platform}/outputs", method = {RequestMethod.GET}, produces = "application/hal+json" ) ResponseEntity<GetOutputsResponse> getOutputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Cannot delete csar with running transformations") @ExceptionHandler(IndexOutOfBoundsException.class) void handleLogIndexLessThanZero(); } | @Test public void getInputsTest() throws Exception { preInitNonCreationTests(); MvcResult result = mvc.perform( get(INPUTS_VALID_URL) ).andDo(print()) .andExpect(status().is(200)) .andExpect(content().contentType(DEFAULT_CHARSET_HAL_JSON)) .andExpect(jsonPath("$.inputs").isArray()) .andExpect(jsonPath("$.inputs").isNotEmpty()) .andExpect(jsonPath("$.inputs[0].key").isString()) .andExpect(jsonPath("$.inputs[0].type").isString()) .andExpect(jsonPath("$.inputs[0].description").isString()) .andExpect(jsonPath("$.inputs[0].required").isBoolean()) .andExpect(jsonPath("$.links[0].rel").value("self")) .andExpect(jsonPath("$.links[0].href") .value("http: .andReturn(); MockHttpServletResponse response = result.getResponse(); String responseJson = new String(response.getContentAsByteArray()); String[] values = JsonPath.parse(responseJson).read("$.inputs[*].value", String[].class); long nullCount = Arrays.asList(values).stream().filter(Objects::isNull).count(); long testCount = Arrays.asList(values).stream().filter(e -> e != null && e.equals(INPUT_TEST_DEFAULT_VALUE)).count(); assertEquals(8, nullCount); assertEquals(1, testCount); }
@Test public void getInputsTest2() throws Exception { preInitNonCreationTests(); String inputKey = "secret_input"; String inputValue = "geheim"; csarService.getCsar(VALID_CSAR_NAME) .get().getTransformation(VALID_PLATFORM_NAME).get() .getInputs().set(inputKey, inputValue); MvcResult result = mvc.perform( get(INPUTS_VALID_URL) ).andDo(print()) .andExpect(status().is(200)) .andExpect(content().contentType(DEFAULT_CHARSET_HAL_JSON)) .andReturn(); JSONArray obj = new JSONObject(result.getResponse().getContentAsString()).getJSONArray("inputs"); boolean valueFound = false; boolean restNull = true; for (int i = 0; i < obj.length(); i++) { JSONObject content = obj.getJSONObject(i); if (content.getString("key").equals(inputKey)) { valueFound = content.getString("value").equals(inputValue); } else { restNull = restNull && (content.isNull("value") || content.getString("value").equals(INPUT_TEST_DEFAULT_VALUE)); } } assertTrue("Could not find valid value in property list", valueFound); assertTrue("Not all other values in property list are null or equal to the default value", restNull); } |
TransformationController { @RequestMapping( path = "/{platform}/delete", method = RequestMethod.DELETE, produces = "application/hal+json" ) @ApiOperation( value = "Delete a transformation", tags = {"transformations"}, notes = "Deletes a transformation and all the coresponding artifacts" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The Deletion of the csar failed", response = Void.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) public ResponseEntity<Void> deleteTransformation( @ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String name, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platform ) { Csar csar = findByCsarId(name); Transformation transformation = findTransformationByPlatform(csar, platform); if (transformationService.deleteTransformation(transformation)) { return ResponseEntity.ok().build(); } else { return ResponseEntity.status(400).build(); } } @Autowired TransformationController(CsarService csarService,
TransformationService transformationService,
PlatformService platformService); @RequestMapping( path = "", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "List all transformations of a CSAR", tags = {"transformations", "csars"}, notes = "Returns a HAL-Resources list containing all Transformations for a specific CSAR" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = TransformationResources.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier", response = RestErrorResponse.class ) }) ResponseEntity<Resources<TransformationResponse>> getCSARTransformations(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name
); @RequestMapping( path = "/{platform}", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get details for a specific transformation", tags = {"transformations"}, notes = "Returns a HAL-Resource Containing the details for the transformation with the given parameters" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<TransformationResponse> getCSARTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/create", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/hal+json" ) @ApiOperation( value = "Create a new Transformation", tags = {"transformations"}, notes = "Creates a new transformation for the given CSAR and Platform " + "(If the platform does not exist and there is no other transformation with the same CSAR and Platform, " + "you have to delete the old transformation in this case)" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The transfomation could not get created because there already is a Transformation" + " of this CSAR on the given Platform", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the platform is not known.", response = RestErrorResponse.class ) }) ResponseEntity<Void> addTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/start", method = RequestMethod.POST, produces = "application/hal+json" ) @ApiOperation( value = "Start a Transformation", tags = {"transformations"}, notes = "Starts a transformation that has been created and is ready to get started. To start a transformation, the " + "Transformation has to be in the state READY otherwise the transformation cannot start." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The state of the transformation is illegal. This means that the transformation is not in the" + "READY state. Therefore starting it is not possible", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity startTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/delete", method = RequestMethod.DELETE, produces = "application/hal+json" ) @ApiOperation( value = "Delete a transformation", tags = {"transformations"}, notes = "Deletes a transformation and all the coresponding artifacts" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "The Deletion of the csar failed", response = Void.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> deleteTransformation(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String name,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform
); @RequestMapping( path = "/{platform}/logs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Get the logs for a Transformation", tags = {"transformations"}, notes = "Returns the logs for a transformation, starting at a specific position. from the given start index all " + "following log lines get returned. If the start index is larger than the current last log index the operation " + "will return a empty list." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = LogResponse.class ), @ApiResponse( code = 400, message = "The given start value is less than zero", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<LogResponse> getTransformationLogs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@ApiParam(value = "The index of the first log entry you want (0 returns the whole log)", required = true, example = "0")
@RequestParam(name = "start", required = false, defaultValue = "0") Long start
); @RequestMapping( path = "/{platform}/artifact", method = RequestMethod.GET, produces = "application/octet-stream" ) @ApiOperation( value = "Download the target artifact archive", tags = {"transformations"}, notes = "Once the transformation is done (in the state DONE) or it has encountered a error (state ERROR). " + "It is possible to download a archive (ZIP format) of all the files generated while the transformation was " + "running." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully" ), @ApiResponse( code = 400, message = "There is nothing to download yet because the execution of the transformation has not yet started " + "or is not finished (With or without errors)", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<Void> getTransformationArtifact(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarName,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platform,
HttpServletResponse response
); @RequestMapping( path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json" ) @ApiOperation( value = "Retrieve the inputs of this transformation", tags = {"transformations"}, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class ) }) ResponseEntity<GetInputsResponse> getInputs(
@ApiParam(value = "The identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @RequestMapping( path = "/{platform}/inputs", method = {RequestMethod.POST, RequestMethod.PUT}, produces = "application/json" ) @ApiOperation( value = "Set the value of inputs", tags = {"transformations"}, notes = "With this method it is possible to set the value of an input or multiple inputs at once. The values " + "of inputs can be set as long as they are in the READY or INPUT_REQUIRED state. The transformation changes its state " + "to ready once all required inputs have a valid value assigned to them." ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = Void.class ), @ApiResponse( code = 400, message = "Inputs cannot get set once the transformation has been started.", response = RestErrorResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform.", response = RestErrorResponse.class ), @ApiResponse( code = 406, message = "At least one of the inputs could not get set because either the key does not exist or the " + "syntax validation of the value has failed.", response = InputsResponse.class ) }) ResponseEntity<InputsResponse> setInputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId,
@RequestBody InputsResponse propertiesRequest
); @ApiOperation( value = "Retrieve the outputs and their values", tags = {"transformations"}, notes = "This operation returns the outputs of a deployment. Retrieval of the outputs is not possible " + "if the transformation (including deployment) is not done yet" ) @ApiResponses({ @ApiResponse( code = 200, message = "The operation was executed successfully", response = GetOutputsResponse.class ), @ApiResponse( code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform", response = RestErrorResponse.class ), @ApiResponse( code = 400, message = "The state of the transformation is invalid (not ERROR or DONE)", response = RestErrorResponse.class ) }) @RequestMapping( path = "/{platform}/outputs", method = {RequestMethod.GET}, produces = "application/hal+json" ) ResponseEntity<GetOutputsResponse> getOutputs(
@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test")
@PathVariable(name = "csarId") String csarId,
@ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes")
@PathVariable(name = "platform") String platformId
); @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Cannot delete csar with running transformations") @ExceptionHandler(IndexOutOfBoundsException.class) void handleLogIndexLessThanZero(); } | @Test public void deleteTransformation() throws Exception { preInitNonCreationTests(); when(transformationService.deleteTransformation(any(Transformation.class))).thenReturn(true); mvc.perform( delete(DELETE_TRANSFORMATION_VALID_URL) ).andDo(print()) .andExpect(status().is(200)) .andReturn(); }
@Test public void deleteTransformationStillRunning() throws Exception { preInitNonCreationTests(); when(transformationService.deleteTransformation(any(Transformation.class))).thenReturn(false); mvc.perform( delete(DELETE_TRANSFORMATION_VALID_URL) ).andDo(print()) .andExpect(status().is(400)) .andReturn(); } |
NamingUtil { public static String getUniqueName(final String suggestedName, final Set<String> existingNames) { String name = suggestedName != null ? suggestedName.trim() : ""; if (name.isEmpty()) name = "UNDEFINED"; if (existingNames != null && !existingNames.isEmpty()) { if (!isNameTaken(name, existingNames)) return name; Matcher m = PATTERN.matcher(name); int start = 0; if (m.matches()) { name = name.substring(0, m.start(1) - 1); start = Integer.decode(m.group(1)); } for (int i = start; true; i++) { final String numberedName = name + "(" + (i + 1) + ")"; if (!isNameTaken(numberedName, existingNames)) return numberedName; } } return name; } private NamingUtil(); static String getUniqueName(final String suggestedName, final Set<String> existingNames); } | @Test public void testGetUniqueName() { Set<String> names = Sets.newSet( "My Name A", "My Name B", "My Name B(1)", "My Name B(3)", "My Name C(1)", "My Name D_1", "My Name E (1)" ); assertEquals("My Name", NamingUtil.getUniqueName("My Name", names)); assertEquals("My Name", NamingUtil.getUniqueName(" My Name \t", names)); assertEquals("My Name a", NamingUtil.getUniqueName("My Name a", names)); assertEquals("My Name A(1)", NamingUtil.getUniqueName("My Name A", names)); assertEquals("My Name A(1)", NamingUtil.getUniqueName("My Name A(1)", names)); assertEquals("My Name A(01)", NamingUtil.getUniqueName("My Name A(01)", names)); assertEquals("My Name A_1", NamingUtil.getUniqueName("My Name A_1", names)); assertEquals("My Name B(2)", NamingUtil.getUniqueName("My Name B", names)); assertEquals("My Name B(4)", NamingUtil.getUniqueName("My Name B(3)", names)); assertEquals("My Name B(2)", NamingUtil.getUniqueName("My Name B(2)", names)); assertEquals("My Name C(2)", NamingUtil.getUniqueName("My Name C(1)", names)); assertEquals("My Name D", NamingUtil.getUniqueName("My Name D", names)); assertEquals("My Name D(1)", NamingUtil.getUniqueName("My Name D(1)", names)); assertEquals("My Name E (2)", NamingUtil.getUniqueName("My Name E (1)", names)); } |
LinearNumberInterpolator { public LinearNumberInterpolator(double lowerDomain, double upperDomain, double lowerRange, double upperRange) { this.lowerDomain = lowerDomain; this.lowerRange = lowerRange; this.upperDomain = upperDomain; this.upperRange = upperRange; } LinearNumberInterpolator(double lowerDomain, double upperDomain, double lowerRange, double upperRange); double getRangeValue(double domainValue); LinearNumberInterpolator withDomainCutoff(final double lowerValue, final double upperValue); } | @Test public void testLinearNumberInterpolator() { LinearNumberInterpolator interpolator = new LinearNumberInterpolator(0.5, 1.0, 0.0, 5.0); assertDouble(0.0, interpolator.getRangeValue(0.5)); assertDouble(1.0, interpolator.getRangeValue(0.6)); assertDouble(2.0, interpolator.getRangeValue(0.7)); assertDouble(3.0, interpolator.getRangeValue(0.8)); assertDouble(4.0, interpolator.getRangeValue(0.9)); assertDouble(5.0, interpolator.getRangeValue(1.0)); assertDouble(-1.0, interpolator.getRangeValue(0.4)); assertDouble(6.0, interpolator.getRangeValue(1.1)); } |
PathUtil { private PathUtil() {} private PathUtil(); static List<Path> dataSetsRoots(Collection<DataSetParameters> dataSets); static Path commonRoot(List<Path> paths); static Path commonRoot(Path p1, Path p2); } | @Test public void testPathUtil() { { Path c = PathUtil.commonRoot(plist("/a/b/c", "/a/b/d")); assertEquals(Paths.get("/a/b"), c); } { Path c = PathUtil.commonRoot(plist("/a/b/c/d/e", "/a/b/c/x/y", "/a/b/q/w")); assertEquals(Paths.get("/a/b"), c); } { Path c = PathUtil.commonRoot(plist("/x/y/z", "/a/b/d")); assertEquals(Paths.get("/"), c); } { Path c = PathUtil.commonRoot(plist("/", "/a/b/d")); assertEquals(Paths.get("/"), c); } { Path c = PathUtil.commonRoot(plist("/x/y/z", "a/b/d")); assertNull(c); } { Path c = PathUtil.commonRoot(plist("/x/y/z", null)); assertNull(c); } } |
SimilarityKey { public SimilarityKey(String geneSet1, String geneSet2, String interaction, String name) { Objects.requireNonNull(geneSet1); Objects.requireNonNull(interaction); Objects.requireNonNull(geneSet2); this.geneSet1 = geneSet1; this.geneSet2 = geneSet2; this.interaction = interaction; this.name = name; } SimilarityKey(String geneSet1, String geneSet2, String interaction, String name); String getGeneSet1(); String getGeneSet2(); String getInteraction(); boolean isCompound(); String getName(); @Override int hashCode(); @Override boolean equals(Object o); String getCompoundName(); @Override String toString(); final String geneSet1; final String geneSet2; final String interaction; final String name; } | @Test public void testSimilarityKey() { SimilarityKey k1 = new SimilarityKey("A", "B", "i", null); SimilarityKey k1p = new SimilarityKey("A", "B", "i", null); SimilarityKey k2 = new SimilarityKey("B", "A", "i", null); SimilarityKey k3 = new SimilarityKey("D", "C", "x", null); SimilarityKey k4 = new SimilarityKey("A", "B", "x", null); assertEquals(k1, k1); assertEquals(k1, k1p); assertEquals(k1, k2); assertEquals(k2, k1); assertNotEquals(k1, k3); assertNotEquals(k1, k4); Set<SimilarityKey> keys = new HashSet<>(); Collections.addAll(keys, k1, k1p, k2, k3); assertEquals(2, keys.size()); } |
SimilarityKey { @Override public int hashCode() { return Objects.hash(geneSet1.hashCode() + geneSet2.hashCode(), interaction, name); } SimilarityKey(String geneSet1, String geneSet2, String interaction, String name); String getGeneSet1(); String getGeneSet2(); String getInteraction(); boolean isCompound(); String getName(); @Override int hashCode(); @Override boolean equals(Object o); String getCompoundName(); @Override String toString(); final String geneSet1; final String geneSet2; final String interaction; final String name; } | @Test public void testSimilarityKeyHashCode() { SimilarityKey k1 = new SimilarityKey("A", "B", "i", null); SimilarityKey k1p = new SimilarityKey("A", "B", "i", null); SimilarityKey k2 = new SimilarityKey("B", "A", "i", null); SimilarityKey k3 = new SimilarityKey("D", "C", "x", null); SimilarityKey k4 = new SimilarityKey("A", "B", "x", null); assertEquals(k1.hashCode(), k1p.hashCode()); assertEquals(k1.hashCode(), k2.hashCode()); assertEquals(k2.hashCode(), k1.hashCode()); assertNotEquals(k1.hashCode(), k3.hashCode()); assertNotEquals(k1.hashCode(), k4.hashCode()); } |
SimilarityKey { @Override public String toString() { return isCompound() ? getCompoundName() : String.format("%s (%s_%s) %s", geneSet1, interaction, name, geneSet2); } SimilarityKey(String geneSet1, String geneSet2, String interaction, String name); String getGeneSet1(); String getGeneSet2(); String getInteraction(); boolean isCompound(); String getName(); @Override int hashCode(); @Override boolean equals(Object o); String getCompoundName(); @Override String toString(); final String geneSet1; final String geneSet2; final String interaction; final String name; } | @Test public void testSimilarityKeyToString() { SimilarityKey k1 = new SimilarityKey("A", "B", "i", null); SimilarityKey k2 = new SimilarityKey("A", "B", "i", "1"); SimilarityKey k3 = new SimilarityKey("A", "B", "i", "2"); assertEquals("A (i) B", k1.toString()); assertEquals("A (i_1) B", k2.toString()); assertEquals("A (i_2) B", k3.toString()); } |
OpenPathwayCommonsTask extends AbstractTask { public String getPathwayCommonsURL() { EnrichmentMap map = emManager.getEnrichmentMap(network.getSUID()); if(map == null) return null; int port = Integer.parseInt(cy3props.getProperties().getProperty("rest.port")); String pcBaseUri = propertyManager.getValue(PropertyManager.PATHWAY_COMMONS_URL); String nodeLabel = getNodeLabel(map); try { String returnPath; if(node == null) returnPath = "/enrichmentmap/expressions/heatmap"; else returnPath = String.format("/enrichmentmap/expressions/%s/%s", network.getSUID(), node.getSUID()); String returnUri = new URIBuilder() .setScheme("http") .setHost("localhost") .setPath(returnPath) .setPort(port) .build() .toString(); String pcUri = new URIBuilder(pcBaseUri) .addParameter("uri", returnUri) .addParameter("q", nodeLabel) .build() .toString(); return pcUri; } catch(URISyntaxException e) { e.printStackTrace(); return null; } } @AssistedInject OpenPathwayCommonsTask(@Assisted CyNetwork network, @Assisted CyNode node); @AssistedInject OpenPathwayCommonsTask(@Assisted CyNetwork network); String getPathwayCommonsURL(); @Override void run(TaskMonitor taskMonitor); static final String DEFAULT_BASE_URL; } | @Test public void testPathwayCommonsTask( CyNetworkManager networkManager, OpenBrowser openBrowser, PropertyManager propertyManager, OpenPathwayCommonsTask.Factory pathwayCommonsTaskFactory ) { CyNetwork network = networkManager.getNetwork(map.getNetworkID()); CyNode node = TestUtils.getNodes(network).get("TOP1_PLUS100"); propertyManager.setValue(PropertyManager.PATHWAY_COMMONS_URL, "http: @SuppressWarnings("deprecation") String returnUri = URLEncoder.encode("http: String expectedUri = "http: OpenPathwayCommonsTask task = pathwayCommonsTaskFactory.create(network, node); String uri = task.getPathwayCommonsURL(); assertEquals(expectedUri, uri); } |
SpyEventHandlerSupport { void addSpyEventHandler( @Nonnull final SpyEventHandler handler ) { if ( Arez.shouldCheckApiInvariants() ) { apiInvariant( () -> !_spyEventHandlers.contains( handler ), () -> "Arez-0102: Attempting to add handler " + handler + " that is already " + "in the list of spy handlers." ); } _spyEventHandlers.add( Objects.requireNonNull( handler ) ); } } | @Test public void addSpyEventHandler_alreadyExists() { final SpyEventHandlerSupport support = new SpyEventHandlerSupport(); final SpyEventHandler handler = new TestSpyEventHandler( Arez.context() ); support.addSpyEventHandler( handler ); assertInvariantFailure( () -> support.addSpyEventHandler( handler ), "Arez-0102: Attempting to add handler " + handler + " that is already " + "in the list of spy handlers." ); } |
ArezContext { public <T> T action( @Nonnull final Function<T> executable ) throws Throwable { return action( executable, 0 ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void verifyActionFlags_badVerifyAction() { final Procedure executable = () -> { }; assertInvariantFailure( () -> Arez.context() .action( executable, ActionFlags.VERIFY_ACTION_REQUIRED | ActionFlags.NO_VERIFY_ACTION_REQUIRED ), "Arez-0127: Flags passed to action 'Action@1' include both VERIFY_ACTION_REQUIRED and NO_VERIFY_ACTION_REQUIRED." ); }
@Test public void action_procedure_verifyActionRequired_false() throws Throwable { final Procedure executable = ValueUtil::randomString; Arez.context().action( executable, ActionFlags.NO_VERIFY_ACTION_REQUIRED ); }
@Test public void action_procedure_verifyActionRequired_true_butInvariantsDisabled() throws Throwable { ArezTestUtil.noCheckInvariants(); final Procedure executable = ValueUtil::randomString; Arez.context().action( executable, ActionFlags.VERIFY_ACTION_REQUIRED ); }
@Test public void action_procedure_verifyActionRequired_true() { final Procedure procedure = ValueUtil::randomString; assertInvariantFailure( () -> Arez.context().action( "X", procedure, ActionFlags.VERIFY_ACTION_REQUIRED ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void action_procedure_verifyActionRequired_true_is_default() { assertInvariantFailure( () -> Arez.context().action( "X", (Procedure) ValueUtil::randomString ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void action_function_verifyActionRequired_false() throws Throwable { Arez.context().action( (Function<String>) ValueUtil::randomString, ActionFlags.NO_VERIFY_ACTION_REQUIRED ); }
@Test public void action_function_verifyActionRequired_true_butInvariantsDisabled() throws Throwable { ArezTestUtil.noCheckInvariants(); Arez.context().action( (Function<String>) ValueUtil::randomString, ActionFlags.VERIFY_ACTION_REQUIRED ); }
@Test public void action_function_verifyActionRequired_true() { final Function<String> function = ValueUtil::randomString; assertInvariantFailure( () -> Arez.context().action( "X", function, ActionFlags.VERIFY_ACTION_REQUIRED ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void action_function_verifyActionRequired_true_is_default() { final Function<String> function = ValueUtil::randomString; assertInvariantFailure( () -> Arez.context().action( "X", function ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void verifyActionFlags_badTransactionFlags() { final Procedure executable = () -> { }; assertInvariantFailure( () -> Arez.context() .action( executable, ActionFlags.READ_ONLY | ActionFlags.READ_WRITE ), "Arez-0126: Flags passed to action 'Action@1' include both READ_ONLY and READ_WRITE." ); } |
ArezContext { public <T> T safeAction( @Nonnull final SafeFunction<T> executable ) { return safeAction( executable, 0 ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void safeAction_procedure_verifyActionRequired_false() { final SafeProcedure procedure = ValueUtil::randomString; Arez.context().safeAction( ValueUtil.randomString(), procedure, ActionFlags.NO_VERIFY_ACTION_REQUIRED ); }
@Test public void safeAction_procedure_verifyActionRequired_true_butInvariantsDisabled() { ArezTestUtil.noCheckInvariants(); final SafeProcedure executable = ValueUtil::randomString; Arez.context().safeAction( ValueUtil.randomString(), executable, ActionFlags.VERIFY_ACTION_REQUIRED ); }
@Test public void safeAction_procedure_verifyActionRequired_true() { final SafeProcedure procedure = ValueUtil::randomString; assertInvariantFailure( () -> Arez.context().safeAction( "X", procedure, ActionFlags.VERIFY_ACTION_REQUIRED ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void safeAction_procedure_verifyActionRequired_true_is_default() { assertInvariantFailure( () -> Arez.context().safeAction( "X", (SafeProcedure) ValueUtil::randomString ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void safeAction_function_verifyActionRequired_false() { Arez.context().safeAction( (SafeFunction<String>) ValueUtil::randomString, ActionFlags.NO_VERIFY_ACTION_REQUIRED ); }
@Test public void safeAction_function_verifyActionRequired_true_butInvariantsDisabled() { ArezTestUtil.noCheckInvariants(); Arez.context().safeAction( (SafeFunction<String>) ValueUtil::randomString, ActionFlags.VERIFY_ACTION_REQUIRED ); }
@Test public void safeAction_function_verifyActionRequired_true() { final SafeFunction<String> function = ValueUtil::randomString; assertInvariantFailure( () -> Arez.context().safeAction( "X", function, ActionFlags.VERIFY_ACTION_REQUIRED ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); }
@Test public void safeAction_function_verifyActionRequired_true_is_default() { assertInvariantFailure( () -> Arez.context().safeAction( "X", (SafeFunction<String>) ValueUtil::randomString ), "Arez-0185: Action named 'X' completed but no reads, writes, schedules, reportStales or reportPossiblyChanged occurred within the scope of the action." ); } |
ObserverInfoImpl implements ObserverInfo { @Nonnull @Override public ComputableValueInfo asComputableValue() { return _observer.getComputableValue().asInfo(); } ObserverInfoImpl( @Nonnull final Spy spy, @Nonnull final Observer observer ); @Nonnull @Override String getName(); @Override boolean isActive(); @Override boolean isRunning(); @Override boolean isScheduled(); @Override boolean isComputableValue(); @Override boolean isReadOnly(); @Nonnull @Override Priority getPriority(); @Nonnull @Override ComputableValueInfo asComputableValue(); @Nonnull @Override List<ObservableValueInfo> getDependencies(); @Nullable @Override ComponentInfo getComponent(); @Override boolean isDisposed(); @Override String toString(); @Override boolean equals( final Object o ); @Override int hashCode(); } | @Test public void asComputableValue() { final ArezContext context = Arez.context(); final String name = ValueUtil.randomString(); final ComputableValue<String> computableValue = context.computable( name, () -> "" ); final Observer observer = computableValue.getObserver(); final ObserverInfo info = observer.asInfo(); assertEquals( info.getName(), name ); assertTrue( info.isComputableValue() ); assertEquals( info.asComputableValue().getName(), computableValue.getName() ); assertFalse( info.isActive() ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) public void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ) { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areObserverErrorHandlersEnabled, () -> "Arez-0182: ArezContext.addObserverErrorHandler() invoked when Arez.areObserverErrorHandlersEnabled() returns false." ); } getObserverErrorHandlerSupport().addObserverErrorHandler( handler ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void addObserverErrorHandler_whenDisabled() { ArezTestUtil.disableObserverErrorHandlers(); final ObserverErrorHandler handler = ( o, e, t ) -> { }; assertInvariantFailure( () -> Arez.context().addObserverErrorHandler( handler ), "Arez-0182: ArezContext.addObserverErrorHandler() invoked when Arez.areObserverErrorHandlersEnabled() returns false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) public void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ) { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areObserverErrorHandlersEnabled, () -> "Arez-0181: ArezContext.removeObserverErrorHandler() invoked when Arez.areObserverErrorHandlersEnabled() returns false." ); } getObserverErrorHandlerSupport().removeObserverErrorHandler( handler ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void removeObserverErrorHandler_whenDisabled() { ArezTestUtil.disableObserverErrorHandlers(); final ArezContext context = Arez.context(); final ObserverErrorHandler handler = ( o, e, t ) -> { }; assertInvariantFailure( () -> context.removeObserverErrorHandler( handler ), "Arez-0181: ArezContext.removeObserverErrorHandler() invoked when Arez.areObserverErrorHandlersEnabled() returns false." ); } |
ArezContext { void scheduleReaction( @Nonnull final Observer observer ) { if ( willPropagateSpyEvents() ) { getSpy().reportSpyEvent( new ObserveScheduleEvent( observer.asInfo() ) ); } if ( Arez.shouldEnforceTransactionType() && isTransactionActive() && Arez.shouldCheckInvariants() ) { invariant( () -> getTransaction().isMutation() || getTransaction().isComputableValueTracker(), () -> "Arez-0013: Observer named '" + observer.getName() + "' attempted to be scheduled during " + "read-only transaction." ); invariant( () -> getTransaction().getTracker() != observer || getTransaction().isMutation(), () -> "Arez-0014: Observer named '" + observer.getName() + "' attempted to schedule itself during " + "read-only tracking transaction. Observers that are supporting ComputableValue instances " + "must not schedule self." ); } _taskQueue.queueTask( observer.getTask() ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void scheduleReaction() { final ArezContext context = Arez.context(); final Observer observer = context.observer( new CountAndObserveProcedure() ); assertEquals( context.getTaskQueue().getOrderedTasks().count(), 0L ); context.scheduleReaction( observer ); assertEquals( context.getTaskQueue().getOrderedTasks().count(), 1L ); assertTrue( context.getTaskQueue().getOrderedTasks().anyMatch( o -> o == observer.getTask() ) ); } |
ObserverInfoImpl implements ObserverInfo { @Nullable @Override public ComponentInfo getComponent() { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areNativeComponentsEnabled, () -> "Arez-0108: Spy.getComponent invoked when Arez.areNativeComponentsEnabled() returns false." ); } final Component component = _observer.getComponent(); return null == component ? null : component.asInfo(); } ObserverInfoImpl( @Nonnull final Spy spy, @Nonnull final Observer observer ); @Nonnull @Override String getName(); @Override boolean isActive(); @Override boolean isRunning(); @Override boolean isScheduled(); @Override boolean isComputableValue(); @Override boolean isReadOnly(); @Nonnull @Override Priority getPriority(); @Nonnull @Override ComputableValueInfo asComputableValue(); @Nonnull @Override List<ObservableValueInfo> getDependencies(); @Nullable @Override ComponentInfo getComponent(); @Override boolean isDisposed(); @Override String toString(); @Override boolean equals( final Object o ); @Override int hashCode(); } | @Test public void getComponent_Observer_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final Spy spy = context.getSpy(); final Observer observer = context.observer( AbstractTest::observeADependency ); assertInvariantFailure( () -> spy.asObserverInfo( observer ).getComponent(), "Arez-0108: Spy.getComponent invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ArezContext { @Nonnull public <T> ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ) { return computable( function, 0 ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void computableValue() { final ArezContext context = Arez.context(); final String name = ValueUtil.randomString(); final SafeFunction<String> function = () -> { observeADependency(); return ""; }; final Procedure onActivate = ValueUtil::randomString; final Procedure onDeactivate = ValueUtil::randomString; final ComputableValue<String> computableValue = context.computable( null, name, function, onActivate, onDeactivate, ComputableValue.Flags.PRIORITY_HIGH ); assertEquals( computableValue.getName(), name ); assertEquals( computableValue.getContext(), context ); assertFalse( computableValue.getObserver().isKeepAlive() ); assertTrue( computableValue.getObserver().areArezDependenciesRequired() ); assertEquals( computableValue.getObservableValue().getName(), name ); assertEquals( computableValue.getOnActivate(), onActivate ); assertEquals( computableValue.getOnDeactivate(), onDeactivate ); assertEquals( computableValue.getObserver().getName(), name ); assertEquals( computableValue.getObserver().getTask().getPriority(), Priority.HIGH ); assertFalse( computableValue.getObserver().canObserveLowerPriorityDependencies() ); }
@Test public void computableValue_canObserveLowerPriorityDependencies() { final ComputableValue<String> computableValue = Arez.context().computable( () -> "", ComputableValue.Flags.OBSERVE_LOWER_PRIORITY_DEPENDENCIES ); assertTrue( computableValue.getObserver().canObserveLowerPriorityDependencies() ); }
@Test public void computableValue_mayNotAccessArezState() { final ArezContext context = Arez.context(); assertFalse( context.computable( () -> "", ComputableValue.Flags.AREZ_OR_NO_DEPENDENCIES ) .getObserver() .areArezDependenciesRequired() ); assertFalse( context.computable( () -> "", ComputableValue.Flags.AREZ_OR_EXTERNAL_DEPENDENCIES ) .getObserver() .areArezDependenciesRequired() ); }
@Test public void computableValue_withKeepAliveAndRunImmediately() { final ArezContext context = Arez.context(); final AtomicInteger calls = new AtomicInteger(); final SafeFunction<String> action = () -> { observeADependency(); calls.incrementAndGet(); return ""; }; final ComputableValue<String> computableValue = context.computable( action, ComputableValue.Flags.KEEPALIVE | ComputableValue.Flags.RUN_NOW ); assertTrue( computableValue.getObserver().isKeepAlive() ); assertEquals( calls.get(), 1 ); }
@Test public void computableValue_pass_no_hooks() { final ArezContext context = Arez.context(); final String name = ValueUtil.randomString(); final SafeFunction<String> function = () -> { observeADependency(); return ""; }; final ComputableValue<String> computableValue = context.computable( name, function ); assertEquals( computableValue.getName(), name ); assertEquals( computableValue.getContext(), context ); assertEquals( computableValue.getObserver().getName(), name ); assertEquals( computableValue.getObservableValue().getName(), name ); assertNull( computableValue.getOnActivate() ); assertNull( computableValue.getOnDeactivate() ); assertEquals( computableValue.getObserver().getTask().getPriority(), Priority.NORMAL ); }
@Test public void computableValue_generates_spyEvent() { final ArezContext context = Arez.context(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final ComputableValue<String> computableValue = context.computable( ValueUtil.randomString(), () -> { observeADependency(); return ""; } ); handler.assertEventCount( 1 ); handler.assertNextEvent( ComputableValueCreateEvent.class, event -> assertEquals( event.getComputableValue().getName(), computableValue.getName() ) ); } |
ArezContext { @Nonnull public Observer observer( @Nonnull final Procedure observe ) { return observer( observe, 0 ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void autorun_noObservers_manualReportStaleAllowed() { ignoreObserverErrors(); final ArezContext context = Arez.context(); final AtomicInteger callCount = new AtomicInteger(); context.observer( callCount::incrementAndGet, Observer.Flags.AREZ_OR_EXTERNAL_DEPENDENCIES ); assertEquals( callCount.get(), 1 ); assertEquals( getObserverErrors().size(), 0 ); }
@Test public void autorun_highPriority() { final ArezContext context = Arez.context(); final Observer observer = context.observer( AbstractTest::observeADependency, Observer.Flags.PRIORITY_HIGH ); assertEquals( observer.getTask().getPriority(), Priority.HIGH ); }
@Test public void autorun_canObserveLowerPriorityDependencies() { final ArezContext context = Arez.context(); final Observer observer = context.observer( AbstractTest::observeADependency, Observer.Flags.OBSERVE_LOWER_PRIORITY_DEPENDENCIES ); assertTrue( observer.canObserveLowerPriorityDependencies() ); }
@Test public void autorun_nestedActionsAllowed() { final ArezContext context = Arez.context(); final Observer observer = context.observer( AbstractTest::observeADependency, Observer.Flags.NESTED_ACTIONS_ALLOWED ); assertTrue( observer.nestedActionsAllowed() ); }
@Test public void observer_areArezDependenciesRequired() { final ArezContext context = Arez.context(); final Procedure observe = AbstractTest::observeADependency; assertFalse( context.observer( observe, Observer.Flags.AREZ_OR_EXTERNAL_DEPENDENCIES ) .areArezDependenciesRequired() ); assertFalse( context.observer( observe, Observer.Flags.AREZ_OR_NO_DEPENDENCIES ).areArezDependenciesRequired() ); assertTrue( context.observer( observe, Observer.Flags.AREZ_DEPENDENCIES ).areArezDependenciesRequired() ); }
@Test public void autorun_supportsManualSchedule() { final ArezContext context = Arez.context(); final Observer observer = context.observer( AbstractTest::observeADependency, ValueUtil::randomString ); assertTrue( observer.supportsManualSchedule() ); } |
ObserverInfoImpl implements ObserverInfo { @Override public int hashCode() { return _observer.hashCode(); } ObserverInfoImpl( @Nonnull final Spy spy, @Nonnull final Observer observer ); @Nonnull @Override String getName(); @Override boolean isActive(); @Override boolean isRunning(); @Override boolean isScheduled(); @Override boolean isComputableValue(); @Override boolean isReadOnly(); @Nonnull @Override Priority getPriority(); @Nonnull @Override ComputableValueInfo asComputableValue(); @Nonnull @Override List<ObservableValueInfo> getDependencies(); @Nullable @Override ComponentInfo getComponent(); @Override boolean isDisposed(); @Override String toString(); @Override boolean equals( final Object o ); @Override int hashCode(); } | @SuppressWarnings( "EqualsWithItself" ) @Test public void equalsAndHashCode() { final ArezContext context = Arez.context(); final ObservableValue<Object> observableValue = context.observable(); final Observer observer1 = context.observer( ValueUtil.randomString(), observableValue::reportObserved ); final Observer observer2 = context.observer( ValueUtil.randomString(), observableValue::reportObserved ); final ObserverInfo info1a = observer1.asInfo(); final ObserverInfo info1b = new ObserverInfoImpl( context.getSpy(), observer1 ); final ObserverInfo info2 = observer2.asInfo(); assertNotEquals( info1a, "" ); assertEquals( info1a, info1a ); assertEquals( info1b, info1a ); assertNotEquals( info2, info1a ); assertEquals( info1a, info1b ); assertEquals( info1b, info1b ); assertNotEquals( info2, info1b ); assertNotEquals( info1a, info2 ); assertNotEquals( info1b, info2 ); assertEquals( info2, info2 ); assertEquals( info1a.hashCode(), observer1.hashCode() ); assertEquals( info1a.hashCode(), info1b.hashCode() ); assertEquals( info2.hashCode(), observer2.hashCode() ); } |
ArezContext { @Nonnull public Observer tracker( @Nonnull final Procedure onDepsChange ) { return tracker( onDepsChange, 0 ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void tracker() { final ArezContext context = Arez.context(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final String name = ValueUtil.randomString(); final AtomicInteger callCount = new AtomicInteger(); final Observer observer = context.tracker( null, name, callCount::incrementAndGet, Observer.Flags.PRIORITY_HIGH | Observer.Flags.OBSERVE_LOWER_PRIORITY_DEPENDENCIES | Observer.Flags.NESTED_ACTIONS_ALLOWED | Observer.Flags.AREZ_OR_NO_DEPENDENCIES ); assertEquals( observer.getName(), name ); assertFalse( observer.isMutation() ); assertEquals( observer.getState(), Observer.Flags.STATE_INACTIVE ); assertNull( observer.getComponent() ); assertEquals( observer.getTask().getPriority(), Priority.HIGH ); assertTrue( observer.canObserveLowerPriorityDependencies() ); assertTrue( observer.isApplicationExecutor() ); assertTrue( observer.nestedActionsAllowed() ); assertFalse( observer.areArezDependenciesRequired() ); assertFalse( observer.supportsManualSchedule() ); assertEquals( callCount.get(), 0 ); assertEquals( context.getTaskQueue().getOrderedTasks().count(), 0L ); handler.assertEventCount( 1 ); handler.assertNextEvent( ObserverCreateEvent.class, e -> assertEquals( e.getObserver().getName(), observer.getName() ) ); } |
ArezContext { @Nonnull public <T> ObservableValue<T> observable() { return observable( null ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void createObservable() { final ArezContext context = Arez.context(); final String name = ValueUtil.randomString(); final ObservableValue<?> observableValue = context.observable( name ); assertEquals( observableValue.getName(), name ); assertNull( observableValue.getAccessor() ); assertNull( observableValue.getMutator() ); }
@Test public void createObservable_withIntrospectors() { final ArezContext context = Arez.context(); final String name = ValueUtil.randomString(); final PropertyAccessor<String> accessor = () -> ""; final PropertyMutator<String> mutator = v -> { }; final ObservableValue<?> observableValue = context.observable( name, accessor, mutator ); assertEquals( observableValue.getName(), name ); assertEquals( observableValue.getAccessor(), accessor ); assertEquals( observableValue.getMutator(), mutator ); }
@Test public void createObservable_spyEventHandlerPresent() { final ArezContext context = Arez.context(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final String name = ValueUtil.randomString(); final ObservableValue<?> observableValue = context.observable( name ); assertEquals( observableValue.getName(), name ); handler.assertEventCount( 1 ); handler.assertNextEvent( ObservableValueCreateEvent.class, e -> assertEquals( e.getObservableValue().getName(), observableValue.getName() ) ); }
@Test public void createObservable_name_Null() { ArezTestUtil.disableNames(); final ArezContext context = Arez.context(); final ObservableValue<?> observableValue = context.observable( null ); assertNotNull( observableValue ); } |
ArezContext { @Nonnull public SchedulerLock pauseScheduler() { _schedulerLockCount++; return new SchedulerLock( Arez.areZonesEnabled() ? this : null ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void pauseScheduler() { final ArezContext context = Arez.context(); assertFalse( context.isSchedulerPaused() ); assertEquals( context.getSchedulerLockCount(), 0 ); final SchedulerLock lock1 = context.pauseScheduler(); assertEquals( context.getSchedulerLockCount(), 1 ); assertTrue( context.isSchedulerPaused() ); final AtomicInteger callCount = new AtomicInteger(); context.observer( () -> { observeADependency(); callCount.incrementAndGet(); }, Observer.Flags.RUN_LATER ); context.triggerScheduler(); assertEquals( callCount.get(), 0 ); final SchedulerLock lock2 = context.pauseScheduler(); assertEquals( context.getSchedulerLockCount(), 2 ); assertTrue( context.isSchedulerPaused() ); lock2.dispose(); assertEquals( context.getSchedulerLockCount(), 1 ); lock2.dispose(); assertEquals( context.getSchedulerLockCount(), 1 ); assertTrue( context.isSchedulerPaused() ); assertEquals( callCount.get(), 0 ); lock1.dispose(); assertEquals( context.getSchedulerLockCount(), 0 ); assertEquals( callCount.get(), 1 ); assertFalse( context.isSchedulerPaused() ); } |
ArezContext { void releaseSchedulerLock() { _schedulerLockCount--; if ( Arez.shouldCheckInvariants() ) { invariant( () -> _schedulerLockCount >= 0, () -> "Arez-0016: releaseSchedulerLock() reduced schedulerLockCount below 0." ); } triggerScheduler(); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void releaseSchedulerLock_whenNoLock() { assertInvariantFailure( () -> Arez.context().releaseSchedulerLock(), "Arez-0016: releaseSchedulerLock() reduced schedulerLockCount below 0." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull public Component component( @Nonnull final String type, @Nonnull final Object id ) { return component( type, id, Arez.areNamesEnabled() ? type + "@" + id : null ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void createComponent_spyEventHandlerPresent() { final ArezContext context = Arez.context(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final Component component = context.component( ValueUtil.randomString(), ValueUtil.randomString(), ValueUtil.randomString() ); handler.assertEventCount( 1 ); handler.assertNextEvent( ComponentCreateStartEvent.class, event -> assertEquals( event.getComponentInfo().getName(), component.getName() ) ); }
@Test public void createComponent_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final String type = ValueUtil.randomString(); final String id = ValueUtil.randomString(); final String name = ValueUtil.randomString(); assertInvariantFailure( () -> context.component( type, id, name ), "Arez-0008: ArezContext.component() invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ComputableValueInfoImpl implements ComputableValueInfo { @Override public boolean isComputing() { return _computableValue.isComputing(); } ComputableValueInfoImpl( @Nonnull final ComputableValue<?> computableValue ); @Nonnull @Override String getName(); @Override boolean isComputing(); @Nonnull @Override Priority getPriority(); @Override boolean isActive(); @Nonnull @Override List<ObservableValueInfo> getDependencies(); @Nonnull @Override List<ObserverInfo> getObservers(); @Nullable @Override ComponentInfo getComponent(); @OmitSymbol( unless = "arez.enable_property_introspection" ) @Nullable @Override Object getValue(); @Override boolean isDisposed(); @Override String toString(); @Override boolean equals( final Object o ); @Override int hashCode(); } | @Test public void isComputing() { final ArezContext context = Arez.context(); final Spy spy = context.getSpy(); final ComputableValue<String> computableValue = context.computable( () -> "" ); assertFalse( spy.asComputableValueInfo( computableValue ).isComputing() ); computableValue.setComputing( true ); assertTrue( spy.asComputableValueInfo( computableValue ).isComputing() ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_native_components" ) public boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ) { apiInvariant( Arez::areNativeComponentsEnabled, () -> "Arez-0135: ArezContext.isComponentPresent() invoked when Arez.areNativeComponentsEnabled() returns false." ); return getComponentByTypeMap( type ).containsKey( id ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void isComponentPresent_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final String type = ValueUtil.randomString(); final String id = ValueUtil.randomString(); assertInvariantFailure( () -> context.isComponentPresent( type, id ), "Arez-0135: ArezContext.isComponentPresent() invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_native_components" ) void deregisterComponent( @Nonnull final Component component ) { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areNativeComponentsEnabled, () -> "Arez-0006: ArezContext.deregisterComponent() invoked when Arez.areNativeComponentsEnabled() returns false." ); } final String type = component.getType(); final Map<Object, Component> map = getComponentByTypeMap( type ); final Component removed = map.remove( component.getId() ); if ( Arez.shouldCheckInvariants() ) { invariant( () -> component == removed, () -> "Arez-0007: ArezContext.deregisterComponent() invoked for '" + component + "' but was " + "unable to remove specified component from registry. Actual component removed: " + removed ); } if ( map.isEmpty() ) { assert _components != null; _components.remove( type ); } } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void deregisterComponent_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final Component component = new Component( context, ValueUtil.randomString(), ValueUtil.randomString(), ValueUtil.randomString(), null, null ); assertInvariantFailure( () -> context.deregisterComponent( component ), "Arez-0006: ArezContext.deregisterComponent() invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_native_components" ) @Nullable Component findComponent( @Nonnull final String type, @Nonnull final Object id ) { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areNativeComponentsEnabled, () -> "Arez-0010: ArezContext.findComponent() invoked when Arez.areNativeComponentsEnabled() returns false." ); } assert null != _components; final Map<Object, Component> map = _components.get( type ); if ( null != map ) { return map.get( id ); } else { return null; } } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void findComponent_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final String type = ValueUtil.randomString(); final String id = ValueUtil.randomString(); assertInvariantFailure( () -> context.findComponent( type, id ), "Arez-0010: ArezContext.findComponent() invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Collection<Component> findAllComponentsByType( @Nonnull final String type ) { if ( Arez.shouldCheckInvariants() ) { invariant( Arez::areNativeComponentsEnabled, () -> "Arez-0011: ArezContext.findAllComponentsByType() invoked when Arez.areNativeComponentsEnabled() returns false." ); } assert null != _components; final Map<Object, Component> map = _components.get( type ); if ( null != map ) { return map.values(); } else { return Collections.emptyList(); } } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void findAllComponentsByType_nativeComponentsDisabled() { ArezTestUtil.disableNativeComponents(); final ArezContext context = Arez.context(); final String type = ValueUtil.randomString(); assertInvariantFailure( () -> context.findAllComponentsByType( type ), "Arez-0011: ArezContext.findAllComponentsByType() invoked when Arez.areNativeComponentsEnabled() returns false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_references" ) @Nonnull public Locator locator() { if ( Arez.shouldCheckApiInvariants() ) { apiInvariant( Arez::areReferencesEnabled, () -> "Arez-0192: ArezContext.locator() invoked but Arez.areReferencesEnabled() returned false." ); } assert null != _locator; return _locator; } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void locator() { final ArezContext context = Arez.context(); final Locator locator = context.locator(); assertNotNull( locator ); assertNull( locator.findById( String.class, "21" ) ); final TypeBasedLocator worker = new TypeBasedLocator(); worker.registerLookup( String.class, String::valueOf ); final Disposable disposable = context.registerLocator( worker ); assertEquals( locator.findById( String.class, "21" ), "21" ); disposable.dispose(); assertNull( locator.findById( String.class, "21" ) ); }
@Test public void locator_referencesDisabled() { ArezTestUtil.disableReferences(); assertInvariantFailure( () -> Arez.context().locator(), "Arez-0192: ArezContext.locator() invoked but Arez.areReferencesEnabled() returned false." ); } |
ArezContext { @OmitSymbol( unless = "arez.enable_references" ) @Nonnull public Disposable registerLocator( @Nonnull final Locator locator ) { if ( Arez.shouldCheckApiInvariants() ) { apiInvariant( Arez::areReferencesEnabled, () -> "Arez-0191: ArezContext.registerLocator invoked but Arez.areReferencesEnabled() returned false." ); } assert null != _locator; return _locator.registerLocator( Objects.requireNonNull( locator ) ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void registerLocator_referencesDisabled() { ArezTestUtil.disableReferences(); assertInvariantFailure( () -> Arez.context().registerLocator( new TypeBasedLocator() ), "Arez-0191: ArezContext.registerLocator invoked but Arez.areReferencesEnabled() returned false." ); } |
ArezContext { @Nonnull public Task task( @Nonnull final SafeProcedure work ) { return task( null, work ); } ArezContext( @Nullable final Zone zone ); @OmitSymbol( unless = "arez.enable_native_components" ) boolean isComponentPresent( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type, @Nonnull final Object id, @Nullable final String name ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose ); @OmitSymbol( unless = "arez.enable_native_components" ) @Nonnull Component component( @Nonnull final String type,
@Nonnull final Object id,
@Nullable final String name,
@Nullable final SafeProcedure preDispose,
@Nullable final SafeProcedure postDispose ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final String name, @Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate ); @Nonnull ComputableValue<T> computable( @Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull ComputableValue<T> computable( @Nullable final Component component,
@Nullable final String name,
@Nonnull final SafeFunction<T> function,
@Nullable final Procedure onActivate,
@Nullable final Procedure onDeactivate,
@MagicConstant( flagsFromClass = ComputableValue.Flags.class ) final int flags ); @Nonnull Observer observer( @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name, @Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure observe,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe, @Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange ); @Nonnull Observer observer( @Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer observer( @Nullable final Component component,
@Nullable final String name,
@Nullable final Procedure observe,
@Nullable final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final String name, @Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange ); @Nonnull Observer tracker( @Nullable final Component component,
@Nullable final String name,
@Nonnull final Procedure onDepsChange,
@MagicConstant( flagsFromClass = Observer.Flags.class ) final int flags ); @Nonnull ObservableValue<T> observable(); @Nonnull ObservableValue<T> observable( @Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor ); @Nonnull ObservableValue<T> observable( @Nullable final Component component,
@Nullable final String name,
@Nullable final PropertyAccessor<T> accessor,
@Nullable final PropertyMutator<T> mutator ); @Nonnull Task task( @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nullable final String name, @Nonnull final SafeProcedure work ); @Nonnull Task task( @Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); @Nonnull Task task( @Nullable final String name,
@Nonnull final SafeProcedure work,
@MagicConstant( flagsFromClass = Task.Flags.class ) final int flags ); boolean isSchedulerActive(); boolean isTransactionActive(); boolean isTrackingTransactionActive(); boolean isReadWriteTransactionActive(); boolean isReadOnlyTransactionActive(); boolean isSchedulerPaused(); @Nonnull SchedulerLock pauseScheduler(); @OmitSymbol( unless = "arez.enable_task_interceptor" ) void setTaskInterceptor( @Nullable final TaskInterceptor taskInterceptor ); void triggerScheduler(); T action( @Nonnull final Function<T> executable ); T action( @Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T action( @Nullable final String name,
@Nonnull final Function<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T observe( @Nonnull final Observer observer, @Nonnull final Function<T> observe ); T observe( @Nonnull final Observer observer,
@Nonnull final Function<T> observe,
@Nullable final Object[] parameters ); T safeAction( @Nonnull final SafeFunction<T> executable ); T safeAction( @Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name, @Nonnull final SafeFunction<T> executable ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); T safeAction( @Nullable final String name,
@Nonnull final SafeFunction<T> executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); T safeObserve( @Nonnull final Observer observer, @Nonnull final SafeFunction<T> observe ); T safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeFunction<T> observe,
@Nullable final Object[] parameters ); void action( @Nonnull final Procedure executable ); void action( @Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name, @Nonnull final Procedure executable ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void action( @Nullable final String name,
@Nonnull final Procedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void observe( @Nonnull final Observer observer, @Nonnull final Procedure observe ); void observe( @Nonnull final Observer observer,
@Nonnull final Procedure observe,
@Nullable final Object[] parameters ); void safeAction( @Nonnull final SafeProcedure executable ); void safeAction( @Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name, @Nonnull final SafeProcedure executable ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags ); void safeAction( @Nullable final String name,
@Nonnull final SafeProcedure executable,
@MagicConstant( flagsFromClass = ActionFlags.class ) final int flags,
@Nullable final Object[] parameters ); void safeObserve( @Nonnull final Observer observer, @Nonnull final SafeProcedure observe ); void safeObserve( @Nonnull final Observer observer,
@Nonnull final SafeProcedure observe,
@Nullable final Object[] parameters ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Disposable registerLocator( @Nonnull final Locator locator ); @OmitSymbol( unless = "arez.enable_references" ) @Nonnull Locator locator(); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void addObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @OmitSymbol( unless = "arez.enable_observer_error_handlers" ) void removeObserverErrorHandler( @Nonnull final ObserverErrorHandler handler ); @Nonnull Spy getSpy(); } | @Test public void task() { final ArezContext context = Arez.context(); final AtomicInteger callCount = new AtomicInteger(); final String name = ValueUtil.randomString(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final Task task = context.task( name, callCount::incrementAndGet, 0 ); assertEquals( task.getName(), name ); assertEquals( callCount.get(), 1 ); assertFalse( task.isQueued() ); assertFalse( task.isDisposed() ); handler.assertEventCount( 2 ); handler.assertNextEvent( TaskStartEvent.class, e -> assertEquals( e.getTask().getName(), name ) ); handler.assertNextEvent( TaskCompleteEvent.class, e -> { assertEquals( e.getTask().getName(), name ); assertNull( e.getThrowable() ); } ); handler.reset(); task.dispose(); assertEquals( callCount.get(), 1 ); assertFalse( task.isQueued() ); assertTrue( task.isDisposed() ); handler.assertEventCount( 0 ); }
@Test public void task_throwsException() { final ArezContext context = Arez.context(); final AtomicInteger callCount = new AtomicInteger(); final String name = ValueUtil.randomString(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final String errorMessage = "Blah Error!"; final SafeProcedure work = () -> { callCount.incrementAndGet(); throw new RuntimeException( errorMessage ); }; final Task task = context.task( name, work, 0 ); assertEquals( task.getName(), name ); assertEquals( callCount.get(), 1 ); assertFalse( task.isQueued() ); assertFalse( task.isDisposed() ); handler.assertEventCount( 2 ); handler.assertNextEvent( TaskStartEvent.class, e -> assertEquals( e.getTask().getName(), name ) ); handler.assertNextEvent( TaskCompleteEvent.class, e -> { assertEquals( e.getTask().getName(), name ); assertNotNull( e.getThrowable() ); assertEquals( e.getThrowable().getMessage(), errorMessage ); } ); }
@Test public void task_minimalParameters() { final ArezContext context = Arez.context(); final AtomicInteger callCount = new AtomicInteger(); final TestSpyEventHandler handler = TestSpyEventHandler.subscribe( context ); final Task task = context.task( callCount::incrementAndGet ); final String name = "Task@1"; assertEquals( task.getName(), name ); assertEquals( callCount.get(), 1 ); assertFalse( task.isQueued() ); assertFalse( task.isDisposed() ); handler.assertEventCount( 2 ); handler.assertNextEvent( TaskStartEvent.class, e -> assertEquals( e.getTask().getName(), name ) ); handler.assertNextEvent( TaskCompleteEvent.class, e -> assertEquals( e.getTask().getName(), name ) ); }
@SuppressWarnings( "MagicConstant" ) @Test public void task_bad_flags() { final ArezContext context = Arez.context(); assertInvariantFailure( () -> context.task( "MyTask", ValueUtil::randomString, ActionFlags.REQUIRE_NEW_TRANSACTION ), "Arez-0224: Task named 'MyTask' passed invalid flags: " + ActionFlags.REQUIRE_NEW_TRANSACTION ); } |
ComputableValueInfoImpl implements ComputableValueInfo { @Nonnull Transaction getTransactionComputing() { assert _computableValue.isComputing(); final Transaction transaction = getTrackerTransaction( _computableValue.getObserver() ); if ( Arez.shouldCheckInvariants() ) { invariant( () -> transaction != null, () -> "Arez-0106: ComputableValue named '" + _computableValue.getName() + "' is marked as " + "computing but unable to locate transaction responsible for computing ComputableValue" ); } assert null != transaction; return transaction; } ComputableValueInfoImpl( @Nonnull final ComputableValue<?> computableValue ); @Nonnull @Override String getName(); @Override boolean isComputing(); @Nonnull @Override Priority getPriority(); @Override boolean isActive(); @Nonnull @Override List<ObservableValueInfo> getDependencies(); @Nonnull @Override List<ObserverInfo> getObservers(); @Nullable @Override ComponentInfo getComponent(); @OmitSymbol( unless = "arez.enable_property_introspection" ) @Nullable @Override Object getValue(); @Override boolean isDisposed(); @Override String toString(); @Override boolean equals( final Object o ); @Override int hashCode(); } | @Test public void getTransactionComputing() { final ArezContext context = Arez.context(); final ComputableValue<String> computableValue = context.computable( () -> "" ); final Observer observer = computableValue.getObserver(); final Observer observer2 = context.observer( new CountAndObserveProcedure() ); computableValue.setComputing( true ); final ComputableValueInfoImpl info = (ComputableValueInfoImpl) computableValue.asInfo(); final Transaction transaction = new Transaction( context, null, observer.getName(), observer.isMutation(), observer, false ); Transaction.setTransaction( transaction ); assertEquals( info.getTransactionComputing(), transaction ); final Transaction transaction2 = new Transaction( context, transaction, ValueUtil.randomString(), observer2.isMutation(), observer2, false ); Transaction.setTransaction( transaction2 ); assertEquals( info.getTransactionComputing(), transaction ); } |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.