Skip to content

Commit

Permalink
#103 Migrate repository (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
kernelsam authored Jan 25, 2024
1 parent ca08a7b commit 5dd6bd7
Show file tree
Hide file tree
Showing 14 changed files with 161 additions and 294 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Default code owner

* @Senzing/go-developers
* @senzing-garage/senzing-go-developers

/.github/ @Senzing/senzing-devsecops
/.github/ @senzing-garage/senzing-devsecops
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/documentation_request.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/workflows/add-dependabot-request-to-project-t-comm.yaml

This file was deleted.

24 changes: 0 additions & 24 deletions .github/workflows/add-issue-to-project-t-comm.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions PULL_REQUEST_TEMPLATE.md

This file was deleted.

32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# g2-sdk-go-mock

If you are beginning your journey with
[Senzing](https://senzing.com/),
please start with
[Senzing Quick Start guides](https://docs.senzing.com/quickstart/).

You are in the
[Senzing Garage](https://github.com/senzing-garage-garage)
where projects are "tinkered" on.
Although this GitHub repository may help you understand an approach to using Senzing,
it's not considered to be "production ready" and is not considered to be part of the Senzing product.
Heck, it may not even be appropriate for your application of Senzing!

## :warning: WARNING: g2-sdk-go-mock is still in development :warning: _

At the moment, this is "work-in-progress" with Semantic Versions of `0.n.x`.
Expand All @@ -15,29 +27,29 @@ Senzing C SDK APIs.

[![Go Reference](https://pkg.go.dev/badge/github.com/senzing/g2-sdk-go-mock.svg)](https://pkg.go.dev/github.com/senzing/g2-sdk-go-mock)
[![Go Report Card](https://goreportcard.com/badge/github.com/senzing/g2-sdk-go-mock)](https://goreportcard.com/report/github.com/senzing/g2-sdk-go-mock)
[![License](https://img.shields.io/badge/License-Apache2-brightgreen.svg)](https://github.com/Senzing/g2-sdk-go-mock/blob/main/LICENSE)
[![License](https://img.shields.io/badge/License-Apache2-brightgreen.svg)](https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/LICENSE)

[![gosec.yaml](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/gosec.yaml/badge.svg)](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/gosec.yaml)
[![go-test-linux.yaml](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-linux.yaml/badge.svg)](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-linux.yaml)
[![go-test-darwin.yaml](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-darwin.yaml/badge.svg)](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-darwin.yaml)
[![go-test-windows.yaml](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-windows.yaml/badge.svg)](https://github.com/Senzing/g2-sdk-go-mock/actions/workflows/go-test-windows.yaml)
[![gosec.yaml](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/gosec.yaml/badge.svg)](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/gosec.yaml)
[![go-test-linux.yaml](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-linux.yaml/badge.svg)](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-linux.yaml)
[![go-test-darwin.yaml](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-darwin.yaml/badge.svg)](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-darwin.yaml)
[![go-test-windows.yaml](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-windows.yaml/badge.svg)](https://github.com/senzing-garage/g2-sdk-go-mock/actions/workflows/go-test-windows.yaml)

## Overview

The Senzing `g2-sdk-go-mock` packages enable Go programs to simulate calling Senzing library functions.
The `g2-sdk-go-mock` implementation of the
[g2-sdk-go](https://github.com/Senzing/g2-sdk-go)
[g2-sdk-go](https://github.com/senzing-garage/g2-sdk-go)
interface does not require the Senzing C libraries to be installed.

Other implementations of the
[g2-sdk-go](https://github.com/Senzing/g2-sdk-go)
[g2-sdk-go](https://github.com/senzing-garage/g2-sdk-go)
interface include:

- [g2-sdk-go-base](https://github.com/Senzing/g2-sdk-go-base) - for
- [g2-sdk-go-base](https://github.com/senzing-garage/g2-sdk-go-base) - for
calling Senzing Go SDK APIs natively
- [g2-sdk-go-grpc](https://github.com/Senzing/g2-sdk-go-grpc) - for
- [g2-sdk-go-grpc](https://github.com/senzing-garage/g2-sdk-go-grpc) - for
calling Senzing SDK APIs over [gRPC](https://grpc.io/)
- [go-sdk-abstract-factory](https://github.com/Senzing/go-sdk-abstract-factory) - An
- [go-sdk-abstract-factory](https://github.com/senzing-garage/go-sdk-abstract-factory) - An
[abstract factory pattern](https://en.wikipedia.org/wiki/Abstract_factory_pattern)
for switching among implementations

Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following instructions build the example `main.go` program.

```

1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository.
1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository.

## Test

Expand Down
24 changes: 12 additions & 12 deletions g2config/g2config_examples_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
// ----------------------------------------------------------------------------

func ExampleG2config_SetObserverOrigin() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
origin := "Machine: nn; Task: UnitTest"
Expand All @@ -23,7 +23,7 @@ func ExampleG2config_SetObserverOrigin() {
}

func ExampleG2config_GetObserverOrigin() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
origin := "Machine: nn; Task: UnitTest"
Expand All @@ -34,7 +34,7 @@ func ExampleG2config_GetObserverOrigin() {
}

func ExampleG2config_AddDataSource() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -51,7 +51,7 @@ func ExampleG2config_AddDataSource() {
}

func ExampleG2config_Close() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -66,7 +66,7 @@ func ExampleG2config_Close() {
}

func ExampleG2config_Create() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -78,7 +78,7 @@ func ExampleG2config_Create() {
}

func ExampleG2config_DeleteDataSource() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -94,7 +94,7 @@ func ExampleG2config_DeleteDataSource() {
}

func ExampleG2config_ListDataSources() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -110,7 +110,7 @@ func ExampleG2config_ListDataSources() {
}

func ExampleG2config_Load() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
mockConfigHandle, err := g2config.Create(ctx)
Expand All @@ -130,7 +130,7 @@ func ExampleG2config_Load() {
}

func ExampleG2config_Save() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
configHandle, err := g2config.Create(ctx)
Expand All @@ -146,7 +146,7 @@ func ExampleG2config_Save() {
}

func ExampleG2config_SetLogLevel() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
err := g2config.SetLogLevel(ctx, logging.LevelInfoName)
Expand All @@ -157,7 +157,7 @@ func ExampleG2config_SetLogLevel() {
}

func ExampleG2config_Init() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
moduleName := "Test module name"
Expand All @@ -171,7 +171,7 @@ func ExampleG2config_Init() {
}

func ExampleG2config_Destroy() {
// For more information, visit https://github.com/Senzing/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
// For more information, visit https://github.com/senzing-garage/g2-sdk-go-mock/blob/main/g2config/g2config_examples_test.go
ctx := context.TODO()
g2config := getG2Config(ctx)
err := g2config.Destroy(ctx)
Expand Down
Loading

0 comments on commit 5dd6bd7

Please sign in to comment.