Skip to content

Commit f5e0a84

Browse files
afr1kaafr1ka
authored
Release/0.8.8 (#125)
* Fix schema update bug in API mode * Bump up APIFW ver to v0.8.8 * Bump up Go version up to v1.23.6 * Dependencies upgrade
1 parent 1e062c7 commit f5e0a84

File tree

16 files changed

+249
-92
lines changed

16 files changed

+249
-92
lines changed

‎.github/workflows/binaries.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
needs:
5252
- draft-release
5353
env:
54-
X_GO_DISTRIBUTION: "https://go.dev/dl/go1.22.12.linux-amd64.tar.gz"
54+
X_GO_DISTRIBUTION: "https://go.dev/dl/go1.23.6.linux-amd64.tar.gz"
5555
APIFIREWALL_NAMESPACE: "github.com/wallarm/api-firewall"
5656
strategy:
5757
matrix:
@@ -162,7 +162,7 @@ jobs:
162162
needs:
163163
- draft-release
164164
env:
165-
X_GO_VERSION: "1.22.12"
165+
X_GO_VERSION: "1.23.6"
166166
APIFIREWALL_NAMESPACE: "github.com/wallarm/api-firewall"
167167
strategy:
168168
matrix:
@@ -272,19 +272,19 @@ jobs:
272272
include:
273273
- arch: armv6
274274
distro: bullseye
275-
go_distribution: https://go.dev/dl/go1.22.12.linux-armv6l.tar.gz
275+
go_distribution: https://go.dev/dl/go1.23.6.linux-armv6l.tar.gz
276276
artifact: armv6-libc
277277
- arch: aarch64
278278
distro: bullseye
279-
go_distribution: https://go.dev/dl/go1.22.12.linux-arm64.tar.gz
279+
go_distribution: https://go.dev/dl/go1.23.6.linux-arm64.tar.gz
280280
artifact: arm64-libc
281281
- arch: armv6
282282
distro: alpine_latest
283-
go_distribution: https://go.dev/dl/go1.22.12.linux-armv6l.tar.gz
283+
go_distribution: https://go.dev/dl/go1.23.6.linux-armv6l.tar.gz
284284
artifact: armv6-musl
285285
- arch: aarch64
286286
distro: alpine_latest
287-
go_distribution: https://go.dev/dl/go1.22.12.linux-arm64.tar.gz
287+
go_distribution: https://go.dev/dl/go1.23.6.linux-arm64.tar.gz
288288
artifact: arm64-musl
289289
steps:
290290
- uses: actions/[email protected]

‎Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM golang:1.22-alpine3.21 AS build
1+
FROM golang:1.23-alpine3.21 AS build
22

33
ARG APIFIREWALL_NAMESPACE
44
ARG APIFIREWALL_VERSION

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
VERSION := 0.8.7
1+
VERSION := 0.8.8
22
NAMESPACE := github.com/wallarm/api-firewall
33

44
.DEFAULT_GOAL := build

‎cmd/api-firewall/internal/handlers/api/updater.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ func (s *Specification) Run() {
106106
}
107107
s.lock.Unlock()
108108

109+
s.logger.Debugf("%s: OpenAPI specifications have been updated", logPrefix)
110+
109111
continue
110112
}
111113

@@ -140,8 +142,8 @@ func (s *Specification) Shutdown() error {
140142
// Load function reads DB file and returns it
141143
func (s *Specification) Load() (storage.DBOpenAPILoader, error) {
142144

143-
// Load specification
144-
return storage.NewOpenAPIDB(s.cfg.PathToSpecDB, s.cfg.DBVersion)
145+
// Load specification only (without after load actions)
146+
return storage.LoadOpenAPIDB(s.cfg.PathToSpecDB, s.cfg.DBVersion)
145147
}
146148

147149
// Find function searches for the handler by path and method

‎cmd/api-firewall/tests/updater_v2_test.go‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,24 @@ paths:
4444
content: {}
4545
`
4646

47+
const testUpdatedYamlSpecification = `openapi: 3.0.1
48+
info:
49+
title: Service
50+
version: 1.1.1
51+
servers:
52+
- url: /
53+
paths:
54+
/test/updated:
55+
get:
56+
tags:
57+
- Redirects
58+
summary: Absolutely 302 Redirects n times.
59+
responses:
60+
''200'':
61+
description: A redirection.
62+
content: {}
63+
`
64+
4765
var currentDBPath = "./wallarm_api2_update.db"
4866

4967
var cfgV2 = config.APIMode{
@@ -95,6 +113,39 @@ func insertSpecV2(dbFilePath, newSpec, state string) (*EntryV2, error) {
95113
return &entry, nil
96114
}
97115

116+
func updateSpecV2(dbFilePath string, schemaID int, newState string, newSchema string) (*EntryV2, error) {
117+
118+
db, err := sql.Open("sqlite3", dbFilePath)
119+
if err != nil {
120+
return nil, err
121+
}
122+
defer db.Close()
123+
124+
q := fmt.Sprintf("UPDATE openapi_schemas SET status = '%s', schema_content='%s' WHERE schema_id == %d", newState, newSchema, schemaID)
125+
_, err = db.Exec(q)
126+
if err != nil {
127+
return nil, err
128+
}
129+
130+
// entry of the V2
131+
entry := EntryV2{}
132+
133+
rows, err := db.Query(fmt.Sprintf("SELECT * FROM openapi_schemas WHERE schema_id == %d", schemaID))
134+
if err != nil {
135+
return nil, err
136+
}
137+
defer rows.Close()
138+
139+
for rows.Next() {
140+
err = rows.Scan(&entry.SchemaID, &entry.SchemaVersion, &entry.SchemaFormat, &entry.SchemaContent, &entry.Status)
141+
if err != nil {
142+
return nil, err
143+
}
144+
}
145+
146+
return &entry, nil
147+
}
148+
98149
// check that row is applied and delete this row
99150
func cleanSpecV2(dbFilePath string, schemaID int) error {
100151

@@ -388,6 +439,61 @@ func TestUpdaterBasicV2(t *testing.T) {
388439
}
389440
}
390441

442+
// update the current entry state
443+
_, err = updateSpecV2(currentDBPath, entry.SchemaID, "new", testUpdatedYamlSpecification)
444+
if err != nil {
445+
t.Fatal(err)
446+
}
447+
448+
// start updater second time.
449+
updNewSpecErrors := make(chan error, 1)
450+
updater = handlersAPI.NewHandlerUpdater(&lock, logger, specStorage, &cfgV2, &api, shutdown, &health, nil, nil)
451+
go func() {
452+
t.Logf("starting specification regular update process every %.0f seconds", cfg.SpecificationUpdatePeriod.Seconds())
453+
updNewSpecErrors <- updater.Start()
454+
}()
455+
456+
time.Sleep(3 * time.Second)
457+
458+
if err := updater.Shutdown(); err != nil {
459+
t.Fatal(err)
460+
}
461+
462+
// valid route in the updated spec
463+
req = fasthttp.AcquireRequest()
464+
req.SetRequestURI("/test/updated")
465+
req.Header.SetMethod("GET")
466+
req.Header.Add(web.XWallarmSchemaIDHeader, fmt.Sprintf("%d", entry.SchemaID))
467+
468+
reqCtx = fasthttp.RequestCtx{
469+
Request: *req,
470+
}
471+
472+
lock.RLock()
473+
api.Handler(&reqCtx)
474+
lock.RUnlock()
475+
476+
if reqCtx.Response.StatusCode() != 200 {
477+
t.Errorf("Incorrect response status code. Expected: 200 and got %d",
478+
reqCtx.Response.StatusCode())
479+
}
480+
481+
apifwResponse = validator.ValidationResponse{}
482+
if err := json.Unmarshal(reqCtx.Response.Body(), &apifwResponse); err != nil {
483+
t.Errorf("Error while JSON response parsing: %v", err)
484+
}
485+
486+
if len(apifwResponse.Summary) > 0 {
487+
if *apifwResponse.Summary[0].SchemaID != entry.SchemaID {
488+
t.Errorf("Incorrect error code. Expected: %d and got %d",
489+
entry.SchemaID, *apifwResponse.Summary[0].SchemaID)
490+
}
491+
if *apifwResponse.Summary[0].StatusCode != fasthttp.StatusOK {
492+
t.Errorf("Incorrect result status. Expected: %d and got %d",
493+
fasthttp.StatusOK, *apifwResponse.Summary[0].StatusCode)
494+
}
495+
}
496+
391497
}
392498

393499
func TestUpdaterFromEmptyDBV2(t *testing.T) {

‎cmd/api-firewall/tests/wallarm_api2_update.db‎

0 Bytes
Binary file not shown.

‎demo/docker-compose/OWASP_CoreRuleSet/docker-compose.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3.8"
22
services:
33
api-firewall:
44
container_name: api-firewall
5-
image: wallarm/api-firewall:v0.8.7
5+
image: wallarm/api-firewall:v0.8.8
66
restart: on-failure
77
environment:
88
APIFW_URL: "http://0.0.0.0:8080"

‎demo/docker-compose/docker-compose-api-mode.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: '3.8'
22
services:
33
api-firewall:
44
container_name: api-firewall
5-
image: wallarm/api-firewall:v0.8.7
5+
image: wallarm/api-firewall:v0.8.8
66
restart: on-failure
77
environment:
88
APIFW_MODE: "api"

‎demo/docker-compose/docker-compose-graphql-mode.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: '3.8'
22
services:
33
api-firewall:
44
container_name: api-firewall
5-
image: wallarm/api-firewall:v0.8.7
5+
image: wallarm/api-firewall:v0.8.8
66
restart: on-failure
77
environment:
88
APIFW_MODE: "graphql"

‎demo/docker-compose/docker-compose.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3.8"
22
services:
33
api-firewall:
44
container_name: api-firewall
5-
image: wallarm/api-firewall:v0.8.7
5+
image: wallarm/api-firewall:v0.8.8
66
restart: on-failure
77
environment:
88
APIFW_URL: "http://0.0.0.0:8080"

0 commit comments

Comments
 (0)