Merge pull request 6264 from hotfix/v4.3.2 into main

Author: Project Collection Build Service (51degrees)

README.md

@@ -11,6 +11,7 @@ This repository contains Go Lite implementation of device detection engine. This
 Go Lite implementation is currently supporting the following platforms and architectures:
 - Linux 32/64 bit, Intel and ARM processor
 - MacOS 64 bit, Intel and ARM processor
+- Windows 64bit, Intel
 
 Go version:
 - 1.17.1
@@ -41,8 +42,8 @@ git lfs pull
 ### Software
 
 In order to build use device-detection-go the following are required:
-- Powershell Core
-- A C compiler that support C11 or above (Gcc on Linux and Clang on MacOS)
+- Powershell Core (7 or above)
+- A C compiler that support C11 or above (Gcc on Linux, Clang on MacOS and MinGW-x64 on Windows)
 - A CMake version of 3.10 or above
 - libatomic - which usually come with default Gcc, Clang installation
 
@@ -56,6 +57,11 @@ This Go Lite version contains only one single package:
 
 ## Build and Usage
 
+### Windows
+If you are on Windows, make sure the path to the `MinGW-x64` `bin` folder is included in the `PATH`.
+
+### Build steps for all platforms
+
 Currently, it is recommended to build and use `device-detection-go` by cloning the repository rather than installing via `go mod`. To use `device-detection-go` module, users first need to build the core static libraries. There is a powershell script `prebuild.ps1` located in `dd/scripts` folder that assists on building the core static library providing that all pre-requisites have been satisfied. Run the script as below:
 ```
 pwsh -File [path to script]

ci/build-and-test.yml

@@ -29,4 +29,4 @@ stages:
 # this is triggered by one.    
 - template: shared-auto-complete-pr-stage.yml@ciTemplates
   parameters:
-    stageDependencies: [Linux,MacOS]
+    stageDependencies: [Linux,MacOS,Windows]

ci/common-ci

@@ -145,6 +145,57 @@ stages:
         displayName: 'Build device detection core binaries'
         workingDirectory: '$(Build.SourcesDirectory)'
 
+      # Run test
+      - task: Go@0
+        displayName: 'Run tests'
+        inputs:
+          command: test
+          arguments: './...'
+
+# This stage use MinGW-x64 to build binaries.
+# By default we only test 64bit version.
+- stage: Windows
+  dependsOn: []
+
+  jobs:
+    - job: Build_and_Test
+      displayName: Build and Test
+      condition: ne(${{ parameters.runTests }}, 'Off')
+
+      variables: 
+        - group: InternalKeys
+      
+      strategy:
+        matrix:
+          Windows VS 2019:
+            imageName: 'windows-2019'
+
+      pool:
+        vmImage: $(imageName)
+
+      steps:
+      - checkout: self
+        submodules: recursive
+        lfs: true
+        persistCredentials: true
+
+      # Install go
+      - task: GoTool@0
+        displayName: 'Use go ${{ parameters.goVersion }}'
+        inputs:
+          version: '${{ parameters.goVersion }}'
+
+      # Run prebuild
+      - task: Powershell@2
+        inputs:
+          targetType: inline
+          script: |
+            $PSVersionTable
+            ./dd/scripts/prebuild.ps1
+          pwsh: true
+          displayName: 'Build device detection core binaries'
+          workingDirectory: '$(Build.SourcesDirectory)'
+
       # Run test
       - task: Go@0
         displayName: 'Run tests'

ci/shared-build-and-test-stage.yml

@@ -0,0 +1,29 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
+ * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ *
+ * This Original Work is licensed under the European Union Public Licence (EUPL)
+ * v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+package dd
+
+// Error messages
+const (
+	ErrSHPropertyIncorrectFormat = "'SetHeader' property name is not in correct format."
+	ErrNoMatch                   = "No match found."
+)

dd/constants.go

@@ -25,47 +25,98 @@ package dd
 // #include <string.h>
 // #include "./device-detection-cxx/src/common-cxx/fiftyone.h"
 import "C"
+import (
+	"runtime"
+	"unsafe"
+)
 
-type EvidencePrefix int
+type EvidencePrefix C.fiftyoneDegreesEvidencePrefix
 
 const (
-	HttpHeaderString   EvidencePrefix = 1 << iota
-	HttpIpAddresses                   = 1 << iota
-	HttpEvidenceServer                = 1 << iota
-	HttpEvidenceQuery                 = 1 << iota
-	HttpEvidenceCookie                = 1 << iota
-	HttpEvidenceIgnore                = 1 << 7
+	HttpHeaderString   EvidencePrefix = C.FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING
+	HttpIpAddresses                   = C.FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_IP_ADDRESSES
+	HttpEvidenceServer                = C.FIFTYONE_DEGREES_EVIDENCE_SERVER
+	HttpEvidenceQuery                 = C.FIFTYONE_DEGREES_EVIDENCE_QUERY
+	HttpEvidenceCookie                = C.FIFTYONE_DEGREES_EVIDENCE_COOKIE
+	HttpEvidenceIgnore                = C.FIFTYONE_DEGREES_EVIDENCE_IGNORE
 )
 
+// Header Key required by engine
+type EvidenceKey struct {
+	Prefix EvidencePrefix
+	Key    string
+}
+
+// C type Evidence
+type CEvidence struct {
+	key   *C.char
+	value *C.char
+}
+
+// Evidence structure
 type Evidence struct {
-	CPtr *C.EvidenceKeyValuePairArray
+	cEvidence []CEvidence
+	CPtr      *C.EvidenceKeyValuePairArray
+}
+
+// evidenceFinalizer checks if C resource has been explicitly freed by Free
+// method. Panic if it was not.
+func evidenceFinalizer(evidence *Evidence) {
+	if evidence.CPtr != nil {
+		panic("Error: Evidence should be freed explicitly by its Free method.")
+	}
 }
 
 // NewEvidenceHash returns a new EvidenceHash object with a given capacity
-//
-// TODO: To be implemeted
-func NewEvidenceHash(capacity uint32) (evidence *Evidence, err error) {
-	// TODO: To be implemented
-	return nil, nil
+func NewEvidenceHash(capacity uint32) (evidence *Evidence) {
+	cEvidencePtr := C.EvidenceCreate(C.uint32_t(capacity))
+	e := &Evidence{
+		make([]CEvidence, 0, capacity),
+		cEvidencePtr}
+	runtime.SetFinalizer(e, evidenceFinalizer)
+	return e
 }
 
 // Free frees the evidence resources allocated in the C layer. This matches the
 // C API fiftyoneDegreesEvidenceFree
-//
-// TODO: To be implemeted
-func (evidence *Evidence) Free() error {
-	// TODO: To be implemented
-	return nil
+func (evidence *Evidence) Free() {
+	// Free the tracked C evidence strings
+	if evidence.cEvidence != nil {
+		// Free each cstring in the evidence
+		for _, e := range evidence.cEvidence {
+			C.free(unsafe.Pointer(e.key))
+			C.free(unsafe.Pointer(e.value))
+		}
+		evidence.cEvidence = nil
+	}
+
+	// Free the C resources
+	if evidence.CPtr != nil {
+		C.EvidenceFree(evidence.CPtr)
+		evidence.CPtr = nil
+	}
 }
 
 // Add adds a new evidence to the object. This matches the C API
 // fiftyoneDegreesEvidenceAddString
-//
-// TODO: To be implemeted
 func (evidence *Evidence) Add(
 	prefix EvidencePrefix,
 	key string,
 	value string) error {
-	// TODO: To be implemented
+	cKey := C.CString(key)
+	cValue := C.CString(value)
+	// Add it to the tracked map
+	evidence.cEvidence = append(evidence.cEvidence, CEvidence{cKey, cValue})
+	C.EvidenceAddString(
+		evidence.CPtr,
+		C.fiftyoneDegreesEvidencePrefix(prefix),
+		cKey,
+		cValue)
+
 	return nil
 }
+
+// Count return number of evidence in Evidence object
+func (evidence *Evidence) Count() int {
+	return int(evidence.CPtr.count)
+}

dd/device-detection-cxx

@@ -0,0 +1,107 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
+ * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ *
+ * This Original Work is licensed under the European Union Public Licence (EUPL)
+ * v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+package dd
+
+import "testing"
+
+// Test that NewEvidenceHash create new object with correct capacity.
+// Also, test that Free unset everything correctly.
+func TestNewEvidenceHash(t *testing.T) {
+	var capacity uint32 = 10
+	evidence := NewEvidenceHash(capacity)
+	if evidence == nil ||
+		evidence.CPtr == nil ||
+		evidence.cEvidence == nil ||
+		uint32(evidence.CPtr.capacity) != capacity {
+		t.Error("Failed to create new EvidenceHash.")
+	}
+
+	// Free the evidence after created
+	evidence.Free()
+	if evidence.CPtr != nil {
+		t.Error("Failed to set the C pointer to 'nil' after freed.")
+	}
+	if evidence.cEvidence != nil {
+		t.Error("Failed to set tracked C Evidence array to 'nil'.")
+	}
+}
+
+// Test that resource finalizer will panic if a pointer to
+// C resource has not been freed
+func TestEvidenceFinalizer(t *testing.T) {
+	evidence := NewEvidenceHash(1)
+
+	// Check that panic is thrown and make sure resource
+	// manager is freed.
+	defer func() {
+		if r := recover(); r == nil {
+			evidence.Free()
+			t.Error("Evidence finalizer did not panic.")
+		} else {
+			evidence.Free()
+		}
+	}()
+	// Perform finalizer on live resource
+	evidenceFinalizer(evidence)
+}
+
+// Test that evidences are added correctly
+func TestEvidenceAdd(t *testing.T) {
+	var capacity uint32 = 10
+	evidence := NewEvidenceHash(capacity)
+
+	// Add new string
+	testData := []struct {
+		prefix EvidencePrefix
+		key    string
+		value  string
+	}{
+		{HttpHeaderString, "User-Agent-1", "Test User Agent 1"},
+		{HttpEvidenceCookie, "User-Agent-2", "Test User Agent 2"},
+	}
+
+	// Added evidence
+	evidence.Add(testData[0].prefix, testData[0].key, testData[0].value)
+	evidence.Add(testData[1].prefix, testData[1].key, testData[1].value)
+
+	// Verify that evidence has been tracked correctly
+	if len(evidence.cEvidence) != len(testData) {
+		t.Errorf("Expected '%d' to be added, but actual is '%d'.",
+			len(testData), len(evidence.cEvidence))
+	}
+
+	// Check the actual count in C resource
+	if evidence.Count() != len(testData) {
+		t.Errorf("Expected '%d' to be added, but actual in C resource is '%d'.",
+			len(testData), len(evidence.cEvidence))
+	}
+
+	// Free the evidence after created
+	evidence.Free()
+	if evidence.CPtr != nil {
+		t.Error("Failed to set the C pointer to 'nil' after freed.")
+	}
+	if evidence.cEvidence != nil {
+		t.Error("Failed to set tracked C Evidence array to 'nil'.")
+	}
+}