aquasecurity · Sep 3, 2023 · Sep 4, 2023 · Sep 4, 2023 · Sep 4, 2023 · Sep 7, 2023
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,79 @@
+version: 2.1
+
+commands:
+  configure_github_access:
+    steps:
+      - run:
+          name: Configure github access
+          command: git config --global url."https://${GITHUB_USERNAME}:${GITHUB_TOKEN}@github.com/".insteadOf "https://github.com/"
+
+  restore_build_cache:
+    steps:
+      - restore_cache:
+          keys:
+            - v1.21-go-build-cache-{{ .Environment.CIRCLE_JOB }}-{{ .Environment.CIRCLE_BRANCH }}-{{ .Environment.CIRCLE_SHA1 }}
+            - v1.21-go-build-cache-{{ .Environment.CIRCLE_JOB }}-{{ .Environment.CIRCLE_BRANCH }}
+            - v1.21-go-build-cache-{{ .Environment.CIRCLE_JOB }}-main
+            - v1.21-go-build-cache-{{ .Environment.CIRCLE_JOB }}-
+
+  save_build_cache:
+    steps:
+      - save_cache:
+          key: v1.21-go-build-cache-{{ .Environment.CIRCLE_JOB }}-{{ .Environment.CIRCLE_BRANCH }}-{{ .Environment.CIRCLE_SHA1 }}
+          paths:
+            - /mnt/ramdisk/.cache/go-build
+          when: always
+
+global_context: &global_context
+  context:
+    - org-global
+    - org-datadog-credentials
+    - GITHUB_CREDS
+
+global_dockerhub_auth: &global_dockerhub_auth
+  auth:
+    username: $GLOBAL_DOCKERHUB_USERNAME
+    password: $GLOBAL_DOCKERHUB_PASSWORD
+
+executors:
+  test-container:
+    docker:
+      - image: cimg/go:1.21
+        <<: *global_dockerhub_auth
+    environment:
+      GOCACHE: /mnt/ramdisk/.cache/go-build
+      TEST_RESULTS: /tmp/test-results
+
+test_steps: &test_steps
+  steps:
+    - checkout
+    - restore_build_cache
+    - configure_github_access
+    - run:
+        name: Run tests
+        command: make test-ci
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: raw-test-output
+    - store_artifacts:
+        path: /tmp/artifacts
+    - store_test_results:
+        path: /tmp/test-results
+    - persist_to_workspace:
+        root: /tmp/artifacts
+        paths:
+          - test_coverage_stats
+    - save_build_cache
+
+jobs:
+  test:
+    executor: test-container
+    resource_class: small
+    <<: *test_steps
+
+workflows:
+  version: 2
+  build_and_push:
+    jobs:
+      - test:
+          <<: *global_context
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @deliveroo/consumer-search
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,49 @@
+name: "CodeQL - Minimal incremental analysis"
+
+on:
+  push:
+    branches:
+      - "main" # Change this to the branch to default branch
+      - "!ignore/branch" # Ignore CodeQL scan for these branches
+      - "!test/*" # Ignore CodeQL scan for these branches
+    paths-ignore:
+      - "**/*.md"
+      - "**/*.txt"
+  pull_request:
+    branches:
+      - "main" # Change this to the branch to default branch
+  # If your project is not actively developed, consider scheduling CodeQL scans
+  #schedule:
+  #  - cron: '44 23 * * 5' # Run CodeQL scan every Friday at 11:44 PM UTC
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    timeout-minutes: 30 # Set timeout to 30 minutes; Change if your project takes longer to scan
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["go"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # queries: security-extended,security-and-quality
+          # debug: true # Only use this for debugging. It will increase the runtime of the action and take up storage
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/codeql-complete.yml b/.github/workflows/codeql-complete.yml
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,6 @@
 language: go
 go:
- - 1.13.x
+ - 1.21.x
 
 script:
  - go test -v -race ./...
diff --git a/Makefile b/Makefile
@@ -0,0 +1,34 @@
+# Go related variables.
+GOBASE=$(shell pwd)
+export GOBIN=$(GOBASE)/bin
+export GOPRIVATE=github.com/deliveroo/*
+export GOPROXY=https://proxy.golang.org,off
+
+# Ensure that we use vendored binaries before consulting the system.
+GOBIN=$(shell pwd)/bin
+export PATH := $(GOBIN):$(PATH)
+
+MODULE = $(shell env GO111MODULE=on go list -m)
+
+# allows passing specific tags to go build (for example musl)
+ifdef GO_BUILD_TAGS
+GO_BUILD_TAGS_ARG += -tags $(GO_BUILD_TAGS)
+endif
+
+gocoverstats=$(GOBIN)/gocoverstats
+$(gocoverstats):
+	GOBIN=$(GOBIN) go install $(GO_BUILD_TAGS_ARG) gitlab.com/fgmarand/gocoverstats@latest
+
+.PHONY: test
+test: ## Run tests
+	APP_ENV=test go test -race ./...
+
+.PHONY: test-ci
+test-ci: $(go-junit-report) $(gocoverstats) ## Run tests and output as junit-xml
+	mkdir -p /tmp/artifacts
+	mkdir -p /tmp/test-results
+	touch /tmp/test-results/go-test.out
+	trap "$(GOBIN)/go-junit-report </tmp/test-results/go-test.out > /tmp/test-results/go-test-report.xml" EXIT; \
+	APP_ENV=test go test ${GO_TEST_ARGS} $(GO_BUILD_TAGS_ARG) -coverprofile=/tmp/artifacts/coverage.txt -race ./... 2>&1 | tee /tmp/test-results/go-test.out
+	$(GOBIN)/gocoverstats -f /tmp/artifacts/coverage.txt > /tmp/artifacts/test_coverage_stats
+	go tool cover -html=/tmp/artifacts/coverage.txt -o /tmp/artifacts/coverage.html
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# esquery
+# opensearch query builder
 
-[![](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue&style=flat-square)](https://godoc.org/github.com/aquasecurity/esquery) [![](https://img.shields.io/github/license/aquasecurity/esquery?style=flat-square)](LICENSE) [![Build Status](https://travis-ci.org/aquasecurity/esquery.svg?branch=master)](https://travis-ci.org/aquasecurity/esquery)
+[![](https://img.shields.io/github/license/aquasecurity/esquery?style=flat-square)](LICENSE) [![Build Status](https://circleci.com/gh/deliveroo/os-query.svg?branch=main)](https://app.circleci.com/pipelines/github/deliveroo/os-query?branch=main)
 
 
-**A non-obtrusive, idiomatic and easy-to-use query and aggregation builder for the [official Go client](https://github.com/elastic/go-elasticsearch) for [ElasticSearch](https://www.elastic.co/products/elasticsearch).**
+**A non-obtrusive, idiomatic and easy-to-use query and aggregation builder for the [official Opensearch client](https://opensearch.org/docs/latest/clients/go/) for [Opensearch](https://opensearch.org/).**
 
 ## Table of Contents
 
@@ -34,65 +34,59 @@ This is an early release, API may still change.
 
 `esquery` is a Go module. To install, simply run this in your project's root directory:
 
-```bash
-go get github.com/aquasecurity/esquery
-```
-
 ## Usage
 
-esquery provides a [method chaining](https://en.wikipedia.org/wiki/Method_chaining)-style API for building and executing queries and aggregations. It does not wrap the official Go client nor does it require you to change your existing code in order to integrate the library. Queries can be directly built with `esquery`, and executed by passing an `*elasticsearch.Client` instance (with optional search parameters). Results are returned as-is from the official client (e.g. `*esapi.Response` objects).
+it provides a [method chaining](https://en.wikipedia.org/wiki/Method_chaining)-style API for building and executing queries and aggregations. It does not wrap the official Go client nor does it require you to change your existing code in order to integrate the library. Queries can be directly built, and executed by passing an `*opensearch.Client` instance (with optional search parameters). Results are returned as-is from the official client (e.g. `*opensearchapi.Response` objects).
 
 Getting started is extremely simple:
 
 ```go
 package main
 
 import (
-	"context"
 	"log"
 
-	"github.com/aquasecurity/esquery"
-	"github.com/elastic/go-elasticsearch/v7"
+	"github.com/opensearch-project/opensearch-go/v2"
+
+	oq "github.com/deliveroo/os-query"
 )
 
 func main() {
-    // connect to an ElasticSearch instance
-    es, err := elasticsearch.NewDefaultClient()
-    if err != nil {
-        log.Fatalf("Failed creating client: %s", err)
-    }
-
-    // run a boolean search query
-    res, err := esquery.Search().
-        Query(
-            esquery.
-                Bool().
-                Must(esquery.Term("title", "Go and Stuff")).
-                Filter(esquery.Term("tag", "tech")),
-        ).
-        Aggs(
-            esquery.Avg("average_score", "score"),
-            esquery.Max("max_score", "score"),
-        ).
-        Size(20).
-        Run(
-            es,
-            es.Search.WithContext(context.TODO()),
-            es.Search.WithIndex("test"),
-        )
-        if err != nil {
-            log.Fatalf("Failed searching for stuff: %s", err)
-        }
-
-    defer res.Body.Close()
-
-    // ...
+	// connect to an Opensearch instance
+	client, err := opensearch.NewDefaultClient()
+	if err != nil {
+		log.Fatalf("Failed creating client: %s", err)
+	}
+
+	query := oq.Query(
+		oq.
+			Bool().
+			Must(oq.Term("title", "Go and Stuff")).
+			Filter(oq.Term("tag", "tech")),
+	).
+		Aggs(
+			oq.Avg("average_score", "score"),
+			oq.Max("max_score", "score"),
+		).
+		Size(20)
+
+	queryString, err := query.MarshalJSON()
+	if err != nil {
+		log.Fatal("Failed creating query")
+	}
+	// run a boolean search query
+	search := client.Search
+	res, err := search(search.WithQuery(string(queryString)))
+	if err != nil {
+		log.Fatal("Failed executing query")
+	}
+
+	defer res.Body.Close()
 }
 ```
 
 ## Notes
 
-* `esquery` currently supports version 7 of the ElasticSearch Go client.
 * The library cannot currently generate "short queries". For example, whereas
   ElasticSearch can accept this:
 

diff --git a/aggregations_test.go b/aggregations_test.go
@@ -1,4 +1,4 @@
-package esquery
+package query
 
 import (
 	"testing"

diff --git a/aggs_bucket.go b/aggs_bucket.go
@@ -1,10 +1,11 @@
-package esquery
+package query
 
 //----------------------------------------------------------------------------//
 
 // TermsAggregation represents an aggregation of type "terms", as described in
 // https://www.elastic.co/guide/en/elasticsearch/reference/current/
-//      search-aggregations-bucket-terms-aggregation.html
+//
+//	search-aggregations-bucket-terms-aggregation.html
 type TermsAggregation struct {
 	name        string
 	field       string
@@ -56,7 +57,7 @@ func (agg *TermsAggregation) Aggs(aggs ...Aggregation) *TermsAggregation {
 	return agg
 }
 
-// Order sets the sort for terms agg
+// Order sets the sorts for terms agg
 func (agg *TermsAggregation) Order(order map[string]string) *TermsAggregation {
 	agg.order = order
 	return agg

diff --git a/aggs_filter.go b/aggs_filter.go
@@ -1,4 +1,4 @@
-package esquery
+package query
 
 type FilterAggregation struct {
 	name   string

diff --git a/aggs_filter_test.go b/aggs_filter_test.go
@@ -1,4 +1,4 @@
-package esquery
+package query
 
 import "testing"