chore: Add nix shell for simple development setup

kylecarbs · kylecarbs · commit facf6ca46772 · 2022-08-07T16:26:01.000-05:00
This enables contributors using Nix to set up their environment with ease.
diff --git a/.envrc b/.envrc
@@ -0,0 +1 @@
+use nix
diff --git a/coderd/util/tz/tz_linux.go b/coderd/util/tz/tz_linux.go
@@ -29,16 +29,16 @@ func TimezoneIANA() (*time.Location, error) {
 		return nil, xerrors.Errorf("lookup timezone from env: %w", err)
 	}
 
-	lp, err := filepath.EvalSymlinks(etcLocaltime)
-	if err != nil {
-		return nil, xerrors.Errorf("read location of %s: %w", etcLocaltime, err)
+	location, err := filepath.EvalSymlinks(etcLocaltime)
+	if err == nil {
+		location = strings.Replace(location, zoneInfoPath, "", -1)
+		location = strings.TrimPrefix(location, string(filepath.Separator))
+	} else {
+		location, _ = time.Now().Zone()
 	}
-
-	stripped := strings.Replace(lp, zoneInfoPath, "", -1)
-	stripped = strings.TrimPrefix(stripped, string(filepath.Separator))
-	loc, err = time.LoadLocation(stripped)
+	loc, err = time.LoadLocation(location)
 	if err != nil {
-		return nil, xerrors.Errorf("invalid location %q guessed from %s: %w", stripped, lp, err)
+		return nil, xerrors.Errorf("invalid location %q guessed from %s: %w", location, location, err)
 	}
 	return loc, nil
 }
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -4,6 +4,9 @@
 
 Coder requires Go 1.18+, Node 14+, and GNU Make.
 
+> **Note**:
+> Use [Nix](https://nix.dev/) for a one-command setup: `nix-shell`
+
 ### Development workflow
 
 Use the following `make` commands and scripts in development:
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -0,0 +1,54 @@
+{
+  description = "Development environments on your infrastructure";
+
+  inputs = {
+    nixpkgs-unstable.url = "nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+    drpc = {
+      url = "github:storj/drpc";
+      inputs.nixpkgs.follows = "nixpkgs-unstable";
+    };
+  };
+
+  outputs = { self, nixpkgs-unstable, flake-utils, drpc }:
+    flake-utils.lib.eachDefaultSystem (system:
+      with nixpkgs-unstable.legacyPackages.${system}; rec {
+        devShell =
+          let devtools = {};
+        in mkShell {
+            buildInputs = [
+              drpc.defaultPackage.${system}
+            ];
+            nativeBuildInputs = [
+              go_1_19
+              gopls
+              nodejs
+              ripgrep
+              exa
+              bat
+              typos
+              git
+              nfpm
+              openssl
+              protoc-gen-go
+              go-migrate
+              gotestsum
+              goreleaser
+              sqlc
+              shfmt
+              terraform
+              shellcheck
+              golangci-lint
+              yarn
+              postgresql
+              helm
+              jq
+              zstd
+              zip
+              openssh
+              nodePackages.typescript
+              nodePackages.typescript-language-server
+            ];
+        };
+      });
+}
diff --git a/provisionersdk/agent_test.go b/provisionersdk/agent_test.go
@@ -46,6 +46,9 @@ func TestAgentScript(t *testing.T) {
 		}
 		script = strings.ReplaceAll(script, "${ACCESS_URL}", srvURL.String()+"/")
 		script = strings.ReplaceAll(script, "${AUTH_TYPE}", "token")
+		// In certain distributions "echo" is a part of coreutils, and determines
+		// it's functionality based on the exec path name.
+		script = strings.ReplaceAll(script, "BINARY_NAME=coder", "BINARY_NAME=echo")
 		// This is intentionally ran in single quotes to mimic how a customer may
 		// embed our script. Our scripts should not include any single quotes.
 		// nolint:gosec
diff --git a/scripts/build_go_slim.sh b/scripts/build_go_slim.sh
@@ -58,7 +58,7 @@ done
 # Check dependencies
 dependencies go
 if [[ $compress != 0 ]]; then
-	dependencies shasum tar zstd
+	dependencies openssl tar zstd zip
 
 	if [[ $compress != [0-9]* ]] || [[ $compress -gt 22 ]] || [[ $compress -lt 1 ]]; then
 		error "Invalid value for compress, must in in the range of [1, 22]"
@@ -114,7 +114,7 @@ if [[ $compress != 0 ]]; then
 	sha_file=coder.sha1
 	sha_dest="$dest_dir/$sha_file"
 	log "--- Generating SHA1 for coder-slim binaries ($sha_dest)"
-	shasum -b -a 1 coder-* | tee $sha_file
+	openssl dgst -r -sha1 coder-* | cut -c1-40 | tee $sha_file
 	echo "$sha_dest"
 	log
 	log
diff --git a/shell.nix b/shell.nix
@@ -0,0 +1,7 @@
+(import (
+  fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/12c64ca55c1014cdc1b16ed5a804aa8576601ff2.tar.gz";
+    sha256 = "0jm6nzb83wa6ai17ly9fzpqc40wg1viib8klq8lby54agpl213w5"; }
+) {
+  src =  ./.;
+}).shellNix

Original file line number	Diff line number	Diff line change
`@@ -29,16 +29,16 @@ func TimezoneIANA() (*time.Location, error) {`
`29`	`29`	`return nil, xerrors.Errorf("lookup timezone from env: %w", err)`
`30`	`30`	`}`
`31`	`31`
`32`		`- lp, err := filepath.EvalSymlinks(etcLocaltime)`
`33`		`- if err != nil {`
`34`		`- return nil, xerrors.Errorf("read location of %s: %w", etcLocaltime, err)`
	`32`	`+ location, err := filepath.EvalSymlinks(etcLocaltime)`
	`33`	`+ if err == nil {`
	`34`	`+ location = strings.Replace(location, zoneInfoPath, "", -1)`
	`35`	`+ location = strings.TrimPrefix(location, string(filepath.Separator))`
	`36`	`+ } else {`
	`37`	`+ location, _ = time.Now().Zone()`
`35`	`38`	`}`
`36`		`-`
`37`		`- stripped := strings.Replace(lp, zoneInfoPath, "", -1)`
`38`		`- stripped = strings.TrimPrefix(stripped, string(filepath.Separator))`
`39`		`- loc, err = time.LoadLocation(stripped)`
	`39`	`+ loc, err = time.LoadLocation(location)`
`40`	`40`	`if err != nil {`
`41`		`- return nil, xerrors.Errorf("invalid location %q guessed from %s: %w", stripped, lp, err)`
	`41`	`+ return nil, xerrors.Errorf("invalid location %q guessed from %s: %w", location, location, err)`
`42`	`42`	`}`
`43`	`43`	`return loc, nil`
`44`	`44`	`}`