added more documentation and updated copyrights

eeisegn · eeisegn · commit 0a0cb8d42c7c · 2023-01-23T12:25:28.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Upcoming changes...
 
+## [1.0.0] - 2023-01-23
+### Added
+- Added GitHub action to build/unit test on push/pr
+- Added supporting README files
+
+## [0.7.0] - 2023-01-22
+### Added
+- Added unit tests
+- Added integration tests
+- Added End-to-end container testing
+
 ## [0.5.0] - 2023-01-07
 ### Added
 - Added attribution endpoint
@@ -30,3 +41,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.0.1]: https://github.com/scanoss/wayuu2/compare/v0.0.0...v0.0.1
 [0.4.1]: https://github.com/scanoss/wayuu2/compare/v0.0.1...v0.4.1
 [0.5.0]: https://github.com/scanoss/wayuu2/compare/v0.4.1...v0.5.0
+[0.7.0]: https://github.com/scanoss/wayuu2/compare/v0.5.0...v0.7.0
+[1.0.0]: https://github.com/scanoss/wayuu2/compare/v0.7.0...v1.0.0
diff --git a/README.md b/README.md
@@ -52,19 +52,7 @@ git tag v1.0.1
 ```
 
 ### Deployment
-
-The [scripts](scripts) folder contains an [env_setup.sh](scripts/env-setup.sh) script which attempts to do the following:
-* Set up the default folders
-* Set permissions
-* Set up service registration ([scanoss-go-api.service](scripts/scanoss-go-api.service))
-* Copy in binaries (if `scanoss-go-api` and/or `scanoss` exist in the folder)
-* Copy in preferred configuration (if `app-config-prod.json` exists in the folder)
-
-A sample production configuration file can be found in [config/app-config-prod.json](config/app-config-prod.json).
-
-Logs are written by default to `/var/log/scanoss/api/scanoss-api-prod.log`.
-
-Configuration is written by default to: `/usr/local/etc/scanoss/api`.
+This [scripts](scripts) folder contains convenience utilities for deploying, configuring and running the SCANOSS GO API server. More details can be found [here](scripts/README.md).
 
 ### Running the Service
 
@@ -103,7 +91,7 @@ To use a different config file, simply run the command manually using:
 go run cmd/server/main.go -json-config config/app-config-dev.json -debug
 ```
 
-Note, this will simulate the `scanoss` command (using [scanoss.sh](test-support/scanoss.sh)), so you might need to change this if you have the actual binary on your system.
+Note, this will simulate the `scanoss` binary (using [scanoss.sh](test-support/scanoss.sh)), so you might need to change this if you have the actual binary on your system.
 
 ### Unit Testing
 This project contains unit tests and can be invoked using:
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/config/README.md b/config/README.md
@@ -0,0 +1,24 @@
+# Sample SCANOSS Scanning GO API Configs
+This folder contains some examples of configuration for running the SCANOSS GO API.
+
+There are two types of configuration:
+* Application Config
+* IP Filtering
+
+## App Config
+There are two configs provided here:
+* Dev - [app-config-dev.json](app-config-dev.json)
+* Prod - [app-config-prod.json](app-config-prod.json)
+
+A description of each field and its intended usage can be found in [server_config.go](../pkg/config/server_config.go).
+
+## IP Filtering
+There are two types of IP filtering supports:
+* Allow List - [allow_list.txt](allow_list.txt)
+* Deny List - [deny_list.txt](deny_list.txt)
+
+The implementation for this is based on [jpillora/ipfilter](https://github.com/jpillora/ipfilter).
+
+Configuration for this is controlled via the `Filtering` block in the [config file](app-config-prod.json).
+
+Currently, specific IP addresses and subnet masks are supported. Blocking by default can be controlled via `Filtering -> BlockByDefault` and Proxy support using `Filtering -> TrustProxy`.
diff --git a/config/allow_list.txt b/config/allow_list.txt
@@ -0,0 +1,2 @@
+127.0.0.1
+#10.0.0.0/24
diff --git a/config/deny_list.txt b/config/deny_list.txt
@@ -0,0 +1 @@
+#10.0.0.0/24
diff --git a/get_version.sh b/get_version.sh
@@ -2,7 +2,7 @@
 ###
 # SPDX-License-Identifier: GPL-2.0-or-later
 #
-# Copyright (C) 2018-2022 SCANOSS.COM
+# Copyright (C) 2018-2023 SCANOSS.COM
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
diff --git a/pkg/cmd/server.go b/pkg/cmd/server.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/config/server_config.go b/pkg/config/server_config.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/config/server_config_test.go b/pkg/config/server_config_test.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/protocol/rest/server.go b/pkg/protocol/rest/server.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/service/attribution_service.go b/pkg/service/attribution_service.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/service/doc.go b/pkg/service/doc.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/service/filecontents_service.go b/pkg/service/filecontents_service.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/service/licensedetails_service.go b/pkg/service/licensedetails_service.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/pkg/service/scanning_service.go b/pkg/service/scanning_service.go
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Copyright (C) 2018-2022 SCANOSS.COM
+ * Copyright (C) 2018-2023 SCANOSS.COM
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,51 @@
+# SCANOSS Scanning Service Deployment Support
+This folder contains convenience utilities for deploying, configuring and running the SCANOSS Scanning GO API service.
+
+## Setup
+The [scripts](.) folder contains an [env_setup.sh](env-setup.sh) script which attempts to do the following:
+* Set up the default folders
+* Set permissions
+* Set up service registration ([scanoss-go-api.service](scanoss-go-api.service))
+* Copy in binaries (if `scanoss-go-api` and/or `scanoss` exist in the folder)
+* Copy in preferred configuration (if `app-config-prod.json` exists in the folder)
+
+A sample production configuration file can be found in [config/app-config-prod.json](../config/app-config-prod.json).
+
+Logs are written by default to `/var/log/scanoss/api/scanoss-api-prod.log`.
+
+Configuration is written by default to: `/usr/local/etc/scanoss/api`.
+
+## Installation
+Running the [env_setup.sh](env-setup.sh) on the target server, takes care of installation. Simply run:
+```shell
+./env_setup.sh
+```
+
+This will copy the configuration files to `/usr/local/etc/scanoss/api` the binaries to `/usr/local/bin` and the service registration to `/etc/systemd/system`. 
+
+It will also redirect logging to `/var/log/scanoss/api`.
+
+### Multi-service Registration
+If there is a need to deploy more than one API service on the same server, this can be achieved by using a different `ENVIRONMENT` name.
+
+Create a copy of the [scanoss-go-api.service](scanoss-go-api.service) using the following command:
+```shell
+cp scanoss-go-api.service scanoss-go-api-<env>.service
+```
+
+Where `env` is the name of this edition of the service (i.e. dev).
+
+The `app-config-prod.json` file will also need to be copied:
+```shell
+cp app-config-prod.json app-config-<env>.json
+```
+**Note:** Please remember to use a different port number.
+
+Finally, run the environment setup script using:
+```shell
+./env_setup.sh <env>
+```
+
+This will search for these specific service & config files and place them in the correct location.
+
+Details for starting/stopping the service will be displayed in the console at the end of installation.
diff --git a/scripts/env-setup.sh b/scripts/env-setup.sh
@@ -139,7 +139,6 @@ fi
 echo "Installation complete."
 if [ "$service_stopped" == "true" ] ; then
   echo "Restarting service after install..."
-
   if ! systemctl start "$SC_SERVICE_NAME" ; then
     echo "failed to restart service"
     exit 1
diff --git a/tests/testing_support.go b/tests/testing_support.go
@@ -14,6 +14,13 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+// Package tests provides a set of integration tests to exercise the SCANOSS Scanning GO API
+// These tests include:
+// * Scanning
+// * Attribution
+// * File Contents
+// * License Obligations
+// * Health and Metrics
 package tests
 
 import (
diff --git a/version.sh b/version.sh
@@ -2,7 +2,7 @@
 ###
 # SPDX-License-Identifier: GPL-2.0-or-later
 #
-# Copyright (C) 2018-2022 SCANOSS.COM
+# Copyright (C) 2018-2023 SCANOSS.COM
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`// SPDX-License-Identifier: GPL-2.0-or-later`
`2`	`2`	`/*`
`3`		`- * Copyright (C) 2018-2022 SCANOSS.COM`
	`3`	`+ * Copyright (C) 2018-2023 SCANOSS.COM`
`4`	`4`	`*`
`5`	`5`	`* This program is free software: you can redistribute it and/or modify`
`6`	`6`	`* it under the terms of the GNU General Public License as published by`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`###`
`3`	`3`	`# SPDX-License-Identifier: GPL-2.0-or-later`
`4`	`4`	`#`
`5`		`-# Copyright (C) 2018-2022 SCANOSS.COM`
	`5`	`+# Copyright (C) 2018-2023 SCANOSS.COM`
`6`	`6`	`#`
`7`	`7`	`# This program is free software: you can redistribute it and/or modify`
`8`	`8`	`# it under the terms of the GNU General Public License as published by`