Update Packet metadata generation based on feedback (#27490)
Этот коммит содержится в:
Ben Schumacher
коммит произвёл
GitHub
GitHub
родитель
9f396c9294
Коммит
6bbf7bbb9f
@@ -1,122 +0,0 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package model
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
"github.com/blang/semver/v4"
|
||||
)
|
||||
|
||||
type MetadataType string
|
||||
|
||||
const (
|
||||
CurrentMetadataVersion int = 1
|
||||
ServerMetadata MetadataType = "mattermost-support-package"
|
||||
PluginMetadata MetadataType = "plugin-support-package"
|
||||
)
|
||||
|
||||
type Metadata struct {
|
||||
// Required Fields
|
||||
Version int `json:"version"`
|
||||
Type MetadataType `json:"type"`
|
||||
GeneratedAt int64 `json:"generated_at"`
|
||||
ServerVersion string `json:"server_version"`
|
||||
ServerID string `json:"server_id"`
|
||||
LicenseID string `json:"license_id"`
|
||||
CustomerID string `json:"customer_id"`
|
||||
// Optional Fields
|
||||
Extras map[string]any `json:"extras"`
|
||||
}
|
||||
|
||||
func (md *Metadata) Validate() error {
|
||||
if md.Version < 1 {
|
||||
return fmt.Errorf("metadata version should be greater than 1")
|
||||
}
|
||||
|
||||
if md.Type != ServerMetadata && md.Type != PluginMetadata {
|
||||
return fmt.Errorf("unrecognized metadata type: %s", md.Type)
|
||||
}
|
||||
|
||||
if _, err := semver.ParseTolerant(md.ServerVersion); err != nil {
|
||||
return fmt.Errorf("could not parse server version: %w", err)
|
||||
}
|
||||
|
||||
if !IsValidId(md.ServerID) {
|
||||
return fmt.Errorf("server id is not a valid id %q", md.ServerID)
|
||||
}
|
||||
|
||||
if !IsValidId(md.LicenseID) && md.LicenseID != "" {
|
||||
return fmt.Errorf("license id is not a valid id %q", md.LicenseID)
|
||||
}
|
||||
|
||||
if !IsValidId(md.CustomerID) && md.CustomerID != "" {
|
||||
return fmt.Errorf("customer id is not a valid id %q", md.CustomerID)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func ParseMetadata(b []byte) (*Metadata, error) {
|
||||
v := struct {
|
||||
Version int `json:"version"`
|
||||
}{}
|
||||
|
||||
err := json.Unmarshal(b, &v)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
switch v.Version {
|
||||
case 1:
|
||||
var md Metadata
|
||||
err = json.Unmarshal(b, &md)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
err = md.Validate()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &md, nil
|
||||
default:
|
||||
return nil, fmt.Errorf("unsupported metadata version: %d", v.Version)
|
||||
}
|
||||
}
|
||||
|
||||
// GeneratePluginMetadata is a utility function to generate a plugin metadata for support packets.
|
||||
// It will construct it from the manifest, license and so on. The plugin_id and plugin_version will be
|
||||
// used from the manifest.
|
||||
func GeneratePluginMetadata(manifest *Manifest, license *License, serverID string, pluginMeta map[string]any) (*Metadata, error) {
|
||||
if pluginMeta == nil {
|
||||
pluginMeta = make(map[string]any)
|
||||
}
|
||||
|
||||
// we override the plugin_id and version fields from the manifest
|
||||
pluginMeta["plugin_id"] = manifest.Id
|
||||
pluginMeta["plugin_version"] = manifest.Version
|
||||
|
||||
md := Metadata{
|
||||
Version: CurrentMetadataVersion,
|
||||
Type: PluginMetadata,
|
||||
GeneratedAt: GetMillis(),
|
||||
ServerVersion: CurrentVersion,
|
||||
ServerID: serverID,
|
||||
Extras: pluginMeta,
|
||||
}
|
||||
|
||||
if license != nil {
|
||||
md.LicenseID = license.Id
|
||||
md.CustomerID = license.Customer.Id
|
||||
}
|
||||
|
||||
if err := md.Validate(); err != nil {
|
||||
return nil, fmt.Errorf("invalid metadata: %w", err)
|
||||
}
|
||||
|
||||
return &md, nil
|
||||
}
|
||||
@@ -1,176 +0,0 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package model
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestValidate(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
metadata Metadata
|
||||
expectErr bool
|
||||
}{
|
||||
{
|
||||
name: "Valid Metadata",
|
||||
metadata: Metadata{
|
||||
Version: 1,
|
||||
Type: ServerMetadata,
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
Extras: map[string]interface{}{"key": "value"},
|
||||
},
|
||||
expectErr: false,
|
||||
},
|
||||
{
|
||||
name: "Valid Metadata without license",
|
||||
metadata: Metadata{
|
||||
Version: 1,
|
||||
Type: ServerMetadata,
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
Extras: map[string]interface{}{"key": "value"},
|
||||
},
|
||||
expectErr: false,
|
||||
},
|
||||
{
|
||||
name: "Invalid Version",
|
||||
metadata: Metadata{
|
||||
Version: 0,
|
||||
Type: ServerMetadata,
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "Invalid Type",
|
||||
metadata: Metadata{
|
||||
Version: 1,
|
||||
Type: "invalid-type",
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "Invalid Server Version",
|
||||
metadata: Metadata{
|
||||
Version: 1,
|
||||
Type: ServerMetadata,
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "invalid-version",
|
||||
ServerID: "valid-server-id",
|
||||
LicenseID: "valid-license-id",
|
||||
CustomerID: "valid-customer-id",
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "Invalid Server ID",
|
||||
metadata: Metadata{
|
||||
Version: 1,
|
||||
Type: ServerMetadata,
|
||||
GeneratedAt: 1622569200,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: "",
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := tt.metadata.Validate()
|
||||
if tt.expectErr {
|
||||
require.Error(t, err)
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMetadata(t *testing.T) {
|
||||
validMetadataJSON := `{
|
||||
"version": 1,
|
||||
"type": "mattermost-support-package",
|
||||
"generated_at": 1622569200,
|
||||
"server_version": "5.33.3",
|
||||
"server_id": "8fqk9rti13fmpxdd5934a3xsxh",
|
||||
"license_id": "3g3pqn8in3brzjkozcn1kdidgr",
|
||||
"customer_id": "74cmws7gf3ykpj31car7zahsny",
|
||||
"extras": {"key": "value"}
|
||||
}`
|
||||
|
||||
invalidVersionJSON := `{
|
||||
"version": 0,
|
||||
"type": "mattermost-support-package",
|
||||
"generated_at": 1622569200,
|
||||
"server_version": "5.33.3",
|
||||
"server_id": "8fqk9rti13fmpxdd5934a3xsxh",
|
||||
"license_id": "3g3pqn8in3brzjkozcn1kdidgr",
|
||||
"customer_id": "74cmws7gf3ykpj31car7zahsny",
|
||||
}`
|
||||
|
||||
unsupportedVersionJSON := `{
|
||||
"version": 2,
|
||||
"type": "mattermost-support-package",
|
||||
"generated_at": 1622569200,
|
||||
"server_version": "5.33.3",
|
||||
"server_id": "8fqk9rti13fmpxdd5934a3xsxh",
|
||||
"license_id": "3g3pqn8in3brzjkozcn1kdidgr",
|
||||
"customer_id": "74cmws7gf3ykpj31car7zahsny",
|
||||
}`
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
jsonData string
|
||||
expectErr bool
|
||||
}{
|
||||
{
|
||||
name: "Valid Metadata JSON",
|
||||
jsonData: validMetadataJSON,
|
||||
expectErr: false,
|
||||
},
|
||||
{
|
||||
name: "Invalid Version in JSON",
|
||||
jsonData: invalidVersionJSON,
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "Unsupported Version in JSON",
|
||||
jsonData: unsupportedVersionJSON,
|
||||
expectErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
md, err := ParseMetadata([]byte(tt.jsonData))
|
||||
if tt.expectErr {
|
||||
require.Error(t, err)
|
||||
require.Nil(t, md)
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, md)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
131
server/public/model/packet_metadata.go
Обычный файл
131
server/public/model/packet_metadata.go
Обычный файл
@@ -0,0 +1,131 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package model
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/blang/semver/v4"
|
||||
"gopkg.in/yaml.v2"
|
||||
)
|
||||
|
||||
type PacketType string
|
||||
|
||||
const (
|
||||
CurrentMetadataVersion int = 1
|
||||
SupportPacketType PacketType = "support-packet"
|
||||
PluginPacketType PacketType = "plugin-packet"
|
||||
|
||||
PacketMetadataFileName = "metadata.yaml"
|
||||
)
|
||||
|
||||
// PacketMetadata contains information about the server and the configured license (if there is one),
|
||||
// It's used in file archives, so called Packets, that customer send to Mattermost Staff for review.
|
||||
// For example, this metadata is attached to the Support Packet and the Metrics plugin Packet.
|
||||
type PacketMetadata struct {
|
||||
// Required Fields
|
||||
|
||||
Version int `yaml:"version"`
|
||||
Type PacketType `yaml:"type"`
|
||||
GeneratedAt int64 `yaml:"generated_at"`
|
||||
ServerVersion string `yaml:"server_version"`
|
||||
ServerID string `yaml:"server_id"`
|
||||
|
||||
// Optional Fields
|
||||
|
||||
LicenseID string `yaml:"license_id"`
|
||||
CustomerID string `yaml:"customer_id"`
|
||||
Extras map[string]any `yaml:"extras,omitempty"`
|
||||
}
|
||||
|
||||
func (md *PacketMetadata) Validate() error {
|
||||
if md.Version < 1 {
|
||||
return fmt.Errorf("metadata version should be greater than 1")
|
||||
}
|
||||
|
||||
switch md.Type {
|
||||
case SupportPacketType, PluginPacketType:
|
||||
default:
|
||||
return fmt.Errorf("unrecognized packet type: %s", md.Type)
|
||||
}
|
||||
|
||||
if md.GeneratedAt <= 0 {
|
||||
return fmt.Errorf("generated_at should be a positive number")
|
||||
}
|
||||
|
||||
if _, err := semver.ParseTolerant(md.ServerVersion); err != nil {
|
||||
return fmt.Errorf("could not parse server version: %w", err)
|
||||
}
|
||||
|
||||
if !IsValidId(md.ServerID) {
|
||||
return fmt.Errorf("server id is not a valid id %q", md.ServerID)
|
||||
}
|
||||
|
||||
if md.LicenseID != "" && !IsValidId(md.LicenseID) {
|
||||
return fmt.Errorf("license id is not a valid id %q", md.LicenseID)
|
||||
}
|
||||
|
||||
if md.CustomerID != "" && !IsValidId(md.CustomerID) {
|
||||
return fmt.Errorf("customer id is not a valid id %q", md.CustomerID)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func ParsePacketMetadata(b []byte) (*PacketMetadata, error) {
|
||||
v := struct {
|
||||
Version int `yaml:"version"`
|
||||
}{}
|
||||
|
||||
err := yaml.Unmarshal(b, &v)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
switch v.Version {
|
||||
case 1:
|
||||
var md PacketMetadata
|
||||
err = yaml.Unmarshal(b, &md)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
err = md.Validate()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &md, nil
|
||||
default:
|
||||
return nil, fmt.Errorf("unsupported metadata version: %d", v.Version)
|
||||
}
|
||||
}
|
||||
|
||||
// GeneratePacketMetadata is a utility function to generate metadata for customer provided Packets.
|
||||
// It will construct it from serverID and optionally a license.
|
||||
func GeneratePacketMetadata(serverID string, license *License, extra map[string]any) (*PacketMetadata, error) {
|
||||
if extra == nil {
|
||||
extra = make(map[string]any)
|
||||
}
|
||||
|
||||
md := PacketMetadata{
|
||||
Version: CurrentMetadataVersion,
|
||||
Type: PluginPacketType,
|
||||
GeneratedAt: GetMillis(),
|
||||
ServerVersion: CurrentVersion,
|
||||
ServerID: serverID,
|
||||
Extras: extra,
|
||||
}
|
||||
|
||||
if license != nil {
|
||||
md.LicenseID = license.Id
|
||||
md.CustomerID = license.Customer.Id
|
||||
}
|
||||
|
||||
if err := md.Validate(); err != nil {
|
||||
return nil, fmt.Errorf("invalid metadata: %w", err)
|
||||
}
|
||||
|
||||
return &md, nil
|
||||
}
|
||||
185
server/public/model/packet_metadata_test.go
Обычный файл
185
server/public/model/packet_metadata_test.go
Обычный файл
@@ -0,0 +1,185 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package model
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
"gopkg.in/yaml.v2"
|
||||
)
|
||||
|
||||
func TestPacketMetadataValidate(t *testing.T) {
|
||||
tests := map[string]struct {
|
||||
name string
|
||||
metadata PacketMetadata
|
||||
expectErr bool
|
||||
}{
|
||||
"Valid Metadata": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
Extras: map[string]interface{}{"key": "value"},
|
||||
},
|
||||
expectErr: false,
|
||||
},
|
||||
"Valid Metadata without license": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
Extras: map[string]interface{}{"key": "value"},
|
||||
},
|
||||
expectErr: false,
|
||||
},
|
||||
"Invalid Version": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 0,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
"Invalid Type": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: "invalid-type",
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
"Invalid GeneratedAt": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 0,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: NewId(),
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
"Invalid Server Version": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "invalid-version",
|
||||
ServerID: "valid-server-id",
|
||||
LicenseID: "valid-license-id",
|
||||
CustomerID: "valid-customer-id",
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
"Invalid Server ID": {
|
||||
metadata: PacketMetadata{
|
||||
Version: 1,
|
||||
Type: SupportPacketType,
|
||||
GeneratedAt: 1720097114454,
|
||||
ServerVersion: "5.33.3",
|
||||
ServerID: "",
|
||||
LicenseID: NewId(),
|
||||
CustomerID: NewId(),
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tt := range tests {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
err := tt.metadata.Validate()
|
||||
if tt.expectErr {
|
||||
require.Error(t, err)
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParsePacketMetadata(t *testing.T) {
|
||||
valid := `
|
||||
version: 1
|
||||
type: support-packet
|
||||
generated_at: 1622569200
|
||||
server_version: 5.33.3
|
||||
server_id: 8fqk9rti13fmpxdd5934a3xsxh
|
||||
license_id: 3g3pqn8in3brzjkozcn1kdidgr
|
||||
customer_id: 74cmws7gf3ykpj31car7zahsny
|
||||
extras:
|
||||
key: value
|
||||
`
|
||||
|
||||
invalidVersion := `
|
||||
version: 0
|
||||
type: support-packet
|
||||
generated_at: 1622569200
|
||||
server_version: 5.33.3
|
||||
server_id: 8fqk9rti13fmpxdd5934a3xsxh
|
||||
license_id: 3g3pqn8in3brzjkozcn1kdidgr
|
||||
customer_id: 74cmws7gf3ykpj31car7zahsny
|
||||
`
|
||||
|
||||
unsupportedVersion := `
|
||||
version: 2
|
||||
type: support-packet
|
||||
generated_at: 1622569200
|
||||
server_version: 5.33.3
|
||||
server_id: 8fqk9rti13fmpxdd5934a3xsxh
|
||||
license_id: 3g3pqn8in3brzjkozcn1kdidgr
|
||||
customer_id: 74cmws7gf3ykpj31car7zahsny
|
||||
`
|
||||
|
||||
tests := map[string]struct {
|
||||
yamlData string
|
||||
expectErr bool
|
||||
}{
|
||||
"Valid Metadata YAML": {
|
||||
yamlData: valid,
|
||||
expectErr: false,
|
||||
},
|
||||
"Invalid Version in YAML": {
|
||||
yamlData: invalidVersion,
|
||||
expectErr: true,
|
||||
},
|
||||
"Unsupported Version in YAML": {
|
||||
yamlData: unsupportedVersion,
|
||||
expectErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tt := range tests {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
// Confirm valid yaml
|
||||
var md *PacketMetadata
|
||||
err := yaml.Unmarshal([]byte(tt.yamlData), &md)
|
||||
require.NoError(t, err)
|
||||
|
||||
md, err = ParsePacketMetadata([]byte(tt.yamlData))
|
||||
if tt.expectErr {
|
||||
require.Error(t, err)
|
||||
require.Nil(t, md)
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, md)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Ссылка в новой задаче
Block a user