aboutsummaryrefslogtreecommitdiffstats
path: root/src/dcm/pkg/module/logicalcloud.go
blob: 9fb1b6fbaff73e295c5814f8e792c4daf8ec9440 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
* Copyright 2020 Intel Corporation, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package module

import (
    "github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
    "github.com/onap/multicloud-k8s/src/orchestrator/pkg/module"

    pkgerrors "github.com/pkg/errors"
)

// LogicalCloud contains the parameters needed for a Logical Cloud
type LogicalCloud struct {
    MetaData            MetaDataList        `json:"metadata"`
    Specification       Spec                `json:"spec"`
}


// MetaData contains the parameters needed for metadata
type MetaDataList struct {
    LogicalCloudName    string  `json:"name"`
    Description         string  `json:"description"`
    UserData1           string  `json:"userData1"`
    UserData2           string  `json:"userData2"`
}

// Spec contains the parameters needed for spec
type Spec struct {
    NameSpace   string      `json:"namespace"`
    User        UserData    `json:"user"`

}

// UserData contains the parameters needed for user
type UserData struct {
    UserName            string        `json:"user-name"`
    Type                string        `json:"type"`
    UserPermissions     []UserPerm    `json:"user-permissions"`
}

//  UserPerm contains the parameters needed for user permissions
type UserPerm struct {
    PermName        string          `json:"permission-name"`
    APIGroups       []string        `json:"apiGroups"`
    Resources       []string        `json:"resources"`
    Verbs           []string        `json:"verbs"`
}

// LogicalCloudKey is the key structure that is used in the database
type LogicalCloudKey struct {
    Project             string  `json:"project"`
    LogicalCloudName    string  `json:"logical-cloud-name"`
}

// LogicalCloudManager is an interface that exposes the connection
// functionality
type LogicalCloudManager interface {
    Create(project string, c LogicalCloud) (LogicalCloud, error)
    Get(project, name string) (LogicalCloud, error)
    GetAll(project string) ([]LogicalCloud, error)
    Delete(project, name string) error
    Update(project, name string, c LogicalCloud) (LogicalCloud, error)

}

// Interface facilitates unit testing by mocking functions
type Utility interface {
    DBInsert(storeName string, key db.Key, query interface{}, meta string, c interface{}) error
    DBFind(storeName string, key db.Key, meta string) ([][]byte, error)
    DBUnmarshal(value []byte, out interface{}) error
    DBRemove(storeName string, key db.Key) error
    CheckProject(project string) error
    CheckLogicalCloud(project, logicalCloud string) error
}

// LogicalCloudClient implements the LogicalCloudManager
// It will also be used to maintain some localized state
type LogicalCloudClient struct {
    storeName   string
    tagMeta     string
    util        Utility
}

// Added for unit testing; implements Utility interface
type DBService struct {}

// LogicalCloudClient returns an instance of the LogicalCloudClient
// which implements the LogicalCloudManager
func NewLogicalCloudClient() *LogicalCloudClient {
    service := DBService{}
    return &LogicalCloudClient{
        storeName:  "orchestrator",
        tagMeta:    "logicalcloud",
        util:       service,
    }
}

// Create entry for the logical cloud resource in the database
func (v *LogicalCloudClient) Create(project string, c LogicalCloud) (LogicalCloud, error) {

    //Construct key consisting of name
    key := LogicalCloudKey{
        Project:            project,
        LogicalCloudName:   c.MetaData.LogicalCloudName,
    }

    //Check if project exists
    err := v.util.CheckProject(project)
    if err != nil {
        return LogicalCloud{}, pkgerrors.New("Unable to find the project")
    }

    //Check if this Logical Cloud already exists
    _, err = v.Get(project, c.MetaData.LogicalCloudName)
    if err == nil {
        return LogicalCloud{}, pkgerrors.New("Logical Cloud already exists")
    }

    err = v.util.DBInsert(v.storeName, key, nil, v.tagMeta, c)
    if err != nil {
        return LogicalCloud{}, pkgerrors.Wrap(err, "Creating DB Entry")
    }

    return c, nil
}

// Get returns Logical Cloud corresponding to logical cloud name
func (v *LogicalCloudClient) Get(project, logicalCloudName string) (LogicalCloud, error) {

    //Construct the composite key to select the entry
    key := LogicalCloudKey{
        Project:            project,
        LogicalCloudName:   logicalCloudName,
    }
    value, err := v.util.DBFind(v.storeName, key, v.tagMeta)
    if err != nil {
        return LogicalCloud{}, pkgerrors.Wrap(err, "Get Logical Cloud")
    }

    //value is a byte array
    if value != nil {
        lc := LogicalCloud{}
        err = v.util.DBUnmarshal(value[0], &lc)
        if err != nil {
            return LogicalCloud{}, pkgerrors.Wrap(err, "Unmarshaling value")
        }
        return lc, nil
    }

    return LogicalCloud{}, pkgerrors.New("Error getting Logical Cloud")
}

// GetAll returns Logical Clouds in the project
func (v *LogicalCloudClient) GetAll(project string) ([]LogicalCloud, error) {

    //Construct the composite key to select the entry
    key := LogicalCloudKey{
        Project:            project,
        LogicalCloudName:   "",
    }

    var resp []LogicalCloud
    values, err := v.util.DBFind(v.storeName, key, v.tagMeta)
    if err != nil {
        return []LogicalCloud{}, pkgerrors.Wrap(err, "Get Logical Clouds")
    }

    for _, value := range values {
        lc := LogicalCloud{}
        err = v.util.DBUnmarshal(value, &lc)
        if err != nil {
            return []LogicalCloud{}, pkgerrors.Wrap(err, "Unmarshaling values")
        }
        resp = append(resp, lc)
    }

    return resp, nil
}

// Delete the Logical Cloud entry from database
func (v *LogicalCloudClient) Delete(project, logicalCloudName string) error {

    //Construct the composite key to select the entry
    key := LogicalCloudKey{
        Project:            project,
        LogicalCloudName:   logicalCloudName,
    }
    err := v.util.DBRemove(v.storeName, key)
    if err != nil {
        return pkgerrors.Wrap(err, "Delete Logical Cloud")
    }

    return nil
}

// Update an entry for the Logical Cloud in the database
func (v *LogicalCloudClient) Update(project, logicalCloudName string, c LogicalCloud) (LogicalCloud, error) {

    key := LogicalCloudKey{
        Project:            project,
        LogicalCloudName:   logicalCloudName,
    }
    // Check for mismatch, logicalCloudName and payload logical cloud name
    if c.MetaData.LogicalCloudName != logicalCloudName {
        return LogicalCloud{}, pkgerrors.New("Update Error - Logical Cloud name mismatch")
    }
    //Check if this Logical Cloud exists
    _, err := v.Get(project, logicalCloudName)
    if err != nil {
        return LogicalCloud{}, pkgerrors.New("Update Error - Logical Cloud doesn't exist")
    }
    err = v.util.DBInsert(v.storeName, key, nil, v.tagMeta, c)
    if err != nil {
        return LogicalCloud{}, pkgerrors.Wrap(err, "Updating DB Entry")
    }
    return c, nil
}

func (d DBService) DBInsert(storeName string, key db.Key, query interface{}, meta string, c interface{}) error {

    err := db.DBconn.Insert(storeName, key, nil, meta, c)
    if err != nil {
        return pkgerrors.Wrap(err, "Creating DB Entry")
    }

    return nil
}

func (d DBService) DBFind(storeName string, key db.Key, meta string) ([][]byte, error) {

    value, err := db.DBconn.Find(storeName, key, meta)
    if err != nil {
        return [][]byte{}, pkgerrors.Wrap(err, "Get Resource")
    }

    return value, nil
}

func (d DBService) DBUnmarshal(value []byte, out interface{}) error {

    err := db.DBconn.Unmarshal(value, out)
    if err != nil {
        return pkgerrors.Wrap(err, "Unmarshaling Value")
    }

    return nil
}

func (d DBService) DBRemove(storeName string, key db.Key) error {

    err := db.DBconn.Remove(storeName, key)
    if err != nil {
        return pkgerrors.Wrap(err, "Delete Resource")
    }

    return nil
}

func (d DBService) CheckProject(project string) error {
    // Check if project exists
    _, err := module.NewProjectClient().GetProject(project)
    if err != nil {
        return pkgerrors.New("Unable to find the project")
    }

    return nil
}

func (d DBService) CheckLogicalCloud(project, logicalCloud string) error {
    // Check if logical cloud exists
    _, err := NewLogicalCloudClient().Get(project, logicalCloud)
    if err != nil {
        return pkgerrors.New("Unable to find the logical cloud")
    }

    return nil
}