Merge pull request #413 from ARGOeu/devel

Version 1.2.0

.gitignore

@@ -2,3 +2,4 @@
 argo-messaging
 _workspace/
 .idea
+.vscode/

Jenkinsfile

@@ -69,6 +69,9 @@ pipeline {
             }
         }
         stage ('Deploy Docs') {
+            when {
+                branch 'devel'
+            }
             agent {
                 docker {
                     image 'node:buster'

README.md

@@ -65,8 +65,8 @@ resides in two possible locations:
 - `verify_push_server` - (true|false) mutual TLS for the push server
 - `push_worker_token` - token for the active push worker user
 - `log_facilities` - ["syslog", "console"]  
-- `auth_option`: (`key`|`header`|`both`), where should the service look for the access token.
-
+- `auth_option` - (`key`|`header`|`both`), where should the service look for the access token.
+- `proxy_hostname` - The FQDN of any proxy or load balancer that might serve request in place of the AMS
 
 #### Build & Run the service
 

argo-messaging.spec

@@ -3,7 +3,7 @@
 
 Name: argo-messaging
 Summary: ARGO Messaging API for broker network
-Version: 1.1.0
+Version: 1.2.0
 Release: 1%{?dist}
 License: ASL 2.0
 Buildroot: %{_tmppath}/%{name}-buildroot
@@ -63,6 +63,8 @@ go clean
 %attr(0644,root,root) /usr/lib/systemd/system/argo-messaging.service
 
 %changelog
+* Thu May 19 2022 Agelos Tsalapatis  <[email protected]> 1.2.0-1%{?dist}
+- AMS release 1.2.0
 * Mon Nov 8 2021 Agelos Tsalapatis  <[email protected]> 1.1.0-1%{?dist}
 - AMS release 1.1.0
 * Wed Mar 31 2021 Agelos Tsalapatis  <[email protected]> 1.0.8-1%{?dist}

auth/auth_test.go

@@ -910,7 +910,7 @@ func (suite *AuthTestSuite) TestUpdateUserRegistration() {
 
 	store := stores.NewMockStore("", "")
 	m := time.Date(2020, 8, 5, 11, 33, 45, 0, time.UTC)
-	e1 := UpdateUserRegistration("ur-uuid1", AcceptedRegistrationStatus, "uuid1", m, store)
+	e1 := UpdateUserRegistration("ur-uuid1", AcceptedRegistrationStatus, "dc", "uuid1", m, store)
 	ur1, _ := FindUserRegistration("ur-uuid1", "accepted", store)
 	expur1 := UserRegistration{
 		UUID:            "ur-uuid1",

auth/users.go

@@ -68,7 +68,8 @@ type UserRegistration struct {
 	Description     string `json:"description"`
 	Email           string `json:"email"`
 	Status          string `json:"status"`
-	ActivationToken string `json:"activation_token"`
+	DeclineComment  string `json:"decline_comment,omitempty"`
+	ActivationToken string `json:"activation_token,omitempty"`
 	RegisteredAt    string `json:"registered_at"`
 	ModifiedBy      string `json:"modified_by,omitempty"`
 	ModifiedAt      string `json:"modified_at,omitempty"`
@@ -170,6 +171,7 @@ func FindUserRegistration(regUUID, status string, str stores.Store) (UserRegistr
 		Email:           q[0].Email,
 		ActivationToken: q[0].ActivationToken,
 		Status:          q[0].Status,
+		DeclineComment:  q[0].DeclineComment,
 		Organization:    q[0].Organization,
 		Description:     q[0].Description,
 		RegisteredAt:    q[0].RegisteredAt,
@@ -210,6 +212,7 @@ func FindUserRegistrations(status, activationToken, name, email, org string, str
 			Email:           ur.Email,
 			ActivationToken: ur.ActivationToken,
 			Status:          ur.Status,
+			DeclineComment:  ur.DeclineComment,
 			Organization:    ur.Organization,
 			Description:     ur.Description,
 			RegisteredAt:    ur.RegisteredAt,
@@ -223,8 +226,12 @@ func FindUserRegistrations(status, activationToken, name, email, org string, str
 	return urList, nil
 }
 
-func UpdateUserRegistration(regUUID, status, modifiedBy string, modifiedAt time.Time, refStr stores.Store) error {
-	return refStr.UpdateRegistration(regUUID, status, modifiedBy, modifiedAt.Format("2006-01-02T15:04:05Z"))
+func UpdateUserRegistration(regUUID, status, declineComment, modifiedBy string, modifiedAt time.Time, refStr stores.Store) error {
+	// only accept decline comment with the decline status action
+	if status != DeclinedRegistrationStatus {
+		declineComment = ""
+	}
+	return refStr.UpdateRegistration(regUUID, status, declineComment, modifiedBy, modifiedAt.UTC().Format("2006-01-02T15:04:05Z"))
 }
 
 // NewUser accepts parameters and creates a new user

config.json

@@ -17,5 +17,6 @@
   "verify_push_server": true,
   "push_worker_token": "8c8cbaeba3e1317c18cd5c03f3b1f596c23f922a",
   "log_facilities": ["console"],
-  "auth_option": "both" 
+  "auth_option": "both",
+  "proxy_hostname": "lb.ams.gr"
 }

config/config.go

@@ -57,7 +57,11 @@ type APICfg struct {
 	ResAuth                   bool
 	ServiceToken              string
 	LogLevel                  string
-	PushEnabled               bool
+	// Proxy Hostname represents the FQDN of the a potential proxy/load balancer that might be
+	// serving requests in front of the ams instance
+	ProxyHostname string
+
+	PushEnabled bool
 	// Whether or not it should communicate over tls with the push server
 	PushTlsEnabled bool
 	// Push server endpoint
@@ -442,6 +446,14 @@ func (cfg *APICfg) LoadTest() {
 		},
 	).Info("Parameter Loaded - service_token")
 
+	// proxy hostname
+	cfg.ProxyHostname = viper.GetString("proxy_hostname")
+	log.WithFields(
+		log.Fields{
+			"type": "service_log",
+		},
+	).Infof("Parameter Loaded - proxy_hostname: %v", cfg.ProxyHostname)
+
 	// push enabled true or false
 	cfg.PushEnabled = viper.GetBool("push_enabled")
 	log.WithFields(
@@ -534,6 +546,9 @@ func (cfg *APICfg) Load() {
 		pflag.String("service-key", "", "service token definition for immediate full api access")
 		viper.BindPFlag("service_key", pflag.Lookup("service-key"))
 
+		pflag.String("proxy-hostname", "", "hostname in case ams is installed behind a proxy/load balancer")
+		viper.BindPFlag("proxy_hostname", pflag.Lookup("proxy-hostname"))
+
 		pflag.String("push-enabled", "", "enable automatic handling of push subscriptions at start-up")
 		viper.BindPFlag("push_enabled", pflag.Lookup("push-enabled"))
 
@@ -691,6 +706,14 @@ func (cfg *APICfg) Load() {
 		},
 	).Info("Parameter Loaded - service_token")
 
+	// proxy hostname
+	cfg.ProxyHostname = viper.GetString("proxy_hostname")
+	log.WithFields(
+		log.Fields{
+			"type": "service_log",
+		},
+	).Infof("Parameter Loaded - proxy_hostname: %v", cfg.ProxyHostname)
+
 	// push enabled true or false
 	cfg.PushEnabled = viper.GetBool("push_enabled")
 	log.WithFields(
@@ -832,7 +855,15 @@ func (cfg *APICfg) LoadStrJSON(input string) {
 		log.Fields{
 			"type": "service_log",
 		},
-	).Info("Parameter Loaded - service_token:")
+	).Info("Parameter Loaded - service_token")
+
+	// proxy hostname
+	cfg.ProxyHostname = viper.GetString("proxy_hostname")
+	log.WithFields(
+		log.Fields{
+			"type": "service_log",
+		},
+	).Infof("Parameter Loaded - proxy_hostname: %v", cfg.ProxyHostname)
 
 	// push enabled true or false
 	cfg.PushEnabled = viper.GetBool("push_enabled")

config/config.json

@@ -17,5 +17,6 @@
   "verify_push_server": true,
   "push_worker_token": "pw-token",
   "log_facilities": [],
-  "auth_option": "header"
+  "auth_option": "header",
+  "proxy_hostname": "lb.ams.gr"
 }

config/config_test.go

@@ -33,7 +33,8 @@ func (suite *ConfigTestSuite) SetupTest() {
 		"verify_push_server": "true",
         "push_worker_token": "pw-token",
 		"log_facilities": ["SYSLOG", "CONSOLE"],
-        "auth_option": "header"
+        "auth_option": "header",
+ 		"proxy_hostname": "lb.ams.gr"
 	}`
 }
 
@@ -66,6 +67,7 @@ func (suite *ConfigTestSuite) TestLoadConfiguration() {
 	suite.Equal("pw-token", APIcfg2.PushWorkerToken)
 	suite.True(APIcfg2.VerifyPushServer)
 	suite.Equal(0, len(APIcfg2.LogFacilities))
+	suite.Equal("lb.ams.gr", APIcfg2.ProxyHostname)
 }
 
 func (suite *ConfigTestSuite) TestLoadStringJSON() {

doc/swagger/swagger.yaml

@@ -136,6 +136,15 @@ paths:
           description: UUID of the registration
           required: true
           type: string
+        - name: comment
+          in: body
+          description: Comment regarding the declining of the registration.
+          required: false
+          schema:
+            type: object
+            properties:
+              comment:
+                type: string
       tags:
         - Registrations
       responses:
@@ -2023,6 +2032,7 @@ paths:
         500:
           $ref: "#/responses/500"
 
+
     delete:
       summary: Delete an existing topic in a project
       description: |
@@ -2061,6 +2071,82 @@ paths:
         500:
           $ref: "#/responses/500"
 
+  /projects/{PROJECT}/topics/{TOPIC}:attachSchema:
+    post:
+      summary: Link the given schema to the topic
+      description: |
+        Links the given schema to the topic
+      parameters:
+        - $ref: '#/parameters/ApiKey'
+        - name: PROJECT
+          in: path
+          description: Name of the project
+          required: true
+          type: string
+        - name: TOPIC
+          in: path
+          description: Name of the topic
+          required: true
+          type: string
+        - name: Schema
+          in: body
+          description: The name of the schema to be linked with the topic.All published messages will be validated against the linked schema.
+          required: false
+          schema:
+            type: object
+            properties:
+              schema:
+                type: string
+      tags:
+        - Topics
+      responses:
+        200:
+          description: Empty response
+        400:
+          $ref: "#/responses/400"
+        401:
+          $ref: "#/responses/401"
+        403:
+          $ref: "#/responses/403"
+        404:
+          $ref: "#/responses/404"
+        500:
+          $ref: "#/responses/500"
+
+
+  /projects/{PROJECT}/topics/{TOPIC}:detachSchema:
+    post:
+      summary: Unlink the given schema from the topic
+      description: |
+        Uninks the given schema from the topic
+      parameters:
+        - $ref: '#/parameters/ApiKey'
+        - name: PROJECT
+          in: path
+          description: Name of the project
+          required: true
+          type: string
+        - name: TOPIC
+          in: path
+          description: Name of the topic
+          required: true
+          type: string
+      tags:
+        - Topics
+      responses:
+        200:
+          description: Empty response
+        400:
+          $ref: "#/responses/400"
+        401:
+          $ref: "#/responses/401"
+        403:
+          $ref: "#/responses/403"
+        404:
+          $ref: "#/responses/404"
+        500:
+          $ref: "#/responses/500"
+
 
 
   /projects/{PROJECT}/topics/{TOPIC}:publish:
@@ -2219,6 +2305,8 @@ paths:
     get:
       summary: "List API Version information"
       description: "List api version information such as release version, commit hash etc"
+      parameters:
+        - $ref: '#/parameters/ApiKey'
       tags:
         - Version
       produces:
@@ -2875,4 +2963,10 @@ definitions:
       os:
         type: string
       architecture:
+        type: string
+      release:
+        type: string
+      distro:
+        type: string
+      hostname:
         type: string

doc/v1/docs/api_registrations.md

@@ -97,12 +97,21 @@ Success Response
 Please refer to section [Errors](api_errors.md) to see all possible Errors
 
 ## [POST] Manage Registrations - Decline a User's Registration
-This request declines a user's registration
+This request declines a user's registration.
+You can also provide a comment regarding
+the decline reason of the registration.
 
 ### Request
 ```json
 POST "/v1/registrations/{uuid}:decline"
 ```
+### Post body:
+```json
+{
+   "comment": "comment"
+}
+```
+
 
 ### Example request
 ```bash
@@ -111,7 +120,7 @@ curl -X POST -H "Content-Type: application/json"
 ```
 
 ### Responses  
-If successful, the response contains the newly created user
+If successful, the response contains nothing
 
 Success Response
 `200 OK`