Skip to content

fix obligation creation with shortnames #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChayanDass wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix obligation creation with shortnames #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d03c6bb
fix(obligation-create):fix obligation creation wit shortname and add …
ChayanDass Jul 11, 2025
5211be4
Merge branch 'main' into fix/obligation-creation
ChayanDass Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
338 changes: 338 additions & 0 deletions pkg/api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (

"github.com/fossology/LicenseDb/pkg/db"
"github.com/fossology/LicenseDb/pkg/models"
"github.com/fossology/LicenseDb/pkg/utils"
"github.com/gin-gonic/gin"
"github.com/joho/godotenv"
"github.com/stretchr/testify/assert"
Expand All @@ -34,6 +35,7 @@ import (

var baseURL string // global variable
var AuthToken string // Global reusable token
const testDataFile = "licenseRef.json"

func TestMain(m *testing.M) {
gin.SetMode(gin.TestMode)
Expand All @@ -57,6 +59,10 @@ func TestMain(m *testing.M) {
log.Fatalf(" Failed to seed user: %v", err)
}
log.Println("First user created")
if err := createEmptyDataFile(testDataFile); err != nil {
panic("failed to create test data file: " + err.Error())
}
utils.Populatedb(testDataFile) // populate the nessesary tables with data from the file

serverPort := os.Getenv("PORT")
if serverPort == "" {
Expand Down Expand Up @@ -412,6 +418,232 @@ func TestUpdateLicense(t *testing.T) {

}

func TestCreateObligation(t *testing.T) {
t.Run("SuccessWithoutShortnames", func(t *testing.T) {
dto := models.ObligationDTO{
Topic: ptr("test-topic-1"),
Type: ptr("RIGHT"),
Text: ptr("some text"),
Modifications: ptr(false),
Classification: ptr("GREEN"),
Comment: ptr("unit test no shortnames"),
Active: ptr(true),
TextUpdatable: ptr(false),
Shortnames: []string{},
Category: ptr("GENERAL"),
}

assertObligationCreated(t, dto)
})

t.Run("SuccessWithShortnames", func(t *testing.T) {
dto := models.ObligationDTO{
Topic: ptr("test-topic-2"),
Type: ptr("RIGHT"),
Text: ptr("another text"),
Modifications: ptr(true),
Classification: ptr("YELLOW"),
Comment: ptr("unit test with shortnames"),
Active: ptr(true),
TextUpdatable: ptr(true),
Shortnames: []string{"MIT"},
Category: ptr("DISTRIBUTION"),
}

assertObligationCreated(t, dto)
})
t.Run("shortnamenotexist", func(t *testing.T) {
dto := models.ObligationDTO{
Topic: ptr("test-topic-3"),
Type: ptr("RIGHT"),
Text: ptr("text with non-existing shortname"),
Modifications: ptr(false),
Classification: ptr("RED"),
Comment: ptr("unit test with non-existing shortname"),
Active: ptr(true),
TextUpdatable: ptr(false),
Shortnames: []string{"NonExistentShortname"},
Category: ptr("GENERAL"),
}

w := makeRequest("POST", "/obligations", dto, true)
assert.Equal(t, http.StatusBadRequest, w.Code)

var res models.LicenseError
if err := json.Unmarshal(w.Body.Bytes(), &res); err != nil {
t.Errorf("Error unmarshalling JSON: %v", err)
return
}

expectedError := "license 'NonExistentShortname' not found: record not found"
assert.Equal(t, expectedError, res.Error)
assert.Equal(t, http.StatusBadRequest, res.Status)
})

t.Run("DuplicateTopic", func(t *testing.T) {
dto := models.ObligationDTO{
Topic: ptr("duplicate-topic"),
Type: ptr("RIGHT"),
Text: ptr("text for duplicate topic"),
Modifications: ptr(false),
Classification: ptr("GREEN"),
Comment: ptr("first insert"),
Active: ptr(true),
TextUpdatable: ptr(false),
Shortnames: []string{},
Category: ptr("GENERAL"),
}
assertObligationCreated(t, dto)

// Try again with same topic
w := makeRequest("POST", "/obligations", dto, true)
if w.Code == http.StatusCreated {
t.Errorf("Expected error for duplicate topic, got 201")
}
})

t.Run("MissingRequiredField", func(t *testing.T) {
dto := models.ObligationDTO{
// Topic missing
Type: ptr("RIGHT"),
Text: ptr("text"),
Modifications: ptr(false),
Classification: ptr("GREEN"),
Comment: ptr("missing topic"),
Active: ptr(true),
TextUpdatable: ptr(false),
Shortnames: []string{},
Category: ptr("GENERAL"),
}

w := makeRequest("POST", "/obligations", dto, true)
if w.Code != http.StatusBadRequest {
t.Errorf("Expected 400 for missing required field, got %d", w.Code)
}
})
}

func TestUpdateObligation(t *testing.T) {
t.Run("CreateObligation", func(t *testing.T) {
dto := models.ObligationDTO{
Topic: ptr("test-update-topic"),
Type: ptr("RIGHT"),
Text: ptr("test text for update"),
Modifications: ptr(false),
Classification: ptr("GREEN"),
Comment: ptr("unit test comment"),
Active: ptr(true),
TextUpdatable: ptr(false),
Shortnames: []string{},
Category: ptr("GENERAL"),
}
assertObligationCreated(t, dto)
})

t.Run("UpdateObligation", func(t *testing.T) {
updateDTO := models.ObligationUpdateDTO{
Type: ptr("RIGHT"),
Text: ptr("test text for update"),
Classification: ptr("GREEN"),
Modifications: ptr(true),
Comment: ptr("updated comment"),
Active: ptr(false),
TextUpdatable: ptr(false),
Category: ptr("GENERAL"),
}

assertObligationUpdated(t, "test-update-topic", updateDTO)
})
t.Run("UpdateTextUpdatableFalse", func(t *testing.T) {
updateDTO := models.ObligationUpdateDTO{
TextUpdatable: ptr(false),
}
assertObligationUpdated(t, "test-update-topic", updateDTO)
textupdate := models.ObligationUpdateDTO{
Text: ptr("Trying to update text when TextUpdatable is false"),
}
w := makeRequest("PATCH", "/obligations/test-update-topic", textupdate, true)
assert.Equal(t, http.StatusBadRequest, w.Code)
})

t.Run("UpdateTextUpdatableTrue", func(t *testing.T) {
updateDTO := models.ObligationUpdateDTO{
TextUpdatable: ptr(true),
}
assertObligationUpdated(t, "test-update-topic", updateDTO)

textupdate := models.ObligationUpdateDTO{
Text: ptr("Successfully updated text when TextUpdatable is true"),
}
w := makeRequest("PATCH", "/obligations/test-update-topic", textupdate, true)
assert.Equal(t, http.StatusOK, w.Code)

var res models.ObligationResponse
if err := json.Unmarshal(w.Body.Bytes(), &res); err != nil {
t.Errorf("Error unmarshalling JSON: %v", err)
return
}

assert.Equal(t, *textupdate.Text, *res.Data[0].Text)
})
t.Run("UpdateNonExistingObligation", func(t *testing.T) {
updateDTO := models.ObligationUpdateDTO{
Type: ptr("RIGHT"),
Text: ptr("text for non-existing obligation"),
Classification: ptr("GREEN"),
Modifications: ptr(false),
Comment: ptr("non-existing obligation comment"),
Active: ptr(true),
TextUpdatable: ptr(false),
Category: ptr("GENERAL"),
}

w := makeRequest("PATCH", "/obligations/non-existing-topic", updateDTO, true)
assert.Equal(t, http.StatusNotFound, w.Code)

var res models.LicenseError
if err := json.Unmarshal(w.Body.Bytes(), &res); err != nil {
t.Errorf("Error unmarshalling JSON: %v", err)
return
}

assert.Equal(t, "record not found", res.Error)
assert.Equal(t, http.StatusNotFound, res.Status)
})

}

func TestDeleteObligation(t *testing.T) {
topic := "delete-test-topic"
dto := models.ObligationDTO{
Topic: ptr(topic),
Type: ptr("RISK"),
Text: ptr("To be deleted"),
Classification: ptr("GREEN"),
Modifications: ptr(false),
Comment: ptr("delete comment"),
Active: ptr(true),
TextUpdatable: ptr(true),
Shortnames: []string{},
Category: ptr("GENERAL"),
}
assertObligationCreated(t, dto)

t.Run("DeleteExistingObligation", func(t *testing.T) {
w := makeRequest("DELETE", "/obligations/"+topic, nil, true)
if w.Code != http.StatusNoContent {
t.Fatalf("Expected status 204 No Content, got %d", w.Code)
}
})

t.Run("DeleteNonExistentObligation", func(t *testing.T) {
w := makeRequest("DELETE", "/obligations/"+topic, nil, true)
if w.Code != http.StatusNoContent {
t.Fatalf("Expected status 204 Not Found, got %d", w.Code)
}
})
}

// func TestSearchInLicense(t *testing.T) {
// expectLicense := models.LicenseDB{
// Shortname: func(s string) *string { return &s }("PostgreSQL"),
Expand Down Expand Up @@ -587,3 +819,109 @@ func dropTestDB(user, password, port, host, dbname string) {
log.Println(" Dropped test DB:", dbname)
}
}

func createEmptyDataFile(path string) error {
file, err := os.Create(path)
if err != nil {
return err
}
defer file.Close()

empty := []interface{}{}
return json.NewEncoder(file).Encode(empty)
}

func assertObligationCreated(t *testing.T, dto models.ObligationDTO) {
w := makeRequest("POST", "/obligations", dto, true)
if w.Code != http.StatusCreated {
t.Fatalf("Expected 201 Created, got %d", w.Code)
}

var resp struct {
Status int `json:"status"`
Data []models.ObligationDTO `json:"data"`
Meta any `json:"paginationmeta"`
}

if err := json.Unmarshal(w.Body.Bytes(), &resp); err != nil {
t.Fatalf("Failed to parse response: %v", err)
}

if len(resp.Data) == 0 {
t.Fatal("No obligation returned in response")
}

ob := resp.Data[0]

// Assertions
assertField := func(fieldName string, expected, actual any) {
if expected != actual {
t.Errorf("Expected %s = %v, got %v", fieldName, expected, actual)
}
}

assertField("Topic", *dto.Topic, *ob.Topic)
assertField("Type", *dto.Type, *ob.Type)
assertField("Text", *dto.Text, *ob.Text)
assertField("Comment", *dto.Comment, *ob.Comment)
assertField("Category", *dto.Category, *ob.Category)
assertField("Classification", *dto.Classification, *ob.Classification)
assertField("Modifications", *dto.Modifications, *ob.Modifications)
assertField("Active", *dto.Active, *ob.Active)
assertField("TextUpdatable", *dto.TextUpdatable, *ob.TextUpdatable)
assertField("Shortnames count", len(dto.Shortnames), len(ob.Shortnames))
}
func assertObligationUpdated(t *testing.T, topic string, dto models.ObligationUpdateDTO) {
w := makeRequest("PATCH", "/obligations/"+topic, dto, true)
if w.Code != http.StatusOK {
t.Fatalf("Expected 200 OK, got %d", w.Code)
}

var resp struct {
Status int `json:"status"`
Data []models.ObligationDTO `json:"data"`
Meta any `json:"paginationmeta"`
}

if err := json.Unmarshal(w.Body.Bytes(), &resp); err != nil {
t.Fatalf("Failed to parse update response: %v", err)
}

if len(resp.Data) == 0 {
t.Fatal("No obligation returned in update response")
}

ob := resp.Data[0]

// Field-wise assertions (only check non-nil fields from dto)
assertField := func(fieldName string, expected, actual any) {
if expected != actual {
t.Errorf("Expected %s = %v, got %v", fieldName, expected, actual)
}
}

if dto.Type != nil {
assertField("Type", *dto.Type, *ob.Type)
}
if dto.Text != nil {
assertField("Text", *dto.Text, *ob.Text)
}
if dto.Comment != nil {
assertField("Comment", *dto.Comment, *ob.Comment)
}
if dto.Category != nil {
assertField("Category", *dto.Category, *ob.Category)
}
if dto.Classification != nil {
assertField("Classification", *dto.Classification, *ob.Classification)
}
if dto.Modifications != nil {
assertField("Modifications", *dto.Modifications, *ob.Modifications)
}
if dto.Active != nil {
assertField("Active", *dto.Active, *ob.Active)
}
if dto.TextUpdatable != nil {
assertField("TextUpdatable", *dto.TextUpdatable, *ob.TextUpdatable)
}
}
12 changes: 12 additions & 0 deletions pkg/api/obligations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,18 @@ func CreateObligation(c *gin.Context) {
return errors.New("can not create obligation with same topic or text")
}

if err := utils.MapLicensesToObligation(tx, &obligation, obligation.Shortnames); err != nil {
er := models.LicenseError{
Status: http.StatusBadRequest,
Message: "Failed to associate licenses",
Error: err.Error(),
Path: c.Request.URL.Path,
Timestamp: time.Now().Format(time.RFC3339),
}
c.JSON(http.StatusBadRequest, er)
return err
}

if err := addChangelogsForObligation(tx, username, &obligation, &models.Obligation{}); err != nil {
er := models.LicenseError{
Status: http.StatusBadRequest,
Expand Down
Loading
Loading