Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
mherwig committed Jun 19, 2024
2 parents f92739a + bb71759 commit b5fffab
Show file tree
Hide file tree
Showing 21 changed files with 1,210 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# SPDX-FileCopyrightText: 2023 Deutsche Telekom AG
#
# SPDX-License-Identifier: CC0-1.0
.idea
.vscode
.run
.fleet
*.yml
*.exe
*.cmd
*.bat
config.yml
7 changes: 7 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
include:
- project: dhei/teams/pandora/gitlab-ci-templates
file: products/gocomponents/GoComponent.Pipeline.gitlab-ci.yml
ref: develop

variables:
TARGET_IMAGE_SUBGROUP: horizon
17 changes: 17 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM golang:1.22-alpine AS build
ARG GOPROXY
ARG GONOSUMDB
ENV GOPROXY=$GOPROXY
ENV GONOSUMDB=$GONOSUMDB

WORKDIR /build
COPY . .
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-w -s -extldflags=-static" -o golaris .

FROM alpine:latest as certs
RUN apk --update add ca-certificates

FROM scratch
COPY --from=build /build/golaris golaris
COPY --from=certs /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
ENTRYPOINT ["./golaris", "serve"]
94 changes: 94 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,97 @@ By participating in this project, you agree to abide by its [Code of Conduct](./
This project follows the [REUSE standard for software licensing](https://reuse.software/).
Each file contains copyright and license information, and license texts can be found in the [./LICENSES](./LICENSES) folder. For more information visit https://reuse.software/.
You can find a guide for developers at https://telekom.github.io/reuse-template/.
=======
# Golaris



## Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

## Add your files

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:

```
cd existing_repo
git remote add origin https://gitlab.devops.telekom.de/dhei/teams/pandora/products/horizon/golaris.git
git branch -M main
git push -uf origin main
```

## Integrate with your tools

- [ ] [Set up project integrations](https://gitlab.devops.telekom.de/dhei/teams/pandora/products/horizon/golaris/-/settings/integrations)

## Collaborate with your team

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

## Test and Deploy

Use the built-in continuous integration in GitLab.

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

***

# Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

## Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

## Name
Choose a self-explaining name for your project.

## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.

## Contributing
State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.

## License
For open source projects, say how it is licensed.

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
9 changes: 9 additions & 0 deletions cmd/commands.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package cmd

import "github.com/rs/zerolog/log"

func Execute() {
if err := rootCmd.Execute(); err != nil {
log.Panic().Err(err).Msg("Could not execute root command!")
}
}
30 changes: 30 additions & 0 deletions cmd/init.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package cmd

import (
"errors"
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"golaris/config"
)

var initCmd = &cobra.Command{
Use: "init",
Short: "Initialize a local configuration for testing",
Run: initializeConfig,
}

func initializeConfig(cmd *cobra.Command, args []string) {
if err := config.InitConfig(); err != nil {
handleConfigInitErr(err)
return
}
log.Info().Msg("Configuration initialized")
}

func handleConfigInitErr(err error) {
var configFileAlreadyExistsError viper.ConfigFileAlreadyExistsError
if errors.As(err, &configFileAlreadyExistsError) {
log.Error().Msg("Configuration file already exists")
}
}
12 changes: 12 additions & 0 deletions cmd/root.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package cmd

import "github.com/spf13/cobra"

func init() {
rootCmd.AddCommand(initCmd, serveCmd)
}

var rootCmd = &cobra.Command{
Use: "Golaris",
Short: "Our service for handling circuitBreakerMessages",
}
26 changes: 26 additions & 0 deletions cmd/serve.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package cmd

import (
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
"golaris/config"
"golaris/service"
)

var serveCmd = &cobra.Command{
Use: "serve",
Short: "Starts the actual service",
Run: startGolarisService,
}

func startGolarisService(cmd *cobra.Command, args []string) {
log.Info().Msg("Starting Golaris service")
config.LoadConfiguration()

service.InitializeService()
listenApiPort()
}

func listenApiPort() {
service.Listen(config.Current.Port)
}
42 changes: 42 additions & 0 deletions config/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package config

type Configuration struct {
LogLevel string `mapstructure:"logLevel"`

Port int `mapstructure:"port"`

Security Security `mapstructure:"security"`
Tracing Tracing `mapstructure:"tracing"`

Hazelcast Hazelcast `mapstructure:"hazelcast"`
Kafka Kafka `mapstructure:"kafka"`
Mongo Mongo `mapstructure:"mongo"`
}

type Security struct {
Enabled bool `mapstructure:"enabled"`
TrustedIssuers []string `mapstructure:"trustedIssuers"`
}

type Tracing struct {
Enabled bool `mapstructure:"enabled"`
CollectorEndpoint string `mapstructure:"collectorEndpoint"`
Https bool `mapstructure:"https"`
DebugEnabled bool `mapstructure:"debugEnabled"`
}

type Hazelcast struct {
ServiceDNS string `mapstructure:"serviceDNS"`
}

type Kafka struct {
Brokers []string `mapstructure:"brokers"`
Topics []string `mapstructure:"topics"`
}

type Mongo struct {
Url string `mapstructure:"url"`
Database string `mapstructure:"database"`
Collection string `mapstructure:"collection"`
BulkSize int `mapstructure:"bulkSize"`
}
97 changes: 97 additions & 0 deletions config/loader.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package config

import (
"errors"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/spf13/viper"
"os"
"strings"
)

var Current Configuration

func LoadConfiguration() {
configureViper()
setDefaults()
readConfiguration()

if err := viper.Unmarshal(&Current); err != nil {
log.Fatal().Err(err).Msg("Could not unmarshal current configuration!")
}

applyLogLevel(Current.LogLevel)
}

func InitConfig() error {
configureViper()
setDefaults()
return viper.SafeWriteConfig()
}

func configureViper() {
viper.SetConfigName("config")
viper.SetConfigType("yml")
viper.AddConfigPath(".")
viper.SetEnvPrefix("golaris")
viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
}

func setDefaults() {
viper.SetDefault("logLevel", "info")

viper.SetDefault("port", 8080)

// Security
viper.SetDefault("security.enabled", true)
viper.SetDefault("security.trustedIssuers", []string{"iris"})

// Tracing
viper.SetDefault("tracing.enabled", true)
viper.SetDefault("tracing.collectorEndpoint", "http://localhost:4318")
viper.SetDefault("tracing.https", true)
viper.SetDefault("tracing.debugEnabled", false)

// Hazelcast
viper.SetDefault("hazelcast.serviceDNS", "localhost:5701")

// Kafka
viper.SetDefault("kafka.brokers", "localhost:9092")
viper.SetDefault("kafka.topics", []string{"status"})

// Mongo
viper.SetDefault("mongo.url", "mongodb://localhost:27017")
viper.SetDefault("mongo.database", "horizon")
viper.SetDefault("mongo.collection", "status")
viper.SetDefault("mongo.bulkSize", 50)
}

func readConfiguration() *Configuration {
if err := viper.ReadInConfig(); err != nil {
var configFileNotFoundError viper.ConfigFileNotFoundError
if !errors.As(err, &configFileNotFoundError) {
log.Info().Msg("Configuration file not found but environment variables will be taken into account!")
}
}
viper.AutomaticEnv()

var config Configuration
if err := viper.Unmarshal(&config); err != nil {
log.Fatal().Err(err).Msg("Could not unmarshal current configuration!")
}

return &config
}

func applyLogLevel(level string) {
logLevel, err := zerolog.ParseLevel(level)
if err != nil {
logLevel = zerolog.InfoLevel
log.Info().Msgf("Invalid log level %s. Info log level is used", logLevel)
}

log.Logger = zerolog.New(os.Stdout).Level(logLevel).With().Timestamp().Logger()
if logLevel == zerolog.DebugLevel {
log.Logger = log.Logger.Output(zerolog.ConsoleWriter{Out: os.Stdout})
}
}
Loading

0 comments on commit b5fffab

Please sign in to comment.