Add verifiable data registry

.gitignore

@@ -22,3 +22,6 @@ data
 
 # MacOS
 .DS_Store
+
+# ignore generated pem files from running the nuts-node executable.
+/*.pem

README.rst

@@ -42,7 +42,7 @@ The server and client API is generated from the open-api spec:
 
 .. code-block:: shell
 
-    oapi-codegen -generate types,server,client -package api docs/_static/example.yaml > api/generated.go
+    make gen-api
 
 Generating Mocks
 ****************
@@ -51,16 +51,15 @@ These mocks are used by other modules
 
 .. code-block:: shell
 
-    mockgen -destination=mock/mock_example.go -package=mock -source=example.go
-
+	make gen-mocks
 README
 ******
 
 The readme is auto-generated from a template and uses the documentation to fill in the blanks.
 
 .. code-block:: shell
 
-    ./generate_readme.sh
+    make gen-readme
 
 This script uses ``rst_include`` which is installed as part of the dependencies for generating the documentation.
 
@@ -74,11 +73,54 @@ The documentation can be build by running
 
     /docs $ make html
 
-The resulting html will be available from ``docs/_build/html/index.html``
+Requirements for running sphinx
+===============================
+
+  - install python3
+  - install pip3 (if it doesn't install automatically)
+  - ``pip3 install sphinx``
+  - ``pip3 install recommonmark``
+  - ``pip3 install sphinx_rtd_theme``
+  - ``pip3 install rst_include``
+  - ``pip3 install sphinx-jsonschema``
+  - ``pip3 install sphinxcontrib-httpdomain``
 
 Configuration
 *************
 
-config stuff
-============
+The Nuts-go library contains some configuration logic which allows for usage of configFiles, Environment variables and commandLine params transparently.
+If a Nuts engine is added as Engine it'll automatically work for the given engine. It is also possible for an engine to add the capabilities on a standalone basis.
+This allows for testing from within a repo.
+
+The parameters follow the following convention:
+``$ nuts --parameter X`` is equal to ``$ NUTS_PARAMETER=X nuts`` is equal to ``parameter: X`` in a yaml file.
+
+Or for this piece of yaml
+
+.. code-block:: yaml
+
+    nested:
+        parameter: X
+
+is equal to ``$ nuts --nested.parameter X`` is equal to ``$ NUTS_NESTED_PARAMETER=X nuts``
+
+Config parameters for engines are prepended by the ``engine.ConfigKey`` by default (configurable):
+
+.. code-block:: yaml
+
+    engine:
+        nested:
+            parameter: X
+
+is equal to ``$ nuts --engine.nested.parameter X`` is equal to ``$ NUTS_ENGINE_NESTED_PARAMETER=X nuts``
+
+
+Options
+*******
+
+The following options can be configured:
+
+.. marker-for-config-options
+
+.. include:: options.rst
 

README_template.rst

@@ -15,7 +15,7 @@ Distributed registry for storing and querying health care providers their vendor
     :target: https://codecov.io/gh/nuts-foundation/nuts-node
     :alt: Code coverage
 
-.. image:: https://api.codeclimate.com/v1/badges/040468237c838c03ff7d/maintainability
+.. image:: https://api.codeclimate.com/v1/badges/69f77bd34f3ac253cae0/maintainability
    :target: https://codeclimate.com/github/nuts-foundation/nuts-node/maintainability
    :alt: Maintainability
 
@@ -25,5 +25,5 @@ Distributed registry for storing and querying health care providers their vendor
 Configuration
 *************
 
-.. include:: docs/pages/configuration.rst
+.. include:: docs/pages/configuration/configuration.rst
     :start-after: .. marker-for-readme

cmd/root.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,6 +23,8 @@ import (
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
 	"github.com/nuts-foundation/nuts-node/core"
+	crypto "github.com/nuts-foundation/nuts-node/crypto/engine"
+	vdr "github.com/nuts-foundation/nuts-node/vdr/engine"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -102,6 +104,9 @@ func registerEngines() {
 	core.RegisterEngine(core.NewStatusEngine())
 	core.RegisterEngine(core.NewLoggerEngine())
 	core.RegisterEngine(core.NewMetricsEngine())
+	core.RegisterEngine(crypto.NewCryptoEngine())
+	core.RegisterEngine(vdr.NewVDREngine())
+
 }
 
 func injectConfig(cfg *core.NutsGlobalConfig) {
@@ -116,7 +121,7 @@ func injectConfig(cfg *core.NutsGlobalConfig) {
 func configureEngines() {
 	for _, e := range core.EngineCtl.Engines {
 		// only if Engine is dynamically configurable
-		if e.Configure != nil {
+		if e.Configurable != nil {
 			if err := e.Configure(); err != nil {
 				logrus.Fatal(err)
 			}
@@ -132,7 +137,7 @@ func addFlagSets(cmd *cobra.Command, cfg *core.NutsGlobalConfig) {
 
 func startEngines() {
 	for _, e := range core.EngineCtl.Engines {
-		if e.Start != nil {
+		if e.Runnable != nil {
 			if err := e.Start(); err != nil {
 				logrus.Fatal(err)
 			}
@@ -142,7 +147,7 @@ func startEngines() {
 
 func shutdownEngines() {
 	for _, e := range core.EngineCtl.Engines {
-		if e.Shutdown != nil {
+		if e.Runnable != nil {
 			if err := e.Shutdown(); err != nil {
 				logrus.Error(err)
 			}

codecov.yml

@@ -5,3 +5,5 @@ ignore:
   - "mock/*"
   - "**/mock.go"
   - "docs/*"
+github_checks:
+  annotations: false

core/config.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

core/config_test.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

core/constants.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go core
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

core/diagnostics.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go core
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,6 +19,11 @@
 
 package core
 
+// Diagnosable allows the implementer, mostly engines, to return diagnostics.
+type Diagnosable interface {
+	Diagnostics() []DiagnosticResult
+}
+
 // DiagnosticResult are the result of different checks giving information on how well the system is doing
 type DiagnosticResult interface {
 	// Name returns a simple and understandable name of the check

core/diagnostics_test.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go core
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

core/engine.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -50,6 +50,21 @@ type EchoRouter interface {
 
 // START_DOC_ENGINE_1
 
+// Runnable is the interface that groups the Start and Shutdown methods.
+// When an engine implements these they will be called on startup and shutdown.
+// Start and Shutdown should not be called more than once
+type Runnable interface {
+	Start() error
+	Shutdown() error
+}
+
+// Configurable is the interface that contains the Configure method.
+// When an engine implements the Configurable interface, it will be called before startup.
+// Configure should only be called once per engine instance
+type Configurable interface {
+	Configure() error
+}
+
 // Engine contains all the configuration options and callbacks needed by the executable to configure, start, monitor and shutdown the engines
 type Engine struct {
 	// Name holds the human readable name of the engine
@@ -70,23 +85,15 @@ type Engine struct {
 	// Config is the pointer to a config struct. The config will be unmarshalled using the ConfigKey.
 	Config interface{}
 
-	// Configure checks if the combination of config parameters is allowed
-	Configure func() error
-
-	// Diagnostics returns a slice of DiagnosticResult
-	Diagnostics func() []DiagnosticResult
+	Diagnosable
+	Runnable
+	Configurable
 
 	// FlasSet contains all engine-local configuration possibilities so they can be displayed through the help command
 	FlagSet *pflag.FlagSet
 
 	// Routes passes the Echo router to the specific engine for it to register their routes.
 	Routes func(router EchoRouter)
-
-	// Shutdown the engine
-	Shutdown func() error
-
-	// Start the engine, this will spawn any clients, background tasks or active processes.
-	Start func() error
 }
 
 // END_DOC_ENGINE_1

core/engine_test.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

core/logging.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go
- * Copyright (C) 2019 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -42,9 +42,16 @@ func NewLoggerEngine() *Engine {
 				log.Infof("Verbosity is set to %s\n", lc.verbosity)
 			},
 		},
-		Diagnostics: func() []DiagnosticResult {
-			dr := &GenericDiagnosticResult{Title: "verbosity", Outcome: lc.verbosity}
-			return []DiagnosticResult{dr}
-		},
+		Diagnosable: loggerEngine{config: &lc},
 	}
 }
+
+type loggerEngine struct {
+	config *loggerConfig
+}
+
+// Diagnostics returns the diagnostics of the LoggerEngine.
+func (l loggerEngine) Diagnostics() []DiagnosticResult {
+	dr := &GenericDiagnosticResult{Title: "verbosity", Outcome: l.config.verbosity}
+	return []DiagnosticResult{dr}
+}

core/metrics.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go core
- * Copyright (C) 2020 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,21 +25,23 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
-const NutsMetricsPrefix = "nuts_"
-
 // NewMetricsEngine creates a new Engine for exposing prometheus metrics via http.
 // Metrics are exposed on /metrics, by default the GoCollector and ProcessCollector are enabled.
 func NewMetricsEngine() *Engine {
 	return &Engine{
-		Name:      "Metrics",
-		Configure: configure,
+		Name:         "Metrics",
+		Configurable: metricsEngine{},
 		Routes: func(router EchoRouter) {
 			router.GET("/metrics", echo.WrapHandler(promhttp.Handler()))
 		},
 	}
 }
 
-func configure() error {
+type metricsEngine struct{}
+
+// Configure configures the MetricsEngine.
+// It configures and registers the prometheus collector
+func (metricsEngine) Configure() error {
 	collectors := []prometheus.Collector{
 		prometheus.NewGoCollector(),
 		prometheus.NewProcessCollector(prometheus.ProcessCollectorOpts{}),

core/metrics_test.go

@@ -1,6 +1,6 @@
 /*
- * Nuts go core
- * Copyright (C) 2020 Nuts community
+ * Nuts node
+ * Copyright (C) 2021 Nuts community
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by