Change project structure - separate main package to three (#105)

* Separate llm-d-inference-sim to 3 packages: llmdinferencesim, common, openaiserverapi:
- common package contains general utilities and configuration class
- openaiserverapi package contains classes representing input and output structures for v1/chat/completions and v1/completions APIs with relevant utilities
- llmdinferencesim package contains the simulator startup and execution implementation

Signed-off-by: Maya Barnea <[email protected]>

* Move IsValidText utility to a special file in common to be used in tests only

Signed-off-by: Maya Barnea <[email protected]>

---------

Signed-off-by: Maya Barnea <[email protected]>

Author: mayabar

pkg/common/common_suite_test.go

@@ -0,0 +1,13 @@
+package common_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestCommon(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Common Suite")
+}

pkg/llm-d-inference-sim/config.go pkg/common/config.gopkg/llm-d-inference-sim/config.go renamed to pkg/common/config.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package llmdinferencesim
+package common
 
 import (
 	"encoding/json"
@@ -27,7 +27,13 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-type configuration struct {
+const (
+	vLLMDefaultPort = 8000
+	ModeRandom      = "random"
+	ModeEcho        = "echo"
+)
+
+type Configuration struct {
 	// Port defines on which port the simulator runs
 	Port int `yaml:"port"`
 	// Model defines the current base model name
@@ -47,7 +53,7 @@ type configuration struct {
 	// LoraModulesString is a list of LoRA adapters as strings
 	LoraModulesString []string `yaml:"lora-modules"`
 	// LoraModules is a list of LoRA adapters
-	LoraModules []loraModule
+	LoraModules []LoraModule
 
 	// TimeToFirstToken time before the first token will be returned, in milliseconds
 	TimeToFirstToken int `yaml:"time-to-first-token"`
@@ -103,7 +109,7 @@ type configuration struct {
 	ObjectToolCallNotRequiredParamProbability int `yaml:"object-tool-call-not-required-field-probability"`
 }
 
-type loraModule struct {
+type LoraModule struct {
 	// Name is the LoRA's name
 	Name string `json:"name"`
 	// Path is the LoRA's path
@@ -113,27 +119,27 @@ type loraModule struct {
 }
 
 // Needed to parse values that contain multiple strings
-type multiString struct {
-	values []string
+type MultiString struct {
+	Values []string
 }
 
-func (l *multiString) String() string {
-	return strings.Join(l.values, " ")
+func (l *MultiString) String() string {
+	return strings.Join(l.Values, " ")
 }
 
-func (l *multiString) Set(val string) error {
-	l.values = append(l.values, val)
+func (l *MultiString) Set(val string) error {
+	l.Values = append(l.Values, val)
 	return nil
 }
 
-func (l *multiString) Type() string {
+func (l *MultiString) Type() string {
 	return "strings"
 }
 
-func (c *configuration) unmarshalLoras() error {
-	c.LoraModules = make([]loraModule, 0)
+func (c *Configuration) UnmarshalLoras() error {
+	c.LoraModules = make([]LoraModule, 0)
 	for _, jsonStr := range c.LoraModulesString {
-		var lora loraModule
+		var lora LoraModule
 		if err := json.Unmarshal([]byte(jsonStr), &lora); err != nil {
 			return err
 		}
@@ -142,13 +148,13 @@ func (c *configuration) unmarshalLoras() error {
 	return nil
 }
 
-func newConfig() *configuration {
-	return &configuration{
+func NewConfig() *Configuration {
+	return &Configuration{
 		Port:                                vLLMDefaultPort,
 		MaxLoras:                            1,
 		MaxNumSeqs:                          5,
 		MaxModelLen:                         1024,
-		Mode:                                modeRandom,
+		Mode:                                ModeRandom,
 		Seed:                                time.Now().UnixNano(),
 		MaxToolCallIntegerParam:             100,
 		MaxToolCallNumberParam:              100,
@@ -159,7 +165,7 @@ func newConfig() *configuration {
 	}
 }
 
-func (c *configuration) load(configFile string) error {
+func (c *Configuration) Load(configFile string) error {
 	configBytes, err := os.ReadFile(configFile)
 	if err != nil {
 		return fmt.Errorf("failed to read configuration file: %s", err)
@@ -169,10 +175,10 @@ func (c *configuration) load(configFile string) error {
 		return fmt.Errorf("failed to unmarshal configuration: %s", err)
 	}
 
-	return c.unmarshalLoras()
+	return c.UnmarshalLoras()
 }
 
-func (c *configuration) validate() error {
+func (c *Configuration) Validate() error {
 	if c.Model == "" {
 		return errors.New("model parameter is empty")
 	}
@@ -183,7 +189,7 @@ func (c *configuration) validate() error {
 		c.ServedModelNames = []string{c.Model}
 	}
 
-	if c.Mode != modeEcho && c.Mode != modeRandom {
+	if c.Mode != ModeEcho && c.Mode != ModeRandom {
 		return fmt.Errorf("invalid mode '%s', valid values are 'random' and 'echo'", c.Mode)
 	}
 	if c.Port <= 0 {

pkg/common/test-helpers.go

@@ -0,0 +1,57 @@
+/*
+Copyright 2025 The llm-d-inference-sim Authors.
+
+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 common
+
+import "strings"
+
+// IsValidText validates that the given text could be generated from the predefined list of sentences
+// used in tests
+func IsValidText(text string) bool {
+	charsTested := 0
+
+	for charsTested < len(text) {
+		textToCheck := text[charsTested:]
+		found := false
+
+		for _, fakeSentense := range chatCompletionFakeResponses {
+			if len(textToCheck) <= len(fakeSentense) {
+				if strings.HasPrefix(fakeSentense, textToCheck) {
+					found = true
+					charsTested = len(text)
+					break
+				}
+			} else {
+				if strings.HasPrefix(textToCheck, fakeSentense) {
+					charsTested += len(fakeSentense)
+					// during generation sentences are connected by space, skip it
+					// additional space at the end of the string is invalid
+					if text[charsTested] == ' ' && charsTested < len(text)-1 {
+						charsTested += 1
+						found = true
+					}
+					break
+				}
+			}
+		}
+
+		if !found {
+			return false
+		}
+	}
+
+	return true
+}