Make some carbonifer methods public

Signed-off-by: Mathis Joffre <mathis.joffre@ovhcloud.com>
carboniferio · Feb 24, 2023 · 58a5d4e · 58a5d4e
1 parent c6fbba3
commit 58a5d4e
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 21 deletions.
diff --git a/pkg/estimate/estimate.go b/pkg/estimate/estimate.go
@@ -2,9 +2,11 @@ package estimate
 
 import (
 	"github.com/carboniferio/carbonifer/internal/estimate"
+	internalResources "github.com/carboniferio/carbonifer/internal/resources"
 	"github.com/carboniferio/carbonifer/pkg/providers"
 	"github.com/carboniferio/carbonifer/pkg/resources"
 	"github.com/shopspring/decimal"
+	"github.com/spf13/viper"
 )
 
 type EstimationReport struct {
@@ -16,7 +18,7 @@ type EstimationReport struct {
 }
 
 func GetEstimation(resource resources.GenericResource) (EstimationReport, error) {
-	estimation, err := estimate.EstimateResource(resource)
+	estimation, err := estimate.EstimateResource(toInternalComputeResource(resource))
 	if err != nil {
 		return EstimationReport{}, err
 	}
@@ -40,3 +42,25 @@ func GetEstimationFromInstanceType(instanceType string, zone string, provider pr
 	}
 	return estimation, nil
 }
+
+func toInternalComputeResource(resource resources.GenericResource) internalResources.ComputeResource {
+	return internalResources.ComputeResource{
+		Identification: resource.GetIdentification(),
+		Specs: &internalResources.ComputeResourceSpecs{
+			GpuTypes:          resource.GPUTypes,
+			HddStorage:        resource.Storage.HddStorage,
+			SsdStorage:        resource.Storage.SsdStorage,
+			MemoryMb:          resource.MemoryMb,
+			VCPUs:             resource.VCPUs,
+			CPUType:           resource.CPUTypes[0], // TODO: Support multiple CPU types
+			ReplicationFactor: resource.ReplicationFactor,
+		},
+	}
+}
+
+func init() {
+	viper.Set("data.path", "../../data")
+	viper.Set("unit.power", "")
+	viper.Set("unit.time", "")
+	viper.Set("unit.carbon", "")
+}
diff --git a/pkg/estimate/estimate_test.go b/pkg/estimate/estimate_test.go
@@ -0,0 +1,78 @@
+package estimate
+
+import (
+	"github.com/carboniferio/carbonifer/pkg/providers"
+	"github.com/carboniferio/carbonifer/pkg/resources"
+	"github.com/shopspring/decimal"
+	"reflect"
+	"testing"
+)
+
+func TestGetEstimation(t *testing.T) {
+	type args struct {
+		resource resources.GenericResource
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    EstimationReport
+		wantErr bool
+	}{
+		{
+			name: "e2-standard-2",
+			args: args{
+				resource: resources.GenericResource{
+					Name:     "e2-standard-2",
+					Region:   "europe-west4",
+					Provider: providers.GCP,
+					CPUTypes: []string{
+						"Skylake",
+						"Broadwell",
+						"Haswell",
+						"AMD EPYC Rome",
+						"AMD EPYC Milan",
+					},
+					VCPUs:             2,
+					MemoryMb:          8192,
+					Storage:           resources.Storage{},
+					ReplicationFactor: 0,
+				},
+			},
+			want: EstimationReport{
+				Resource: resources.GenericResource{
+					Name:     "e2-standard-2",
+					Region:   "europe-west4",
+					Provider: providers.GCP,
+					CPUTypes: []string{
+						"Skylake",
+						"Broadwell",
+						"Haswell",
+						"AMD EPYC Rome",
+						"AMD EPYC Milan",
+					},
+					MemoryMb:          8192,
+					VCPUs:             2,
+					Storage:           resources.Storage{},
+					ReplicationFactor: 0,
+				},
+				Power:           decimal.NewFromFloat(4.8677297799),
+				CarbonEmissions: decimal.NewFromFloat(1377.5675277218),
+				AverageCPUUsage: decimal.NewFromInt(0),
+				Count:           decimal.NewFromInt(1),
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := GetEstimation(tt.args.resource)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("GetEstimation() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("GetEstimation() got = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
diff --git a/pkg/resources/ressource.go b/pkg/resources/ressource.go
@@ -11,21 +11,26 @@ import (
 )
 
 type GenericResource struct {
-	Name     string
-	Region   string
-	Provider providers.Provider
-	GPUTypes []string
-	CPUTypes []string
-	MemoryMb int32
-	Storage  Storage
+	Name              string
+	Region            string
+	Provider          providers.Provider
+	GPUTypes          []string
+	CPUTypes          []string
+	VCPUs             int32
+	MemoryMb          int32
+	Storage           Storage
+	ReplicationFactor int32
 }
 
 // IsSupported returns true if the resource is supported by carbonifer. At the moment, only GCP is supported.
 func (g GenericResource) IsSupported() bool {
-	if g.Provider == providers.GCP {
+	// Use a switch to make it easier to add new providers
+	switch g.Provider {
+	case providers.GCP:
 		return true
+	default:
+		return false
 	}
-	return false
 }
 
 func (g GenericResource) GetIdentification() *resources.ResourceIdentification {
@@ -48,8 +53,6 @@ type Storage struct {
 }
 
 func GetResource(instanceType string, zone string, provider providers.Provider) (GenericResource, error) {
-	// TODO: remove this hardcoded path and viper.Set
-	viper.Set("data.path", "../../data")
 	switch provider {
 	case providers.GCP:
 		return fromGCPMachineTypeToResource(zone, gcp.GetGCPMachineType(instanceType, zone)), nil
@@ -60,12 +63,18 @@ func GetResource(instanceType string, zone string, provider providers.Provider)
 
 func fromGCPMachineTypeToResource(region string, machineType gcp.MachineType) GenericResource {
 	return GenericResource{
-		Name:     machineType.Name,
-		Region:   region,
-		Provider: providers.GCP,
-		GPUTypes: machineType.GPUTypes,
-		MemoryMb: machineType.MemoryMb,
-		CPUTypes: machineType.CpuTypes,
-		Storage:  Storage{},
+		Name:              machineType.Name,
+		Region:            region,
+		Provider:          providers.GCP,
+		GPUTypes:          machineType.GPUTypes,
+		MemoryMb:          machineType.MemoryMb,
+		CPUTypes:          machineType.CpuTypes,
+		VCPUs:             machineType.Vcpus,
+		Storage:           Storage{},
+		ReplicationFactor: 0,
 	}
 }
+
+func init() {
+	viper.Set("data.path", "../../data")
+}
diff --git a/pkg/resources/ressource_test.go b/pkg/resources/ressource_test.go
@@ -84,8 +84,10 @@ func TestGetResource(t *testing.T) {
 					"AMD EPYC Rome",
 					"AMD EPYC Milan",
 				},
-				MemoryMb: 8192,
-				Storage:  Storage{},
+				VCPUs:             2,
+				MemoryMb:          8192,
+				Storage:           Storage{},
+				ReplicationFactor: 0,
 			},
 			wantErr: false,
 		},