Refactor-x, closes #373 #386

krhubert · 2018-08-22T15:29:52Z

antho1404 · 2018-08-23T04:41:47Z

please make sure to fix the tests and issues with code climate.
Otherwise it looks great, I like that now most of utils functions really have a meaning :)

ilgooz · 2018-08-23T10:25:13Z

x/xstrings/strings.go

+package xstrings
+
+// ContainsString returns true if slice s contains e element, false otherwise.
+func ContainsString(a []string, e string) bool {


would be better rename to _ SliceContains()_

ContainsString was chosen based on similarity to strings/bytes pkg:
Contains(s, substr string)
ContainsAny(s, chars string)
ContainsRune(s string, r rune)

I see but in our case String word in the function name in xstrings package is not necessary because we define the package functions for the same context with package name. And for this case, it'd be good to indicate we're working on slices otherwise it looks like we're trying to find a substring in a string with current naming.

ilgooz · 2018-08-23T10:28:30Z

cmd/service/utils.go

@@ -77,40 +75,17 @@ func downloadServiceIfNeeded(path string) (newPath string, didDownload bool, err
 	if !govalidator.IsURL(path) {
 		return path, false, nil
 	}
-	newPath, err = createTempFolder()
+	newPath, err = ioutil.TempDir("", "mesg-")


can we make mesg- a const

ilgooz · 2018-08-23T10:28:48Z

cmd/service/init.go

@@ -140,12 +141,13 @@ func getTemplateResult(result string, templates []*templateStruct) (tmpl *templa
 }

 func downloadTemplate(tmpl *templateStruct) (path string, err error) {
-	path, err = createTempFolder()
+	path, err = ioutil.TempDir("", "mesg-")


can we make mesg- a const

ilgooz · 2018-08-23T10:28:49Z

cmd/service/init.go

@@ -140,12 +141,13 @@ func getTemplateResult(result string, templates []*templateStruct) (tmpl *templa
 }

 func downloadTemplate(tmpl *templateStruct) (path string, err error) {
-	path, err = createTempFolder()
+	path, err = ioutil.TempDir("", "mesg-")


can we make mesg- a const

ilgooz · 2018-08-23T10:31:46Z

cmd/service/utils.go

 	if err != nil {
 		return "", false, err
 	}
-	if err := gitClone(path, newPath, "Downloading service..."); err != nil {
+	fmt.Println("Downloading service...")


forgot to use utils.ShowSpinnerForFunc()? it was defined in previous version of gitClone()

ilgooz · 2018-08-23T10:32:34Z

cmd/service/init.go

 	if err != nil {
 		return "", err
 	}

-	return path, gitClone(tmpl.URL, path, "Downloading template "+tmpl.Name+"...")
+	fmt.Printf("Downloading template %s ...\n", tmpl.Name)


forgot to use utils.ShowSpinnerForFunc()? it was defined in previous version of gitClone()

ilgooz · 2018-08-23T10:34:27Z

cmd/service/utils_test.go

@@ -20,33 +19,6 @@ func TestBuildDockerImagePathDoNotExist(t *testing.T) {
 	require.NotNil(t, err)
 }

-func TestGitCloneRepositoryDoNotExist(t *testing.T) {


we should keep these tests

changed my mind, no need this here but got to put equivalent to xgit. and mock underlying git package if possible. we need these tests to see if we call git.PlainClone() with the right args.

ilgooz · 2018-08-23T10:34:31Z

cmd/service/utils_test.go

-	require.NotNil(t, err)
-}
-
-func TestGitCloneWithoutURLSchema(t *testing.T) {


we should keep these tests

changed my mind, no need this here but got to put equivalent to xgit. and mock underlying git package if possible. we need these tests to see if we call git.PlainClone() with the right args.

ilgooz · 2018-08-23T10:34:39Z

cmd/service/utils_test.go

-	require.Nil(t, err)
-}
-
-func TestGitCloneCustomBranch(t *testing.T) {


we should keep these tests

changed my mind, no need this here but got to put equivalent to xgit. and mock underlying git package if possible. we need these tests to see if we call git.PlainClone() with the right args.

ilgooz · 2018-08-23T16:42:54Z

x/xstructhash/structhash.go

+//
+// This function uses md5 hashing function and default formatter. See also Dump()
+// function.
+func Hash(c interface{}, version int) string {


can test this with structhash.Version(hash) by comparing versions

doesn't make sense to me, leaving this to @antho1404's watch

ilgooz · 2018-08-23T16:49:04Z

x/xsignal/signal.go

+)
+
+// WaitForInterrupt creates a read channel for catch SIGINT and SIGTERM signals.
+func WaitForInterrupt() <-chan os.Signal {


can test this with:

https://godoc.org/os#FindProcess

os.Getpid()

process.Signal(os.Interrupt) and process.Signal(syscall.SIGTERM)

leaving this to @antho1404's judgment

ilgooz · 2018-08-23T16:56:15Z

x/xos/os.go

+	if err != nil {
+		return err
+	}
+	f.Close()


we can return error with an err

ilgooz · 2018-08-23T17:00:27Z

x/xos/os_test.go

+		t.Fatalf("Touched file dosen't exist")
+	}
+
+	if err := Touch(name); err != nil {


why we Touch twice?

// Touch creates a new file, truncating it if it already exists. => to make sure touch doesn't' return an error

ilgooz · 2018-08-23T17:02:20Z

x/xos/os_test.go

+	name := filepath.Join(os.TempDir(), "__test-file")
+	defer Remove(name)
+	if err := Touch(name); err != nil {
+		t.Fatalf("Touch failed: %s", err)


we can use require package for testing x package

I intentionally didn't use require package here to keep it as simple as possible and reduce dependencies.

doesn't make sense to me, leaving this to @antho1404's watch

I kind of prefer to use the require package in order to have a coherence in the codebase. And for now these packages are still in the project so it doesn't really matter to have this extra dependency but I understand that maybe one day it can be useful.

In other terms I don't mind one or the other are fine, it's not a big deal for me even if I would prefer to use require package from now to have consistency

ilgooz · 2018-08-23T17:06:04Z

x/xos/file.go

+	return err
+}
+
+// RemoveAll removes all given paht and any children it contains.


paht to path

ilgooz · 2018-08-23T17:06:31Z

x/xos/file.go

+}
+
+// RemoveAll removes all given paht and any children it contains.
+func RemoveAll(paths ...string) error {


can be renamed as RemoveRecursive, if you wish

RemoveAll is fine for me

Leaving RemoveAll

antho1404

Except the few other remarks already in the PR it's good for me

.

NicolasMahe

Can you merge the dev branch please

antho1404 · 2018-08-24T08:54:50Z

cmd/service/init.go

 	if err != nil {
 		return "", err
 	}

-	return path, gitClone(tmpl.URL, path, "Downloading template "+tmpl.Name+"...")
+	message := fmt.Sprintf("Downloading template %s ...\n", tmpl.Name)


This is not valid, the \n create some problems with the spinner. We should never use a \n when it's a message for the spinner

⣾ Downloading template Javascript ... ⣽ Downloading template Javascript ... ⣻ Downloading template Javascript ... ⢿ Downloading template Javascript ... ⡿ Downloading template Javascript ...

ilgooz · 2018-08-24T09:47:57Z

x/xdocker/xarchive/archive.go

@@ -0,0 +1,14 @@
+package xrequire


antho1404 · 2018-08-25T10:08:50Z

cmd/service/utils.go

-	if err != nil {
-		return err
+// prepareService downloads if needed, create the service, build it and inject configuration
+func prepareService(path string) *service.Service {


thanks to codeclimate, I think this function is not needed here, same for downloadServiceIfNeeded or injectConfigurationInDependencies because they moved to the mesg/deploy @ilgooz can you confirm ?

yes that is correct. @krhubert can you please check the current version of cmd/service/utils.go in dev branch and compare with yours to see diffs. Thanks a lot.

NicolasMahe

Some changes to do, maybe related to a merge

NicolasMahe · 2018-08-27T04:31:59Z

x/xdocker/xarchive/archive.go

+)
+
+// GzippedTar creates an archive from the directory at path compressed with gzip.
+func GzippedTar(path string) (io.Reader, error) {


This function is not used anywhere. Maybe a problem with the merge?

The codebase is still using TarWithOptions

i requested this one, will be used by tests

Why not using it in the codebase instead of TarWithOptions?

yes we should

As @ilgooz pointed out, the function will be used

So, please update the codebase to use this GzippedTar function or at least create some issue to not forget. Otherwise, I worry that we will end up with a lot of function in x packages that no other function.

Here are some place that use TarWithOptions:

https://github.com/mesg-foundation/core/blob/8711a71037209288d39287805c7653f7bb043da9/container/build.go#L26-L29

https://github.com/mesg-foundation/core/blob/8711a71037209288d39287805c7653f7bb043da9/mesg/deploy_test.go#L30

https://github.com/mesg-foundation/core/blob/8711a71037209288d39287805c7653f7bb043da9/mesg/deploy_test.go#L77

Same with git clone, it's another branch

NicolasMahe · 2018-08-27T04:35:18Z

x/xgit/repository.go

+)
+
+// Clone clones a repository from url into the path.
+func Clone(URL string, path string) error {


This following line is still using git.PlainClone:
https://github.com/mesg-foundation/core/blob/8711a71037209288d39287805c7653f7bb043da9/mesg/deploy_deployer.go#L94

Yes, and? What's about the PlainClone?

Why not make the deploy_deployer file use the function from x packages?

The following function has been moved to xgit:

https://github.com/mesg-foundation/core/blob/8711a71037209288d39287805c7653f7bb043da9/mesg/deploy_deployer.go#L80-L96

So let's remove it, and update the code to use the one from xgit

Yes, but deploy_deplyer.go is inside another branch. So we need to merge this into the dev and then merge dev into that branch and update code.

NicolasMahe · 2018-08-27T04:39:30Z

x/xos/env.go

+
+// GetenvDefault retrieves the value of the environment variable named by the key.
+// It returns the value, which will be set to fallback if the variable is empty.
+func GetenvDefault(key, fallback string) string {


This function is never used.

And I would recommend to use Viper for the default value management

I left it if someone need this function (eg for testing)

krhubert requested review from NicolasMahe, ilgooz and antho1404 August 22, 2018 15:29

krhubert force-pushed the refactor-x branch 3 times, most recently from 818d076 to 665ff50 Compare August 22, 2018 20:11

krhubert force-pushed the refactor-x branch 3 times, most recently from 6e3e2b9 to 3a755b6 Compare August 23, 2018 10:18

ilgooz suggested changes Aug 23, 2018

View reviewed changes

krhubert force-pushed the refactor-x branch 2 times, most recently from 94e6643 to 0ec576d Compare August 23, 2018 14:41

ilgooz previously requested changes Aug 23, 2018

View reviewed changes

antho1404 previously approved these changes Aug 24, 2018

View reviewed changes

krhubert added 3 commits August 24, 2018 10:03

Create x dir with pkgs

725db2f

Replace old funcs with corresponding one from x pkgs

433fbd1

Increase codeclimate return limit threshold

3d8e666

krhubert dismissed antho1404’s stale review via 3d8e666 August 24, 2018 08:03

krhubert force-pushed the refactor-x branch from 0ec576d to 3d8e666 Compare August 24, 2018 08:03

NicolasMahe requested changes Aug 24, 2018

View reviewed changes

antho1404 requested changes Aug 24, 2018

View reviewed changes

krhubert added 5 commits August 24, 2018 11:02

Fix

18c99ce

Merge branch 'dev' into refactor-x

3637046

Add xarchive pkg

8ad6e0f

Typo

c375f68

Fix

05dbb78

ilgooz reviewed Aug 24, 2018

View reviewed changes

x/xdocker/xarchive/archive.go Outdated

@@ -0,0 +1,14 @@

package xrequire

Copy link

Contributor

ilgooz Aug 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xarchive

Fix

f784c31

antho1404 requested changes Aug 25, 2018

View reviewed changes

krhubert added 3 commits August 26, 2018 10:49

fix

5c5953d

Fix

7101360

Fix

8711a71

antho1404 previously approved these changes Aug 26, 2018

View reviewed changes

NicolasMahe requested changes Aug 27, 2018

View reviewed changes

NicolasMahe added this to In progress in v1.2 via automation Aug 27, 2018

NicolasMahe moved this from In progress to Changes requested in v1.2 Aug 27, 2018

FIX

bf9e226

krhubert dismissed antho1404’s stale review via bf9e226 August 27, 2018 07:39

v1.2 automation moved this from Changes requested to Needs review Aug 27, 2018

antho1404 approved these changes Aug 27, 2018

View reviewed changes

NicolasMahe approved these changes Aug 27, 2018

View reviewed changes

Merge branch 'dev' into refactor-x

83c4bc2

antho1404 merged commit d017e19 into dev Aug 27, 2018

v1.2 automation moved this from Needs review to Done Aug 27, 2018

antho1404 deleted the refactor-x branch August 27, 2018 11:29

Refactor-x, closes #373 #386

Refactor-x, closes #373 #386

Conversation

krhubert commented Aug 22, 2018

antho1404 commented Aug 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilgooz Aug 23, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilgooz Aug 23, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilgooz Aug 23, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antho1404 left a comment

Choose a reason for hiding this comment

NicolasMahe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NicolasMahe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilgooz Aug 23, 2018 •

edited

ilgooz Aug 23, 2018 •

edited

ilgooz Aug 23, 2018 •

edited