Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

CycloneDX output: metadata.properties[].value emits JSON array instead of string

Abierto Apto para principiantes
  • ¿Algo no está bien?
#5,349 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

@0Cymantek0 ya está trabajando en esto.

Desde el 11/10/2026.

  • #5354 de @0Cymantek0 — abierto
  • #5356 de @0Cymantek0 — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
62/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
tooling

Línea de trabajo

Empieza reproduciendo el problema con el comando --cyclonedx del issue y luego ejecuta el script de comprobación en Python para listar las propiedades cuyo valor no es una cadena. Busca en el código de salida de CycloneDX dónde se construye la propiedad scancode:options a partir de la lista de opciones. Está terminado cuando cada metadata.properties[].value sea una cadena y la comprobación no imprima nada. El payload no determina si hay que unir con espacios, con comas o codificar en JSON, así que confirma esa elección antes de editar.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Describe the bug

When using --cyclonedx output, ScanCode produces metadata.properties[].value as a JSON array instead of a string. The CycloneDX specification (versions 1.4, 1.5, and 1.6) defines properties[].value as type: string.

This causes downstream tools like cyclonedx-cli merge to crash:

Unhandled exception: System.Text.Json.JsonException:
  The JSON value could not be converted to System.String.
  Path: $.metadata.properties[1].value
  ---> System.InvalidOperationException:
    Cannot get the value of a token type 'StartArray' as a string.
Example output (simplified)
{
  "metadata": {
    "properties": [
      {
        "name": "scancode:version",
        "value": "33.0.0"
      },
      {
        "name": "scancode:options",
        "value": ["--package", "--license", "--copyright", "--strip-root"]
      }
    ]
  }
}

The second property has value as an array ["--package", "--license", "--copyright", "--strip-root"] instead of a string like "--package --license --copyright --strip-root".

CycloneDX spec reference

The value field in a property object is defined as type: string in all CycloneDX spec versions:

  • v1.4: value: type: string
  • v1.5: value: type: string
  • v1.6: value: type: string

The spec says: "The value of the property." with type string. If multiple values need to be represented, the spec recommends duplicate property names with different values, not array-typed values.

Related
To reproduce
pip install scancode-toolkit
scancode --package --license --copyright --cyclonedx output.cdx.json /path/to/project

Then check for non-string property values:

import json
with open('output.cdx.json') as f:
    data = json.load(f)
for p in data.get('metadata', {}).get('properties', []):
    if not isinstance(p.get('value'), str):
        print(f'Non-string value: {p["name"]} = {p["value"]} (type: {type(p["value"]).__name__})')
Expected behavior

All properties[].value fields should be strings per the CycloneDX specification. Array values should be serialized as a string (e.g. comma-separated or JSON-encoded string).

Environment
  • scancode-toolkit: latest (installed via pip)
  • Output format: --cyclonedx (JSON)
  • Python: 3.12+
Lenguaje dominante
Python
Estrellas
2.7k
Forks
831
Merge medio
3 d 4 h
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aboutcode-org/scancode-toolkit

Todos los issues de aboutcode-org/scancode-toolkit

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.