open-nomad/.semgrep/protect_globals.yml

# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

rules:
  - id: "no-overriding-struct-globals"
    patterns:
      - pattern: |
          structs.$A = ...
    message: "Mutating global structs is never safe"
    languages:
      - "go"
    severity: "ERROR"
    fix: " "
    paths:
      # including tests!
      include: ["*"]
[COMPLIANCE] Add Copyright and License Headers 2023-04-10 15:36:59 +00:00			`# Copyright (c) HashiCorp, Inc.`
			`# SPDX-License-Identifier: MPL-2.0`

tests: don't mutate global structs in core scheduler tests (#16120) Some of the core scheduler tests need the maximum batch size for writes to be smaller than the usual `structs.MaxUUIDsPerWriteRequest`. But they do so by unsafely modifying the global struct, which creates test flakes in other tests. Modify the functions under test to take a batch size parameter. Production code will pass the global while the tests can inject smaller values. Turn the `structs.MaxUUIDsPerWriteRequest` into a constant, and add a semgrep rule for avoiding this kind of thing in the future. 2023-02-10 14:26:00 +00:00			`rules:`
			`- id: "no-overriding-struct-globals"`
			`patterns:`
			`- pattern: \|`
			`structs.$A = ...`
			`message: "Mutating global structs is never safe"`
			`languages:`
			`- "go"`
			`severity: "ERROR"`
			`fix: " "`
			`paths:`
			`# including tests!`
			`include: ["*"]`