Project Workspace Configuration Guide for Project Based Problems

The configuration.json file is a required configuration file that must be present in the root directory of every project workspace. It allows content creators to define project-specific settings, enforce restrictions, and automate essential development workflows. This document provides a comprehensive guide to understanding and utilizing the configuration file effectively.

Purpose

The configuration.json file serves the following purposes:

• Enforce read-only restrictions on specific files.
  

• Define default open files in VSCode when the workspace loads.
  

• Configure evaluation and scoring using a JUnit-based test framework.
  

• Enable custom buttons in VSCode for automated task execution.
  

• Execute startup commands when the workspace initializes.
  

• Provide port-based preview access to hosted services.

TABLE OF CONTENTS

• Purpose
• Configuration Properties
  • 1. General Settings
  • 2. File Restrictions and Defaults
  • 3. Scoring Configuration (scoring object)
  • 4. Button Configuration (buttons object)
  • 5. Startup Commands (post_start object)
  • 6. Preview Port (preview_port property)
• Example Configuration File (configuration.json)
• Guidelines & Best Practices
  • 1. Maintaining JSON Validity
  • 2. File Path Considerations
  • 3. Scoring Requirements
• Scoring Formula Calculation

  • Formula:

  • Example Calculation:

• Conclusion

Configuration Properties

The following table outlines the key properties that must be defined in the configuration.json file:

1. General Settings

2. File Restrictions and Defaults

3. Scoring Configuration (scoring object)

4. Button Configuration (buttons object)

Each key in the buttons object represents a button name under the Run menu in VSCode. The associated value contains the execution details:

5. Startup Commands (post_start object)

6. Preview Port (preview_port property)

Example Configuration File (configuration.json)

The following example demonstrates a fully configured configuration.json file:

{
  "version": "1.0",
  "read_only_files": [
    ".env",
    ".gitignore",
    "src/test/java/com/example/curtainmodel/AppTest.java",
    "src/main/java/com/example/curtainmodel/entity/Curtain.java",
    "src/main/java/com/example/curtainmodel/controller/CurtainController.java",
    "src/main/java/com/example/curtainmodel/service/CurtainService.java",
    "src/main/java/com/example/curtainmodel/service/CurtainServiceImpl.java",
    "src/main/java/com/example/curtainmodel/CurtainModelApplication.java",
    "src/main/resources/application.properties",
    "src/test/resources/application.properties",
    "src/test/resources/data.sql",
    "init.sql",
    "pom.xml",
    "configuration.json",
    "README.md"
  ],
  "default_open_files": [
    "src/main/java/com/example/curtainmodel/repository/CurtainRepository.java"
  ],
  "scoring": {
    "command": "supervisorctl -s unix:///tmp/supervisor.sock restart mysql && sleep 5 && mvn clean install && mvn clean test",
    "files": {
      "target/surefire-reports/TEST-com.example.curtainmodel.AppTest.xml": "SpringBoot API"
    },
    "testcase_weights": {
      "testGetAllCurtainsByPrice": 5,
      "testGetAllCurtainsByBrand": 5
    }
  },
  "buttons": {
    "build": {
      "command": "mvn clean install -DskipTests"
    },
    "start_server": {
      "command": "mvn clean spring-boot:run",
      "dependencies": ["mvn clean install -DskipTests"]
    },
    "test": {
      "command": "mvn clean test",
      "dependencies": ["mvn clean install -DskipTests"]
    },
    "load_stub": {
      "command": "/bin/bash -cx /tmp/setup_workspaces.sh"
    }
  },
  "post_start": {
    "commands": [
      "supervisorctl -s unix:///tmp/supervisor.sock start mysql",
      "sleep 5",
      "mysql -h localhost -u coder -pcoder < init.sql",
      "mysql -h localhost -u coder -pcoder"
    ]
  },
  "preview_port": 8000
}

Guidelines & Best Practices

1. Maintaining JSON Validity

• Ensure the file strictly follows JSON syntax.
  
  

• Use double quotes (") for keys and values.
  
  

• Avoid trailing commas in arrays and objects.
  
  

2. File Path Considerations

• All file paths must be relative to the project workspace root.
  
  

• Wildcards (*, ?) are not supported in read_only_files.
  
  

3. Scoring Requirements

• The JUnit XML file generated by the scoring.command must be available in the workspace.
  
  

• Ensure that the XML file is added to .gitignore to prevent accidental commits.
  
  

Scoring Formula Calculation

The final score is computed based on the weighted test cases.

Formula:

If total_score = 200 and the total of all test case weights is:

total_weights = sum of all testcase_weights

Then, the marks assigned to an individual test case are:

Marks for testcase[i] = (testcase_weight[i] / total_weights) * total_score

Example Calculation:

• Given testcase_weights = { "A": 5, "B": 5, "C": 10 }
  
  

• total_weights = 5 + 5 + 10 = 20
  
  

• If total_score = 200:
  
  

  • Test Case A: (5/20) * 200 = 50

  • Test Case B: (5/20) * 200 = 50

  • Test Case C: (10/20) * 200 = 100
    
    

Conclusion

The configuration.json file is essential for controlling the workspace environment, automating testing and evaluation, and enhancing the candidate experience. Adhering to this guide ensures consistency, security, and efficiency in workspace configurations.