[github actions] address test flakiness (#360)

allibell · web-flow · commit 48d0f98a8eab · 2022-02-14T08:27:37.000-08:00
* [github actions] upgrade action-download-artifact

* [github actions] download Go C_header file

* [golang] add comment strings to appease aggressive linter

* fix LD path getting/setting

* don't build docs by default

* re-introduce build docs by default

* cleanup: rm whitespace change
diff --git a/.github/workflows/build-dotnet.yml b/.github/workflows/build-dotnet.yml
@@ -20,7 +20,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v1
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/.github/workflows/build-golang.yml b/.github/workflows/build-golang.yml
@@ -14,39 +14,71 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os-artifact: [ [ubuntu-latest, linux], [windows-latest, windows], [macos-latest, macos] ]
+        os-artifact: [ [ubuntu-latest, linux], [windows-latest, windows-gnu], [macos-latest, macos] ]
     steps:
       - uses: actions/checkout@v2
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs/${{ matrix.os-artifact[1] }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           name: ${{ matrix.os-artifact[1] }}
-      - name: Set up Go
+      - name: Download C header artifact
+        uses: dawidd6/action-download-artifact@v2.17.0
+        with:
+          workflow: "build-libs.yml"
+          path: ./libs/${{ matrix.os-artifact[1] }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          name: C_header
+      - name: Set up Go (default)
         uses: actions/setup-go@v2
         with:
           go-version: ^1.16
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
+      - uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+      - name: Set up Dotnet (docs)
+        run: |
+          dotnet tool install DefaultDocumentation.Console -g
+        shell: pwsh
+      # Set up Okapi-specific Go runtime. Includes setting GOLANG_LD_PATH env var.
+      - name: Set up Go (Okapi)
+        run: |
+          go version
+          go install golang.org/x/lint/golint@latest
+          go install github.com/jstemmer/go-junit-report@latest
+          go get github.com/posener/goreadme/cmd/goreadme
+          python ../../devops/build_sdks.py --language=golang
+        shell: pwsh
+        working-directory: go/okapi
+        env:
+          GO111MODULE: on
       - name: Build and Test Golang
+        run: |
+          go build      - name: Set up Go (Okapi)
         run: |
           go version
           go install golang.org/x/lint/golint@latest
           go install github.com/jstemmer/go-junit-report@latest
           python ../../devops/build_sdks.py
+        shell: pwsh
+        working-directory: go/okapi
+      - name: Build and Test Golang
+        run: |
           go build
           golint
-          go test -v | go-junit-report > test_output.xml
+          go test -v -exec "env DYLD_LIBRARY_PATH=${{ env.GOLANG_LD_PATH }}" | go-junit-report > test_output.xml
         shell: pwsh
         working-directory: go/okapi
         env:
-          LD_LIBRARY_PATH: "${{ github.workspace }}/go/okapi"
-          DYLD_FALLBACK_LIBRARY_PATH: "${{ github.workspace }}/go/okapi"
-          DYLD_LIBRARY_PATH: "${{ github.workspace }}/go/okapi"
+          LD_LIBRARY_PATH: ${{ env.GOLANG_LD_PATH }}
+          DYLD_FALLBACK_LIBRARY_PATH: ${{ env.GOLANG_LD_PATH }}
+          DYLD_LIBRARY_PATH: ${{ env.GOLANG_LD_PATH }}
           API_GITHUB_TOKEN: ${{ secrets.API_GITHUB_TOKEN }}
       - name: Upload Unit Test Results - Golang
         if: always()
diff --git a/.github/workflows/build-java.yml b/.github/workflows/build-java.yml
@@ -28,16 +28,30 @@ jobs:
         with:
           python-version: 3.9
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs/${{ matrix.os-artifact[1] }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           name: ${{ matrix.os-artifact[1] }}
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Set up Node (docs)
+        run: |
+          npm install groovydoc-to-markdown
+        shell: pwsh
+      - uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+      - name: Set up Dotnet (docs)
+        run: |
+          dotnet tool install DefaultDocumentation.Console -g
+        shell: pwsh
       - name: Build with Gradle
         run: |
-          python ../devops/build_sdks.py
-          gradle build
+          python ../devops/build_sdks.py --language=java
+          gradle build   
         shell: pwsh
         working-directory: java
         env:
diff --git a/.github/workflows/build-python.yml b/.github/workflows/build-python.yml
@@ -34,18 +34,24 @@ jobs:
           cache: 'pip'
             
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs/${{ matrix.os-artifact[1] }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           name: ${{ matrix.os-artifact[1] }}
-
+      - uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+      - name: Set up Dotnet (docs)
+        run: |
+          dotnet tool install DefaultDocumentation.Console -g
+        shell: pwsh
       - name: Build, Test, Pack
         run: |
           python -m pip install --upgrade --upgrade-strategy eager -r requirements.txt
           python -m pip install pytest pytest-cov
-          python ../devops/build_sdks.py
+          python ../devops/build_sdks.py --language=python
           python -m pytest --cache-clear ./tests --junitxml=test_output.xml --cov=.
         shell: pwsh
         working-directory: python
diff --git a/.github/workflows/build-ruby.yml b/.github/workflows/build-ruby.yml
@@ -32,18 +32,25 @@ jobs:
           cache: 'pip'
 
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs/${{ matrix.os-artifact[1] }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           name: ${{ matrix.os-artifact[1] }}
+      - uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.x'
+      - name: Set up Dotnet (docs)
+        run: |
+          dotnet tool install DefaultDocumentation.Console -g
+        shell: pwsh
       - name: Build and run tests
         run: |
           gem install bundler
           gem install rspec
           bundle install
-          python ../devops/build_sdks.py
+          python ../devops/build_sdks.py --language=ruby
           bundle exec rake
           rake test
           exit 0
diff --git a/.github/workflows/release-dotnet.yml b/.github/workflows/release-dotnet.yml
@@ -23,7 +23,7 @@ jobs:
         with:
           submodules: "true"
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/.github/workflows/release-java.yml b/.github/workflows/release-java.yml
@@ -31,7 +31,7 @@ jobs:
           java-version: '15'
           distribution: 'adopt'
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/.github/workflows/release-libs.yml b/.github/workflows/release-libs.yml
@@ -10,7 +10,7 @@ jobs:
     name: Upload libs.zip artifact
     runs-on: ubuntu-latest
     steps:
-      - uses: dawidd6/action-download-artifact@v2.14.0
+      - uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/.github/workflows/release-ruby.yml b/.github/workflows/release-ruby.yml
@@ -30,7 +30,7 @@ jobs:
         with:
           ruby-version: 2.7
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/.github/workflows/release-swift.yml b/.github/workflows/release-swift.yml
@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v1
 
       - name: Download workflow artifact
-        uses: dawidd6/action-download-artifact@v2.14.0
+        uses: dawidd6/action-download-artifact@v2.17.0
         with:
           workflow: "build-libs.yml"
           path: ./libs
diff --git a/devops/build_sdks.py b/devops/build_sdks.py
@@ -41,6 +41,13 @@ def get_os_arch_path(extract_dir, windows_path):
     return copy_from
 
 
+
+def set_env_var(name, value):
+    env_file = os.getenv('GITHUB_ENV')
+    with open(env_file, "a") as file:
+        file.write(f"{name}={value}")
+
+
 def copy_okapi_libs(copy_to: str, windows_path='windows'):
     okapi_dir = abspath(join(dirname(__file__), '..'))
     copy_from = get_os_arch_path(okapi_dir, windows_path)
@@ -121,8 +128,10 @@ def build_ruby(args) -> None:
 
 
 def build_golang(args) -> None:
-    # Update version in setup.cfg
+    # Copy in Okapi libraries to the $GOLANG_LD_PATH directory
     golang_dir = abspath(join(get_language_dir('go'), 'okapi'))
+    set_env_var("GOLANG_LD_PATH", golang_dir)
+
     # Copy in the binaries
     copy_okapi_libs(golang_dir, 'windows-gnu')
 
@@ -144,7 +153,12 @@ def get_github_version(github_token: str = None) -> str:
 def build_java_docs(args):
     # https://github.com/fchastanet/groovydoc-to-markdown
     # npm install in the root of sdk
-    subprocess.Popen(r'node ./node_modules/groovydoc-to-markdown/src/doc2md.js  ./java java ./docs/reference/java', cwd=get_sdk_dir() ).wait()
+    subprocess.Popen(
+        [
+            'node', './node_modules/groovydoc-to-markdown/src/doc2md.js',
+            './java', 'java', './docs/reference/java'
+        ], cwd=get_sdk_dir() 
+    ).wait()
 
 
 def build_dotnet_docs(args) -> None:
@@ -153,20 +167,32 @@ def build_dotnet_docs(args) -> None:
     assembly_file = './dotnet/Library/Okapi/bin/Debug/net6.0/okapi.dll'
     output_doc_folder = './docs/reference/dotnet'
     clean_dir(abspath(join(get_sdk_dir(), output_doc_folder)))
-    subprocess.Popen(f"defaultdocumentation --AssemblyFilePath {assembly_file} --OutputDirectoryPath {output_doc_folder} --FileNameMode Name --GeneratedPages Namespaces",
-                     cwd=get_sdk_dir()).wait()
+    subprocess.Popen(
+        [
+            "defaultdocumentation",
+            "--AssemblyFilePath", assembly_file,
+            "--OutputDirectoryPath", output_doc_folder,
+            "--FileNameMode", "Name",
+            "--GeneratedPages", "Namespaces",
+        ],
+        cwd=get_sdk_dir()
+    ).wait()
 
 
 def build_go_docs(args):
     # https://github.com/posener/goreadme
     # go get github.com/posener/goreadme/cmd/goreadme
-    goreadme_args = r'-recursive -functions -methods -types -variabless'  # Yes, that's a duplicated s, it's on purpose.
+    goreadme_args = ['-recursive', '-functions', '-methods', '-types', '-variabless']  # Yes, that's a duplicated s, it's on purpose.
     doc_path = abspath(join(get_language_dir('docs'), 'reference', 'go'))
 
     def write_doc_file(input_path: str, output_file: str):
         logging.info(f"goreadme(input={input_path}, output={output_file})")
+        print(f"goreadme(input={input_path}, output={output_file})")
         with open(join(doc_path, f'{output_file}.md'), 'w') as output:
-            subprocess.Popen(rf'goreadme {goreadme_args}', cwd=input_path, stdout=output).wait()
+            subprocess.Popen(
+                ['goreadme', *goreadme_args], 
+                cwd=input_path, stdout=output
+            ).wait()
         # Handle the subdirectories
         for sub_folder in glob.glob(join(input_path, '**')):
             if isdir(sub_folder):
@@ -193,14 +219,14 @@ def main():
         build_python(args)
     if build_all or 'java' in langs_to_build:
         build_java(args)
+        build_java_docs(args)
     if build_all or 'ruby' in langs_to_build:
         build_ruby(args)
     if build_all or 'golang' in langs_to_build:
         build_golang(args)
+        build_go_docs(args)
     if build_all or 'docs' in langs_to_build:
-        build_java_docs(args)
         build_dotnet_docs(args)
-        build_go_docs(args)
 
 
 if __name__ == "__main__":
diff --git a/go/okapi/DidComm.go b/go/okapi/DidComm.go
@@ -4,13 +4,15 @@ import (
 	"github.com/trinsic-id/okapi/go/okapiproto"
 )
 
+// DidCommer implements the DIDComm Messaging protocol
 type DidCommer interface {
 	Pack(request *okapiproto.PackRequest) (*okapiproto.PackResponse, error)
 	Unpack(request *okapiproto.UnpackRequest) (*okapiproto.UnpackResponse, error)
 	Sign(request *okapiproto.SignRequest) (*okapiproto.SignResponse, error)
 	Verify(request *okapiproto.VerifyRequest) (*okapiproto.VerifyResponse, error)
 }
 
+// DidComm implements the DIDComm Messaging protocol
 func DidComm() DidCommer {
 	return &didComm{}
 }
diff --git a/go/okapi/Hashing.go b/go/okapi/Hashing.go
@@ -4,13 +4,15 @@ import (
 	"github.com/trinsic-id/okapi/go/okapiproto"
 )
 
+// Hasher implements Blake3 and Sha2 hash functions
 type Hasher interface {
 	Sha256Hash(request *okapiproto.SHA256HashRequest) (*okapiproto.SHA256HashResponse, error)
 	Blake3Hash(request *okapiproto.Blake3HashRequest) (*okapiproto.Blake3HashResponse, error)
 	Blake3KeyedHash(request *okapiproto.Blake3KeyedHashRequest) (*okapiproto.Blake3KeyedHashResponse, error)
 	Blake3DeriveKey(request *okapiproto.Blake3DeriveKeyRequest) (*okapiproto.Blake3DeriveKeyResponse, error)
 }
 
+// Hashing implements Blake3 and Sha2 hash functions
 func Hashing() Hasher {
 	return &hasher{}
 }
diff --git a/go/okapi/LdProofs.go b/go/okapi/LdProofs.go
@@ -2,11 +2,13 @@ package okapi
 
 import "github.com/trinsic-id/okapi/go/okapiproto"
 
+// LdProofer implements Linked-Data Proofs
 type LdProofer interface {
 	CreateProof(request *okapiproto.CreateProofRequest) (*okapiproto.CreateProofResponse, error)
 	VerifyProof(request *okapiproto.VerifyProofRequest) (*okapiproto.VerifyProofResponse, error)
 }
 
+// LdProofs implements Linked-Data Proofs
 func LdProofs() LdProofer {
 	return &ldProofs{}
 }
diff --git a/go/okapi/Oberon.go b/go/okapi/Oberon.go
@@ -2,6 +2,7 @@ package okapi
 
 import "github.com/trinsic-id/okapi/go/okapiproto"
 
+// Oberoner implements Oberon authentication
 type Oberoner interface {
 	CreateKey(request *okapiproto.CreateOberonKeyRequest) (*okapiproto.CreateOberonKeyResponse, error)
 	CreateToken(request *okapiproto.CreateOberonTokenRequest) (*okapiproto.CreateOberonTokenResponse, error)
@@ -11,6 +12,7 @@ type Oberoner interface {
 	VerifyProof(request *okapiproto.VerifyOberonProofRequest) (*okapiproto.VerifyOberonProofResponse, error)
 }
 
+// Oberon implements Oberon authentication
 func Oberon() Oberoner {
 	return &oberon{}
 }
diff --git a/go/okapi/native.go b/go/okapi/native.go
@@ -13,6 +13,7 @@ import (
 	"unsafe"
 )
 
+// NativeError indicates a native protocol error
 type NativeError struct {
 	Message       string
 	InternalError error
@@ -22,6 +23,7 @@ func (o NativeError) Error() string {
 	return fmt.Sprintf("Error:%s  InternalError:%v", o.Message, o.InternalError)
 }
 
+// DidError indicates a DID protocol error
 type DidError struct {
 	Code         int
 	FunctionName string
