From 2812610eaa3535af7fd0fccb961a55c4d415d224 Mon Sep 17 00:00:00 2001 From: Tyschitskaya Maria Date: Wed, 14 Dec 2022 17:14:18 +0300 Subject: [PATCH 1/2] module features uploader --- core/module_features_uploader.go | 123 +++++++++++++++++++++++++++++++ go.mod | 7 +- go.sum | 50 ++++++++++--- 3 files changed, 167 insertions(+), 13 deletions(-) create mode 100644 core/module_features_uploader.go diff --git a/core/module_features_uploader.go b/core/module_features_uploader.go new file mode 100644 index 0000000..e305401 --- /dev/null +++ b/core/module_features_uploader.go @@ -0,0 +1,123 @@ +package core + +import ( + "bytes" + "context" + "fmt" + "html/template" + "io/fs" + "os" + + "github.com/aws/aws-sdk-go-v2/aws" + awsConfig "github.com/aws/aws-sdk-go-v2/config" + "github.com/aws/aws-sdk-go-v2/service/s3" + "github.com/gomarkdown/markdown" + "golang.org/x/text/language" + + "github.com/retailcrm/mg-transport-core/v2/core/config" + "github.com/retailcrm/mg-transport-core/v2/core/logger" +) + +type ModuleFeaturesUploader struct { + client *s3.Client + log logger.Logger + loc LocalizerInterface + bucket string + folder string + featuresFilename string +} + +var languages = []language.Tag{language.Russian, language.English, language.Spanish} + +func NewModuleFeaturesUploader( + log logger.Logger, + conf config.AWS, + translateFs fs.FS, + featuresFilename string, +) *ModuleFeaturesUploader { + customResolver := aws.EndpointResolverWithOptionsFunc( + func(service, region string, options ...interface{}) (aws.Endpoint, error) { + return aws.Endpoint{ + URL: conf.Endpoint, + SigningRegion: conf.Region, + }, nil + }, + ) + customProvider := aws.CredentialsProviderFunc(func(ctx context.Context) (aws.Credentials, error) { + return aws.Credentials{ + AccessKeyID: conf.AccessKeyID, + SecretAccessKey: conf.SecretAccessKey, + CanExpire: false, + }, nil + }) + + cfg, err := awsConfig.LoadDefaultConfig( + context.TODO(), + awsConfig.WithEndpointResolverWithOptions(customResolver), + awsConfig.WithCredentialsProvider(customProvider), + ) + if err != nil { + log.Fatal(err) + } + + return &ModuleFeaturesUploader{ + client: s3.NewFromConfig(cfg), + log: log, + loc: NewLocalizerFS(DefaultLanguage, DefaultLocalizerMatcher(), translateFs), + bucket: conf.Bucket, + folder: conf.FolderName, + featuresFilename: featuresFilename, + } +} + +func (s *ModuleFeaturesUploader) Upload() { + s.log.Debugf("upload module features started...") + + content, err := os.ReadFile(s.featuresFilename) + if err != nil { + s.log.Errorf("cannot read markdown file %s %s", s.featuresFilename, err.Error()) + return + } + + for _, lang := range languages { + translated, err := s.translate(content, lang) + if err != nil { + s.log.Errorf("cannot translate module features file to %s: %s", lang.String(), err.Error()) + continue + } + + html := markdown.ToHTML(translated, nil, nil) + + if err := s.uploadFile(html, lang.String()); err != nil { + s.log.Errorf("cannot upload file %s: %s", lang.String(), err.Error()) + continue + } + } + + s.log.Debugf("upload module features finished") +} + +func (s *ModuleFeaturesUploader) translate(content []byte, lang language.Tag) ([]byte, error) { + s.loc.SetLanguage(lang) + page := template.Must(template.New("").Funcs(template.FuncMap{ + "trans": s.loc.GetLocalizedMessage, + }).Parse(string(content))) + + output := &bytes.Buffer{} + err := page.Execute(output, map[string]interface{}{}) + if err != nil { + return nil, err + } + + return output.Bytes(), nil +} + +func (s *ModuleFeaturesUploader) uploadFile(content []byte, filename string) error { + _, err := s.client.PutObject(context.TODO(), &s3.PutObjectInput{ + Bucket: aws.String(s.bucket), + Key: aws.String(fmt.Sprintf("%s/%s.html", s.folder, filename)), + Body: bytes.NewReader(content), + }) + + return err +} diff --git a/go.mod b/go.mod index 4a216d9..abc874c 100644 --- a/go.mod +++ b/go.mod @@ -6,15 +6,17 @@ require ( cloud.google.com/go v0.60.0 // indirect github.com/DATA-DOG/go-sqlmock v1.3.3 github.com/aws/aws-sdk-go v1.36.30 - github.com/certifi/gocertifi v0.0.0-20200922220541-2c3bb06c6054 // indirect + github.com/aws/aws-sdk-go-v2 v1.17.2 + github.com/aws/aws-sdk-go-v2/config v1.18.4 + github.com/aws/aws-sdk-go-v2/service/s3 v1.29.5 github.com/denisenkom/go-mssqldb v0.0.0-20190830225923-3302f0226fbd // indirect - github.com/getsentry/raven-go v0.2.0 // indirect github.com/getsentry/sentry-go v0.12.0 github.com/gin-contrib/multitemplate v0.0.0-20190914010127-bba2ccfe37ec github.com/gin-gonic/gin v1.7.2 github.com/go-playground/validator/v10 v10.8.0 github.com/go-sql-driver/mysql v1.5.0 // indirect github.com/golang/protobuf v1.5.2 // indirect + github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c github.com/gorilla/securecookie v1.1.1 github.com/gorilla/sessions v1.2.0 github.com/jessevdk/go-flags v1.4.0 @@ -31,7 +33,6 @@ require ( github.com/stretchr/testify v1.7.0 github.com/ugorji/go v1.2.6 // indirect golang.org/x/text v0.3.7 - golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/protobuf v1.27.1 // indirect gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect gopkg.in/gormigrate.v1 v1.6.0 diff --git a/go.sum b/go.sum index 8745546..93e7119 100644 --- a/go.sum +++ b/go.sum @@ -51,11 +51,45 @@ github.com/apache/thrift v0.12.0/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= github.com/aws/aws-sdk-go v1.36.30 h1:hAwyfe7eZa7sM+S5mIJZFiNFwJMia9Whz6CYblioLoU= github.com/aws/aws-sdk-go v1.36.30/go.mod h1:hcU610XS61/+aQV88ixoOzUoG7v3b31pl2zKMmprdro= +github.com/aws/aws-sdk-go-v2 v1.17.2 h1:r0yRZInwiPBNpQ4aDy/Ssh3ROWsGtKDwar2JS8Lm+N8= +github.com/aws/aws-sdk-go-v2 v1.17.2/go.mod h1:uzbQtefpm44goOPmdKyAlXSNcwlRgF3ePWVW6EtJvvw= +github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.4.10 h1:dK82zF6kkPeCo8J1e+tGx4JdvDIQzj7ygIoLg8WMuGs= +github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.4.10/go.mod h1:VeTZetY5KRJLuD/7fkQXMU6Mw7H5m/KP2J5Iy9osMno= +github.com/aws/aws-sdk-go-v2/config v1.18.4 h1:VZKhr3uAADXHStS/Gf9xSYVmmaluTUfkc0dcbPiDsKE= +github.com/aws/aws-sdk-go-v2/config v1.18.4/go.mod h1:EZxMPLSdGAZ3eAmkqXfYbRppZJTzFTkv8VyEzJhKko4= +github.com/aws/aws-sdk-go-v2/credentials v1.13.4 h1:nEbHIyJy7mCvQ/kzGG7VWHSBpRB4H6sJy3bWierWUtg= +github.com/aws/aws-sdk-go-v2/credentials v1.13.4/go.mod h1:/Cj5w9LRsNTLSwexsohwDME32OzJ6U81Zs33zr2ZWOM= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.20 h1:tpNOglTZ8kg9T38NpcGBxudqfUAwUzyUnLQ4XSd0CHE= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.20/go.mod h1:d9xFpWd3qYwdIXM0fvu7deD08vvdRXyc/ueV+0SqaWE= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.26 h1:5WU31cY7m0tG+AiaXuXGoMzo2GBQ1IixtWa8Yywsgco= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.26/go.mod h1:2E0LdbJW6lbeU4uxjum99GZzI0ZjDpAb0CoSCM0oeEY= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.20 h1:WW0qSzDWoiWU2FS5DbKpxGilFVlCEJPwx4YtjdfI0Jw= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.20/go.mod h1:/+6lSiby8TBFpTVXZgKiN/rCfkYXEGvhlM4zCgPpt7w= +github.com/aws/aws-sdk-go-v2/internal/ini v1.3.27 h1:N2eKFw2S+JWRCtTt0IhIX7uoGGQciD4p6ba+SJv4WEU= +github.com/aws/aws-sdk-go-v2/internal/ini v1.3.27/go.mod h1:RdwFVc7PBYWY33fa2+8T1mSqQ7ZEK4ILpM0wfioDC3w= +github.com/aws/aws-sdk-go-v2/internal/v4a v1.0.17 h1:5tXbMJ7Jq0iG65oiMg6tCLsHkSaO2xLXa2EmZ29vaTA= +github.com/aws/aws-sdk-go-v2/internal/v4a v1.0.17/go.mod h1:twV0fKMQuqLY4klyFH56aXNq3AFiA5LO0/frTczEOFE= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.9.11 h1:y2+VQzC6Zh2ojtV2LoC0MNwHWc6qXv/j2vrQtlftkdA= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.9.11/go.mod h1:iV4q2hsqtNECrfmlXyord9u4zyuFEJX9eLgLpSPzWA8= +github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.1.21 h1:77b1GfaSuIok5yB/3HYbG+ypWvOJDQ2rVdq943D17R4= +github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.1.21/go.mod h1:sPOz31BVdqeeurKEuUpLNSve4tdCNPluE+070HNcEHI= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.20 h1:jlgyHbkZQAgAc7VIxJDmtouH8eNjOk2REVAQfVhdaiQ= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.20/go.mod h1:Xs52xaLBqDEKRcAfX/hgjmD3YQ7c/W+BEyfamlO/W2E= +github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.13.20 h1:4K6dbmR0mlp3o4Bo78PnpvzHtYAqEeVMguvEenpMGsI= +github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.13.20/go.mod h1:1XpDcReIEOHsjwNToDKhIAO3qwLo1BnfbtSqWJa8j7g= +github.com/aws/aws-sdk-go-v2/service/s3 v1.29.5 h1:nRSEQj1JergKTVc8RGkhZvOEGgcvo4fWpDPwGDeg2ok= +github.com/aws/aws-sdk-go-v2/service/s3 v1.29.5/go.mod h1:wcaJTmjKFDW0s+Se55HBNIds6ghdAGoDDw+SGUdrfAk= +github.com/aws/aws-sdk-go-v2/service/sso v1.11.26 h1:ActQgdTNQej/RuUJjB9uxYVLDOvRGtUreXF8L3c8wyg= +github.com/aws/aws-sdk-go-v2/service/sso v1.11.26/go.mod h1:uB9tV79ULEZUXc6Ob18A46KSQ0JDlrplPni9XW6Ot60= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.13.9 h1:wihKuqYUlA2T/Rx+yu2s6NDAns8B9DgnRooB1PVhY+Q= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.13.9/go.mod h1:2E/3D/mB8/r2J7nK42daoKP/ooCwbf0q1PznNc+DZTU= +github.com/aws/aws-sdk-go-v2/service/sts v1.17.6 h1:VQFOLQVL3BrKM/NLO/7FiS4vcp5bqK0mGMyk09xLoAY= +github.com/aws/aws-sdk-go-v2/service/sts v1.17.6/go.mod h1:Az3OXXYGyfNwQNsK/31L4R75qFYnO641RZGAoV3uH1c= +github.com/aws/smithy-go v1.13.5 h1:hgz0X/DX0dGqTYpGALqXJoRKRj5oQ7150i5FdTePzO8= +github.com/aws/smithy-go v1.13.5/go.mod h1:Tg+OJXh4MB2R/uN61Ko2f6hTZwB/ZYGOtib8J3gBHzA= github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible/go.mod h1:osfaiScAUVup+UC9Nfq76eWqDhXlp+4UYaA8uhTBO6g= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= -github.com/certifi/gocertifi v0.0.0-20200922220541-2c3bb06c6054 h1:uH66TXeswKn5PW5zdZ39xEwfS9an067BirqA+P4QaLI= -github.com/certifi/gocertifi v0.0.0-20200922220541-2c3bb06c6054/go.mod h1:sGbDF6GwGcLpkNXPUTkMRoywsNa/ol15pxFe6ERfguA= github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= @@ -92,8 +126,6 @@ github.com/fasthttp-contrib/websocket v0.0.0-20160511215533-1f3b11f56072/go.mod github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= github.com/gavv/httpexpect v2.0.0+incompatible/go.mod h1:x+9tiU1YnrOvnB725RkpoLv1M62hOWzwo5OXotisrKc= -github.com/getsentry/raven-go v0.2.0 h1:no+xWJRb5ZI7eE8TWgIq1jLulQiIoLG0IfYxv5JYMGs= -github.com/getsentry/raven-go v0.2.0/go.mod h1:KungGk8q33+aIAZUIVWZDr2OfAEBsO49PX4NzFV5kcQ= github.com/getsentry/sentry-go v0.12.0 h1:era7g0re5iY13bHSdN/xMkyV+5zZppjRVQhZrXCaEIk= github.com/getsentry/sentry-go v0.12.0/go.mod h1:NSap0JBYWzHND8oMbyi0+XZhUalc1TBdRL1M71JZW2c= github.com/gin-contrib/multitemplate v0.0.0-20190914010127-bba2ccfe37ec h1:mfeHJfPwsXp/iovjrTwxtkTMRAIXZu6Uxg6O95En1+Y= @@ -160,6 +192,8 @@ github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaS github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c h1:iyaGYbCmcYK0Ja9a3OUa2Fo+EaN0cbLu0eKpBwPFzc8= +github.com/gomarkdown/markdown v0.0.0-20221013030248-663e2500819c/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= github.com/gomodule/redigo v1.7.1-0.20190724094224-574c33c3df38/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= @@ -169,8 +203,9 @@ github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMyw github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg= +github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck= github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= @@ -325,8 +360,6 @@ github.com/prometheus/common v0.2.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y8 github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= github.com/prometheus/procfs v0.0.0-20190117184657-bf6a532e95b1/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= github.com/rcrowley/go-metrics v0.0.0-20181016184325-3113b8401b8a/go.mod h1:bCqnVzQkZxMG4s8nGwiZ5l3QUCyqpo9Y+/ZMZ9VjZe4= -github.com/retailcrm/api-client-go/v2 v2.0.3 h1:7oKwOZgRLM7eEJUvFNhzfnyIJVomy80ffOEBdYpQRIs= -github.com/retailcrm/api-client-go/v2 v2.0.3/go.mod h1:1yTZl9+gd3+/k0kAJe7sYvC+mL4fqMwIwtnSgSWZlkQ= github.com/retailcrm/api-client-go/v2 v2.0.12 h1:0pMDsz4fzKpizUxoF1qtgwN+oJ+YJruncCj6OTOB3e8= github.com/retailcrm/api-client-go/v2 v2.0.12/go.mod h1:1yTZl9+gd3+/k0kAJe7sYvC+mL4fqMwIwtnSgSWZlkQ= github.com/retailcrm/mg-transport-api-client-go v1.1.32 h1:IBPltSoD5q2PPZJbNC/prK5F9rEVPXVx/ZzDpi7HKhs= @@ -348,7 +381,6 @@ github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb6 github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= @@ -576,8 +608,6 @@ golang.org/x/tools v0.0.0-20200626171337-aa94e735be7f/go.mod h1:EkVYQZoAsY45+roY golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/api v0.3.1/go.mod h1:6wY9I6uQWHQ8EM57III9mq/AjF+i8G65rmVagqKMtkk= google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE= google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M= From 17b5c18b4ccb1ddf518c21ade16486f7e4b7a155 Mon Sep 17 00:00:00 2001 From: Tyschitskaya Maria Date: Fri, 16 Dec 2022 15:06:29 +0300 Subject: [PATCH 2/2] docs uploader tests --- core/module_featurees_uploader_test.go | 99 ++++++++++++++++++++++++++ core/module_features_uploader.go | 11 +-- 2 files changed, 106 insertions(+), 4 deletions(-) create mode 100644 core/module_featurees_uploader_test.go diff --git a/core/module_featurees_uploader_test.go b/core/module_featurees_uploader_test.go new file mode 100644 index 0000000..e9587cd --- /dev/null +++ b/core/module_featurees_uploader_test.go @@ -0,0 +1,99 @@ +package core + +import ( + "bytes" + "context" + "os" + "testing" + + "github.com/aws/aws-sdk-go-v2/service/s3" + "github.com/op/go-logging" + "github.com/stretchr/testify/suite" + "golang.org/x/text/language" + + "github.com/retailcrm/mg-transport-core/v2/core/config" + "github.com/retailcrm/mg-transport-core/v2/core/logger" +) + +type ModuleFeaturesUploaderTest struct { + suite.Suite + localizer LocalizerInterface +} + +func TestModuleFeaturesUploader(t *testing.T) { + suite.Run(t, new(ModuleFeaturesUploaderTest)) +} + +func (t *ModuleFeaturesUploaderTest) SetupSuite() { + createTestLangFiles(t.T()) + t.localizer = NewLocalizer(language.English, DefaultLocalizerMatcher(), testTranslationsDir) +} + +func (t *ModuleFeaturesUploaderTest) TearDownSuite() { + err := os.RemoveAll(testTranslationsDir) + t.Require().Nil(err) +} + +func (t *ModuleFeaturesUploaderTest) TestModuleFeaturesUploader_NewModuleFeaturesUploader() { + logs := &bytes.Buffer{} + log := logger.NewBase(logs, "code", logging.DEBUG, logger.DefaultLogFormatter()) + conf := config.AWS{Bucket: "bucketName", FolderName: "folder/name"} + + uploader := NewModuleFeaturesUploader(log, conf, t.localizer, "filename.txt") + t.Assert().NotNil(uploader) + t.Assert().NotNil(uploader.client) + t.Assert().Equal(log, uploader.log) + t.Assert().NotNil(uploader.loc) + t.Assert().Equal("bucketName", uploader.bucket) + t.Assert().Equal("folder/name", uploader.folder) +} + +func (t *ModuleFeaturesUploaderTest) TestModuleFeaturesUploader_translate() { + logs := &bytes.Buffer{} + log := logger.NewBase(logs, "code", logging.DEBUG, logger.DefaultLogFormatter()) + conf := config.AWS{Bucket: "bucketName", FolderName: "folder/name"} + uploader := NewModuleFeaturesUploader(log, conf, t.localizer, "filename.txt") + content := "test content " + t.localizer.GetLocalizedMessage("message") + + res, err := uploader.translate([]byte(content), language.Russian) + t.Assert().Nil(err) + t.Assert().Equal([]byte("test content Test message"), res) +} + +func (t *ModuleFeaturesUploaderTest) TestModuleFeaturesUploader_uploadFile() { + logs := &bytes.Buffer{} + log := logger.NewBase(logs, "code", logging.DEBUG, logger.DefaultLogFormatter()) + conf := config.AWS{Bucket: "bucketName", FolderName: "folder/name"} + uploader := NewModuleFeaturesUploader(log, conf, t.localizer, "source.md") + content := "test content" + + uploader.client = mockPutObjectAPI(t.T(), "bucketName", "folder/name/filename.html") + err := uploader.uploadFile([]byte(content), "filename") + t.Assert().Nil(err) +} + +type putObjectAPI func(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) + +func (m putObjectAPI) PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) { + return m(ctx, params, optFns...) +} + +func mockPutObjectAPI(t *testing.T, bucket, key string) S3PutObjectAPI { + return putObjectAPI(func(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) { + t.Helper() + if params.Bucket == nil { + t.Fatal("expect bucket to not be nil") + } + if e, a := bucket, *params.Bucket; e != a { + t.Errorf("expect %v, got %v", e, a) + } + if params.Key == nil { + t.Fatal("expect key to not be nil") + } + if e, a := key, *params.Key; e != a { + t.Errorf("expect %v, got %v", e, a) + } + + return &s3.PutObjectOutput{}, nil + }) +} diff --git a/core/module_features_uploader.go b/core/module_features_uploader.go index e305401..f37a2f0 100644 --- a/core/module_features_uploader.go +++ b/core/module_features_uploader.go @@ -5,7 +5,6 @@ import ( "context" "fmt" "html/template" - "io/fs" "os" "github.com/aws/aws-sdk-go-v2/aws" @@ -18,8 +17,12 @@ import ( "github.com/retailcrm/mg-transport-core/v2/core/logger" ) +type S3PutObjectAPI interface { + PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) +} + type ModuleFeaturesUploader struct { - client *s3.Client + client S3PutObjectAPI log logger.Logger loc LocalizerInterface bucket string @@ -32,7 +35,7 @@ var languages = []language.Tag{language.Russian, language.English, language.Span func NewModuleFeaturesUploader( log logger.Logger, conf config.AWS, - translateFs fs.FS, + loc LocalizerInterface, featuresFilename string, ) *ModuleFeaturesUploader { customResolver := aws.EndpointResolverWithOptionsFunc( @@ -63,7 +66,7 @@ func NewModuleFeaturesUploader( return &ModuleFeaturesUploader{ client: s3.NewFromConfig(cfg), log: log, - loc: NewLocalizerFS(DefaultLanguage, DefaultLocalizerMatcher(), translateFs), + loc: loc, bucket: conf.Bucket, folder: conf.FolderName, featuresFilename: featuresFilename,