https://github.com/bradmccoydev/self-service-sdk

Sdk For Self Service
https://github.com/bradmccoydev/self-service-sdk

Last synced: 1 day ago
JSON representation

Sdk For Self Service

• Host: GitHub
• URL: https://github.com/bradmccoydev/self-service-sdk
• Owner: bradmccoydev
• Created: 2020-08-25T06:51:49.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-29T04:57:13.000Z (about 4 years ago)
• Last Synced: 2024-06-11T20:41:14.377Z (5 months ago)
• Language: Go
• Size: 134 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Self Service SDK

This repository contains the SDK for Self Service. It is provided as a GoLang module.

## Dirctory Structure

The table below explains the layout of this directory.

| Directory | Purpose |

| :--- | :--- |

| /internal | This directory contains utility functions for internal testing etc |

| /sdk | This directory contains the [SDK packages](sdk/README.md) |

| /templates | This directory contains [templates](templates/README.md) for using the SDK |

## Requirements

The table below lists the requirements to use the SDK.

| Item | Requirement |

| :---: | :--- |

| 1 | Go >= v1.15 |

| 2 | An AWS account with appropriate permissions. See [below](#aws). |

| 3 | Certain environment variables to drive the testing framework. See [below](#testing). |

## AWS

To enable testing of the AWS functionality an AWS account is required. The table below lists the permissions required.

| Object | Permission | Notes |

| :--- | :--- | :--- |

| DynamoDB | ? | |

| Secrets Manager | ? | |

| | | |

## Testing

Certain environment variables need to be set for the various unit tests to run. These are summarised in the table below.

| Variable | Notes |

| :--- | :--- |

| TESTING_AWS_ENABLED | Set to TRUE if the AWS related tests should be run |

| TESTING_AWS_ACCESS_KEY_ID | A valid AWS Access Key that can be used to connect to AWS |

| TESTING_AWS_SECRET_ACCESS_KEY | The secret for the above AWS access key |

| TESTING_AWS_DEFAULT_REGION | The default AWS region to use |

| TESTING_AWS_USER_ID | The User ID of the above AWS user. This is used for validating a successful login |