pburls / dewey Goto Github PK

View Code? Open in Web Editor NEW

0.0 0.0 0.0 593 KB

Software Development Tool

License: MIT License

C# 100.00%

manifest software-engineering catalogue developer-tools devtools devops-tools microservices

dewey's Introduction

Dewey

Introducing a standard for cataloguing software components throughout multiple repositories using simple JSON manifest files.
A simple command line application for reading the manifests and performing simple actions described by them. Such as building, deploying and graphing dependencies.

Command Line application

The current trend in software design is to break up large, complicated software systems into a collection of many smaller, simpler components. e.g. micro services.
The dewey command line tool is designed to help alleviate some of the problems of working on a large system.
By reading the necessary information from the appropriate set of manifest files, dewey can help perform more complex tasks in a simple instruction. Such as:

Build a component.
Deploy a component.
Graph component dependencies.

Getting Started

Dewey is available as a chocolatey package (latest package can be found here) and can be installed in a single command.

$ choco install dewey

The installation can be simply tested by typing 'dewey'. If successful, the version number and a list of available commands will be displayed.

$ dewey
Dewey Development Tool. v0.0.60
Usage: dewey <command>
Commands:
 - list
 - build
 - deploy
 - graph

Commands

The list command loads all discoverable manifests and lists the known components and runtime-resources. More information can be found here.
The build command loads all discoverable manifests and attempts to build the component that matches the given name. All the component's dependencies can also be built. More information can be found here.
The deploy command loads all discoverable manifests and attempts to deploy the component that matches the given name. All the component's dependencies can also be built. More information can be found here.
The graph command loads all discoverable manifests and builds a dependency graph of all the known components and runtime resources. More information can be found here.

Manifest File

Dewey manifest files dewey.json are used to capture the location of components in a repository and information required to perform different tasks. The following root information can be captured:

Location of other manifest files.
Details about components.
Details about runtime resources used by components.

More information and examples about Manifest Files can be found here.

dewey's People

Contributors

dewey's Issues

Cluster labels need to be put into quotes

Ability to group the queues into the same graph layer by logical groups.

Cluster names with "-" characters can't be rendered.

graph should write a DOT file by default.

Names of Queues in the graph are too long when prefixing with the provider.

Deploy command fails with for components with multiple dependencies

Unhandled Exception: System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.InvalidOperationException: Collection was modified; enumeration operation may not execute.
   at System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
   at System.Collections.Generic.List`1.Enumerator.MoveNextRare()
   at System.Collections.Generic.List`1.Enumerator.MoveNext()
   at Dewey.Deploy.DeployCommandHandler.Execute()
   at Dewey.Deploy.DeployCommandHandler.Execute(DeployCommand command)
   --- End of inner exception stack trace ---
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Object[] arguments, Signature sig, Boolean constructor)
   at System.Reflection.RuntimeMethodInfo.UnsafeInvokeInternal(Object obj, Object[] parameters, Object[] arguments)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at Dewey.Messaging.CommandProcessor.Execute(ICommand command)
   at Dewey.CLI.Program.Main(String[] args)

Investigate removing SimpleInjector

CommandHanlders should be registered with a factory rather.

list command should show file paths and sub-types of components

Show port number on graph for web components.

list command should show runtime resources

Fix common dependencies being rebuilt/redeployed

'Unknown command' printed when help flags are used.

Runtime resources should be definable inside component manifest file.

This prevents needing to maintain two manifest files inside a component folder.
Also it prevents problems with having to load both component and resource manifest files when performing dewey commands with the component folder as the working directory.

no confirmation message after a graph command.

Would be nice to know that the graph command was successful and where to find its output.

IIS Deployment can't specify the current component directory as the content path.

Skipping 'iis' deployment element of component 'Vod.Settings' with a missing attributes: content

Unhandled Exception: System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.InvalidOperationException: Collection was modified; enumeration operation may not execute.
   at System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
   at System.Collections.Generic.List`1.Enumerator.MoveNextRare()
   at System.Collections.Generic.List`1.Enumerator.MoveNext()
   at Dewey.Build.BuildCommandHandler.Execute()
   at Dewey.Build.BuildCommandHandler.Execute(BuildCommand command)
   --- End of inner exception stack trace ---
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Object[] arguments, Signature sig, Boolean constructor)
   at System.Reflection.RuntimeMethodInfo.UnsafeInvokeInternal(Object obj, Object[] parameters, Object[] arguments)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at Dewey.Messaging.CommandProcessor.Execute(ICommand command)
   at Dewey.CLI.Program.Main(String[] args)