Fixes, updates and refactor.

Author: Strabox

.travis.yml

@@ -5,9 +5,9 @@ before_script:
 - mv ../../Strabox ../../strabox
 script:
 # Build the project
-- make build
-# Test the project
-- make test
+- make
+# Run the default/example simulation
+- make simulate
 notifications:
  on_success: change
  on_failure: change

Gopkg.lock

@@ -39,7 +39,7 @@
 
 [[constraint]]
  name = "github.com/strabox/caravela"
- version = "0.1.0"
+ version = "0.2.1"
 
 [prune]
  go-tests = true

Gopkg.toml

@@ -5,14 +5,15 @@ GOCMD=go
 GOBUILD=$(GOCMD) build
 GOINSTALL=$(GOCMD) install
 GOCLEAN=$(GOCMD) clean
+GOTEST=$(GOCMD) test
 
 ############ Output Files ###########
 EXE=.exe
 BINARY_NAME=caravela_sim$(EXE)
 
 ########################## COMMANDS ############################
 
-all: build
+all: test build
 
 build:
 @echo Building for the current machine settings...
@@ -28,6 +29,9 @@ install:
 $(GOINSTALL) -v -gcflags "-N -l" .
 
 test:
-@echo Testing CARAVELA-SIM...
-$(BINARY_NAME) start
+@echo Testing...
+$(GOTEST) -v ./...
 
+simulate:
+@echo Executing default/example simulation
+$(BINARY_NAME) start

Makefile

@@ -18,6 +18,7 @@ func Run() {
 app.Author = author
 app.Email = email
 
+// Global Flags.
 app.Flags = []cli.Flag{
 cli.StringFlag{
 Name: "log, l",
@@ -31,22 +32,20 @@ func Run() {
 },
 }
 
-// Before running the user's command
+// Before running the user's command.
 app.Before = func(context *cli.Context) error {
 logger := log.New()
-
 // Set the format of the log text and the place to write
 logger.Level = util.LogLevel(context.String("log"))
 logger.Formatter = util.LogFormatter(true, true)
-log.SetOutput(os.Stdout)
-
+logger.SetOutput(os.Stdout)
 util.Init(logger)
 return nil
 }
 
 app.Commands = commands
 
-// Run the user's command
+// Run the user's command.
 if err := app.Run(os.Args); err != nil {
 log.Fatal(err)
 }

cli/cli.go

@@ -1,6 +1,6 @@
 [Caravela]
 RefreshingInterval = "30s"
-OffersStrategy = "chordDefault"
+OffersStrategy = "chord-smart"
 Simulation = true
  # Cpu Cores Partitions
  [[Caravela.CpuCoresPartitions]]

configuration.toml

@@ -21,17 +21,23 @@ type Configuration struct {
 NumberOfNodes int // Number of nodes used in the simulation.
 TickInterval duration // Interval between each simulator tick (in simulation time).
 MaxTicks int // Maximum number of ticks done by the simulator.
+Multithread bool // Used to leverage the multiple cores to speed up the simulation.
+RequestFeeder string // Used to feed the simulator with a series of requests.
+ResourceGenerator string // Strategy used to generate the resources for each node.
 OutDirectoryPath string // Path of the output's directory.
 SimulatorLogLevel string // Log's level of the simulator.
 CaravelaLogLevel string // Log's level of the CARAVELA's system.
 }
 
-// Produces the configuration structure for a basic simulation.
+// Default creates the configuration structure for a basic/default simulation.
 func Default() *Configuration {
 return &Configuration{
 NumberOfNodes: 2500,
 TickInterval: duration{Duration: 10 * time.Second},
 MaxTicks: 15,
+Multithread: true,
+RequestFeeder: "random",
+ResourceGenerator: "partition-based",
 OutDirectoryPath: DefaultOutDirectoryPath,
 SimulatorLogLevel: DefaultSimLogLevel,
 CaravelaLogLevel: "info",
@@ -97,6 +103,18 @@ func (config *Configuration) MaximumTicks() int {
 return config.MaxTicks
 }
 
+func (config *Configuration) Multithreaded() bool {
+return config.Multithread
+}
+
+func (config *Configuration) Feeder() string {
+return config.RequestFeeder
+}
+
+func (config *Configuration) ResourceGen() string {
+return config.ResourceGenerator
+}
+
 func (config *Configuration) OutputDirectoryPath() string {
 return config.OutDirectoryPath
 }
@@ -118,6 +136,9 @@ func (config *Configuration) Print() {
 util.Log.Infof("#Nodes: %d", config.TotalNumberOfNodes())
 util.Log.Infof("Tick Interval: %s", config.TicksInterval().String())
 util.Log.Infof("Max Ticks: %d", config.MaximumTicks())
+util.Log.Infof("Multithread: %t", config.Multithreaded())
+util.Log.Infof("Request Feeder: %s", config.Feeder())
+util.Log.Infof("Resource Generator: %s", config.ResourceGen())
 util.Log.Infof("Output directory: %s", config.OutputDirectoryPath())
 util.Log.Infof("Sim's log level: %s", config.SimulatorLogsLevel())
 util.Log.Infof("CARAVELA's log level: %s", config.CaravelaLogsLevel())

configuration/configuration.go

@@ -0,0 +1,3 @@
+snapshot metrics in memory -> disc [some work]
+single-thread->multithread (speedup simulation 2x + added realism and request concurrency) [much work to handle multiple requests and track their metrics]
+requests feeder programmatically, from files whatever [a bit of work]

features.txt

@@ -1,7 +1,9 @@
 package caravela
 
 import (
+"context"
 "github.com/strabox/caravela-sim/simulation/metrics"
+"github.com/strabox/caravela-sim/util"
 "github.com/strabox/caravela/api/types"
 "github.com/strabox/caravela/configuration"
 )
@@ -25,65 +27,79 @@ func NewRemoteClientMock(nodeService NodeService, metricsCollector *metrics.Coll
 // = CARAVELA's Remote Client Interface =
 // ===============================================================================
 
-func (mock *RemoteClientMock) CreateOffer(fromSupp *types.Node, toTrader *types.Node,
+func (mock *RemoteClientMock) CreateOffer(ctx context.Context, fromSupp *types.Node, toTrader *types.Node,
 offer *types.Offer) error {
 
 node, nodeIndex := mock.nodeService.NodeByGUID(toTrader.GUID)
+
+// Collect Metrics
 mock.collector.APIRequestReceived(nodeIndex)
 
-node.CreateOffer(fromSupp, toTrader, offer)
+node.CreateOffer(ctx, fromSupp, toTrader, offer)
 return nil
 }
 
-func (mock *RemoteClientMock) RefreshOffer(fromTrader, toSupp *types.Node, offer *types.Offer) (bool, error) {
+func (mock *RemoteClientMock) RefreshOffer(ctx context.Context, fromTrader, toSupp *types.Node, offer *types.Offer) (bool, error) {
 node, nodeIndex := mock.nodeService.NodeByIP(toSupp.IP)
+
+// Collect Metrics
 mock.collector.APIRequestReceived(nodeIndex)
 
-return node.RefreshOffer(fromTrader, offer), nil
+return node.RefreshOffer(ctx, fromTrader, offer), nil
 }
 
-func (mock *RemoteClientMock) RemoveOffer(fromSupp, toTrader *types.Node, offer *types.Offer) error {
+func (mock *RemoteClientMock) RemoveOffer(ctx context.Context, fromSupp, toTrader *types.Node, offer *types.Offer) error {
 node, nodeIndex := mock.nodeService.NodeByGUID(toTrader.GUID)
+
+// Collect Metrics
 mock.collector.APIRequestReceived(nodeIndex)
 
-node.RemoveOffer(fromSupp, toTrader, offer)
+node.RemoveOffer(ctx, fromSupp, toTrader, offer)
 return nil
 }
 
-func (mock *RemoteClientMock) GetOffers(fromNode, toTrader *types.Node, relay bool) ([]types.AvailableOffer, error) {
+func (mock *RemoteClientMock) GetOffers(ctx context.Context, fromNode, toTrader *types.Node, relay bool) ([]types.AvailableOffer, error) {
 node, nodeIndex := mock.nodeService.NodeByGUID(toTrader.GUID)
-mock.collector.IncrMessagesTradedRequest(1)
+
+// Collect Metrics
+mock.collector.IncrMessagesTradedRequest(ctx.Value(types.RequestCtxKey(util.SimRequestIDKey)).(string), 1)
 mock.collector.APIRequestReceived(nodeIndex)
 
-offers := node.GetOffers(fromNode, toTrader, relay)
+offers := node.GetOffers(ctx, fromNode, toTrader, relay)
 return offers, nil
 }
 
-func (mock *RemoteClientMock) AdvertiseOffersNeighbor(fromTrader, toNeighborTrader, traderOffering *types.Node) error {
+func (mock *RemoteClientMock) AdvertiseOffersNeighbor(ctx context.Context, fromTrader, toNeighborTrader, traderOffering *types.Node) error {
 node, nodeIndex := mock.nodeService.NodeByGUID(toNeighborTrader.GUID)
+
+// Collect Metrics
 mock.collector.APIRequestReceived(nodeIndex)
 
-node.AdvertiseOffersNeighbor(fromTrader, toNeighborTrader, traderOffering)
+node.AdvertiseOffersNeighbor(ctx, fromTrader, toNeighborTrader, traderOffering)
 return nil
 }
 
-func (mock *RemoteClientMock) LaunchContainer(fromBuyer, toSupplier *types.Node, offer *types.Offer,
-containerConfig *types.ContainerConfig) (*types.ContainerStatus, error) {
+func (mock *RemoteClientMock) LaunchContainer(ctx context.Context, fromBuyer, toSupplier *types.Node, offer *types.Offer,
+containersConfigs []types.ContainerConfig) ([]types.ContainerStatus, error) {
 node, nodeIndex := mock.nodeService.NodeByIP(toSupplier.IP)
-mock.collector.IncrMessagesTradedRequest(1)
+
+// Collect Metrics
+mock.collector.IncrMessagesTradedRequest(ctx.Value(types.RequestCtxKey(util.SimRequestIDKey)).(string), 1)
 mock.collector.APIRequestReceived(nodeIndex)
 
-return node.LaunchContainers(fromBuyer, offer, containerConfig)
+return node.LaunchContainers(ctx, fromBuyer, offer, containersConfigs)
 }
 
-func (mock *RemoteClientMock) StopLocalContainer(toSupplier *types.Node, containerID string) error {
+func (mock *RemoteClientMock) StopLocalContainer(ctx context.Context, toSupplier *types.Node, containerID string) error {
 node, nodeIndex := mock.nodeService.NodeByIP(toSupplier.IP)
+
+// Collect Metrics
 mock.collector.APIRequestReceived(nodeIndex)
 
-return node.StopLocalContainer(containerID)
+return node.StopLocalContainer(ctx, containerID)
 }
 
-func (mock *RemoteClientMock) ObtainConfiguration(systemsNode *types.Node) (*configuration.Configuration, error) {
+func (mock *RemoteClientMock) ObtainConfiguration(_ context.Context, _ *types.Node) (*configuration.Configuration, error) {
 // Do Nothing (Not necessary for the simulation)
 return nil, nil
 }

mocks/caravela/api_remote_client_mock.go

@@ -28,7 +28,7 @@ func Init(logLevel string) {
 // Configuration is a wrapper for obtaining the CARAVELA's configurations structure from the
 // default file.
 func Configuration() *caravelaConfig.Configuration {
-caravelaConfigs, err := caravelaConfig.ReadFromFile(util.RandomIP())
+caravelaConfigs, err := caravelaConfig.ReadFromFile(util.RandomIP(), caravelaConfig.DefaultFilePath)
 if err != nil {
 panic(errors.New("problem reading CARAVELA's config file, error: " + err.Error()))
 }