ingogriebsch / bricks

Bricks is a framework that allows you to create automated documentation about an application and its components

Ingo's GitHub

🐸 About Me

I'm programming in Java since 1997. I'm a Spring fanboy and the creator of Spring HATEOAS Siren.

I'm also an ardent tweeter and addicted to board games since over 15 years. 🙂

🛸 GitHub Stats

---

Powered by GitHub Readme Stats, Mastering Markdown and the Emoji Cheat Sheet.

bricks's Issues

Introduce section 'Applications' - 'Application' - 'Components' - 'Component' - 'Communication' in dashboard

This issue is blocked by #24

Introduce section 'Applications' - 'Application' - 'Components' - 'Component' - 'Overview' in dashboard

Rework property 'Layer' to own class

Should contain property 'id'.

Enhance converter to be able to convert the data model into a raw type

Rework section 'Applications' - 'Application' - 'Components' to show 'No components available' message if no components are available

• If no componentss are available a 'No components available' message should be shown instead of an empty page.

Highlight the currently selected tab in section 'Applications' - 'Application' - 'Components' - 'Component'

Rework breadcrumb to always match navigation

• Breadcrumb does not match if the tab to show the components of an application is selected

Implement yaml based ComponentIdCollector to avoid hard coded configuration of ids

• Collector should extract ids from yaml file.
• Should be possible to configure a 'base path' as root of entries inside yaml.
• Should be possible to configure a placeholder as part of the 'base path' to allow to map the application id given while exeucting the collector.
• Should be possible to configure the key which value contains the application id.

Rework property 'Category' to own class

Should contain property 'id' and 'context'.

Rework section 'Applications' to show 'No applications available' message if no applications are available

• If no applications are available a 'No applications available' message should be shown instead of an empty page.

Update dashboard to use Spring Boot 2.x

Seems to be a good idea in general, not only because of #29 and #33

Introduce section 'Applications' - 'Application' - 'Overview' in dashboard

Use yaml extracting collectors to avoid static configuration

Concentrate project specific properties/settings/configuration in the parent pom

From @britter

I recommend to configure the maven-compiler-plugin directly in your parent pom. This way you don't need to repeat this in every module.

Introduce section 'Applications' - 'Application' - 'Components' in dashboard

Explicitly configure standard maven plugins

From @britter

Furthermore I recommend to explicitly configure standard plugins like maven-compiler-plugin and maven-surefire-plugin because otherwise you will get pretty out dated default versions from the default-bindings.xml

Enhance README to explain the different modules

Introduce module 'discover' to allow the discovery of the documentation

We need a place there we can put the code to analyze a (java) project and to generate the different parts of the model.

Introduce artifactory based resource origin provider

Checks maven-metadata.xml and returns an resource origin based on the latest entry.

Introduce section 'Applications' - 'Application' - 'Domains' in dashboard

Introduce section 'Applications' - 'Application' - 'Layers' in dashboard

Use ApplicationReaderFactory in ApplicationCollector

• Currently we are using an instance of ApplicationReader directly

Dashboard: (Optionally) redirect to application view if only one is available

• Configuration should be possible through the application environment (i.e. application.yml/application.properties).
• Redirect to application page only happens if redirect is enabled and only one application is available.

Use ComponentReaderFactory in ComponentCollector

• Currently we are using an instance of ApplicationReader directly

Introduce view model to not use data model directly

• Introduce different view models for application (overview, etc)
• Introduce different view models for componet (overview, etc)
• Clarify if view model should always map view or if different abstract view models are sufficient

Remove boilerplate code from model

As the Model should be concise and very easy to read, things like putting private in front of every field can be considered visual noise.

i'd leave it to lombok. (i'll attach a PR)

feel free to drop it, if this is considered too lomboky for you :D

Introduce visualizer to visualize a component communication

• Implementation should create svg.
• Svg shows the selected component in the center.
• All in some way 'connected' components are shown in a circle around the selected component.
• A directed and colored arrow is shown for each direct communication.
• A directed and colored arrow is shown for each indirect communication.
• The different communication layers can be hidden through the layer mechanism of the svg.
• Each component is shown as a hexagon with it's name in the center.
• The boarder color of each component matches it's corresponding layer color.

Allow maven-plugin to generate component based on static information

Enhance README to explain the overall idea

Extract converter api/implementations to separate module

• Should be possible to implement new converters without the need to have a dependency to the whole assemble module.

Enhance section 'Applications' - 'Application' - 'Overview' to show additional information

• Information about the following things are missing atm:
  -- License
  -- Responsible
  -- Management Systems

Switch to JUnit5 and current Mockito/surefire/failsafe versions

Implement yaml based ApplicationIdCollector to avoid hard coded configuration of ids

• Collector should extract ids from yaml file.
• Should be possible to configure a 'base path' as root of entries inside yaml.
• Should be possible to configure the key which value contains the application id.

Dashboard properties can not be set through configuration file

Because there are no setters available on the class.

Highlight the currently selected tab in section 'Applications' - 'Application'

Introduce section 'Applications' - 'Application' - 'Topology' in dashboard

This issue is blocked by #26

Introduce module 'analyze' to allow the analysis of the model

Introduce section 'Applications' - 'Application' - 'Components' - 'Component' - 'Development' in dashboard

Error on initial import in eclipse

If the project is not yet installed, eclipse reports an error:

Failed to execute goal on project �[36mbricks-maven-plugin�[m: �[1;31mCould not resolve dependencies for project com.github.ingogriebsch.bricks:bricks-maven-plugin:maven-plugin:1.0.0-SNAPSHOT: Could not find artifact com.github.ingogriebsch.bricks:bricks-model:jar:1.0.0-SNAPSHOT�[m (org.apache.maven.plugins:maven-plugin-plugin:3.6.0:descriptor:mojo-descriptor:process-classes)

org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal on project �[36mbricks-maven-plugin�[m: �[1;31mCould not resolve dependencies for project com.github.ingogriebsch.bricks:bricks-maven-plugin:maven-plugin:1.0.0-SNAPSHOT: Could not find artifact com.github.ingogriebsch.bricks:bricks-model:jar:1.0.0-SNAPSHOT�[m
	at org.apache.maven.lifecycle.internal.LifecycleDependencyResolver.getDependencies(LifecycleDependencyResolver.java:269)

...
	pom.xml	/bricks-maven-plugin	line 122	Maven Build Problem

Questionable if this is worth fixing, but the solution obviously is to mvn install. Just wanted to mention it here for future reference.

DepShield encountered errors while building your project

The project could not be analyzed because of maven build errors. Please review the error messages here. Another build will be scheduled within 24 hours. If the build is successful this issue will be closed, otherwise the error message will be updated.

_{This is an automated GitHub Issue created by Sonatype DepShield. GitHub Apps, including DepShield, can be managed from the Developer settings of the repository administrators.}

Introduce visualizer to show the topology of an application

Introduce module 'visualize' to allow the implementation of specific visualizer's

First idea for a 'Visualizer' interface:

public interface Visualizer<I, O> {
    void visualize(I input, O output) throws Exception;
}

First idea for an 'ApplicationVisualizer interface:

public interface ApplicationVisualizer<T> extends Visualizer<Application, O> {
}

First idea for an 'ComponentVisualizer interface:

public interface ComponentVisualizer<T> extends Visualizer<Component, O> {
}